Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rename node placement to node arrangement and update references #951

Merged
merged 1 commit into from
Aug 14, 2023
Merged

rename node placement to node arrangement and update references #951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...e/elk/alg/topdownpacking/INodePlacer.java → ...elk/alg/topdownpacking/INodeArranger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 Kiel University and others.
* Copyright (c) 2022 - 2023 Kiel University and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand All @@ -13,9 +13,9 @@
import org.eclipse.elk.graph.ElkNode;

/**
* A node placer has to provide a size prediction without computing a layout.
* A node arranger has to provide a size prediction without computing a layout.
*/
public interface INodePlacer {
public interface INodeArranger {

/**
* Computes the predicted required size of the graph and returns it without computing a full layout.
Expand Down
4 changes: 2 additions & 2 deletions ...alg.topdownpacking/src/org/eclipse/elk/alg/topdownpacking/LeftRightTopDownNodePlacer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 Kiel University and others.
* Copyright (c) 2022 - 2023 Kiel University and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand All @@ -25,7 +25,7 @@
* Places nodes in a grid using the sizes provided by their parent node.
*
*/
public class LeftRightTopDownNodePlacer implements ILayoutPhase<TopdownPackingPhases, GridElkNode>, INodePlacer {
public class LeftRightTopDownNodePlacer implements ILayoutPhase<TopdownPackingPhases, GridElkNode>, INodeArranger {

/**
* {@inheritDoc}
Expand Down
6 changes: 3 additions & 3 deletions ...topdownpacking/NodePlacementStrategy.java → ...pdownpacking/NodeArrangementStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 Kiel University and others.
* Copyright (c) 2022 - 2023 Kiel University and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand All @@ -13,10 +13,10 @@
import org.eclipse.elk.core.alg.ILayoutPhaseFactory;

/**
* Node placement strategy to use during topdown packing algorithm.
* Node arrangement strategy to use during topdown packing algorithm.
*
*/
public enum NodePlacementStrategy implements ILayoutPhaseFactory<TopdownPackingPhases, GridElkNode> {
public enum NodeArrangementStrategy implements ILayoutPhaseFactory<TopdownPackingPhases, GridElkNode> {
/**
* Places nodes from left to right, top to bottom in a grid.
*/
Expand Down
6 changes: 3 additions & 3 deletions ...e.elk.alg.topdownpacking/src/org/eclipse/elk/alg/topdownpacking/TopdownPackingPhases.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 Kiel University and others.
* Copyright (c) 2022 - 2023 Kiel University and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand All @@ -16,9 +16,9 @@
public enum TopdownPackingPhases {

/**
* Place equally sized nodes where the size is defined by the parent.
* Arrange equally sized nodes where the size is defined by the parent.
*/
P1_NODE_PLACEMENT,
P1_NODE_ARRANGEMENT,

/**
* Eliminate white space by increasing the size of some nodes to fully fill the space provided by the parent.
Expand Down
16 changes: 8 additions & 8 deletions ...eclipse.elk.alg.topdownpacking/src/org/eclipse/elk/alg/topdownpacking/Topdownpacking.melk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
*******************************************************************************/
package org.eclipse.elk.alg.topdownpacking

import org.eclipse.elk.alg.topdownpacking.NodeArrangementStrategy
import org.eclipse.elk.alg.topdownpacking.TopdownpackingLayoutProvider
import org.eclipse.elk.core.options.TopdownNodeTypes
import org.eclipse.elk.alg.topdownpacking.NodePlacementStrategy
import org.eclipse.elk.alg.topdownpacking.WhitespaceEliminationStrategy
import org.eclipse.elk.core.options.TopdownNodeTypes

bundle {
metadataClass options.TopdownpackingMetaDataProvider
Expand All @@ -34,16 +34,16 @@ algorithm topdownpacking(TopdownpackingLayoutProvider) {
supports org.eclipse.elk.topdownLayout
supports org.eclipse.elk.topdown.nodeType = TopdownNodeTypes.PARALLEL_NODE

supports nodePlacement.strategy
supports nodeArrangement.strategy
supports whitespaceElimination.strategy
}

group nodePlacement {
group nodeArrangement {

option strategy: NodePlacementStrategy {
label "Node placement strategy"
description "Strategy for node placement. The strategy determines the size of the resulting graph."
default = NodePlacementStrategy.LEFT_RIGHT_TOP_DOWN_NODE_PLACER
option strategy: NodeArrangementStrategy {
label "Node arrangement strategy"
description "Strategy for node arrangement. The strategy determines the size of the resulting graph."
default = NodeArrangementStrategy.LEFT_RIGHT_TOP_DOWN_NODE_PLACER
targets parents
}
}
Expand Down
8 changes: 4 additions & 4 deletions ...g.topdownpacking/src/org/eclipse/elk/alg/topdownpacking/TopdownpackingLayoutProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 Kiel University and others.
* Copyright (c) 2022 - 2023 Kiel University and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand Down Expand Up @@ -54,8 +54,8 @@ public void layout(ElkNode layoutGraph, IElkProgressMonitor progressMonitor) {
public List<ILayoutProcessor<GridElkNode>> assembleAlgorithm(GridElkNode graph) {
algorithmAssembler.reset();

algorithmAssembler.setPhase(TopdownPackingPhases.P1_NODE_PLACEMENT,
graph.getProperty(TopdownpackingOptions.NODE_PLACEMENT_STRATEGY));
algorithmAssembler.setPhase(TopdownPackingPhases.P1_NODE_ARRANGEMENT,
graph.getProperty(TopdownpackingOptions.NODE_ARRANGEMENT_STRATEGY));
algorithmAssembler.setPhase(TopdownPackingPhases.P2_WHITESPACE_ELIMINATION,
graph.getProperty(TopdownpackingOptions.WHITESPACE_ELIMINATION_STRATEGY));

Expand All @@ -68,7 +68,7 @@ public List<ILayoutProcessor<GridElkNode>> assembleAlgorithm(GridElkNode graph)
@Override
public KVector getPredictedGraphSize(ElkNode graph) {
// FIXME: enforce that all node placement strategies implement INodePlacer
INodePlacer nodePlacer = (INodePlacer) graph.getProperty(TopdownpackingOptions.NODE_PLACEMENT_STRATEGY).create();
INodeArranger nodePlacer = (INodeArranger) graph.getProperty(TopdownpackingOptions.NODE_ARRANGEMENT_STRATEGY).create();
return nodePlacer.getPredictedSize(graph);
}
}
2 changes: 1 addition & 1 deletion ....topdownpacking/src/org/eclipse/elk/alg/topdownpacking/WhitespaceEliminationStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 Kiel University and others.
* Copyright (c) 2022 - 2023 Kiel University and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand Down
Loading