Tree Layout with vertical position constraints #960

Eddykasp · 2023-10-11T12:32:52Z

resolves #861
Implementation of a tree layout that can handle vertical position constraints for nodes. Created in the scope of the bachelor thesis of cln.

Todos:

considerNodeModelOrder option is broken is some situations
node sizes are not correctly determined in some cases (e.g. when using node micro layout)
add tests

Sample ELK graph:

node wrapper {
  algorithm: org.eclipse.elk.vertiflex
  spacing.nodeNode: 5
  layerDistance: 40
  elk.padding: "[top=0.0,left=0.0,bottom=10.0,right=0.0]"
  layoutStrategy: BEND

  node n1 {
    verticalConstraint: 115
    label "n1"
  }
  node n2 {
    verticalConstraint: 400
    label "n2"
  }
  node n3 {
    verticalConstraint: 160
    label "n3"
  }

  edge n1 -> n2
  edge n1 -> n3

  node n4 {
    verticalConstraint: 300
    label "n4"
  }
  node n5 {
    verticalConstraint: 280
    label "n5"
  }
  node n6 {
    label "n6"
  }
  node n7 {
    label "n7"
  }
  node n8 {
    label "n8"
  }

  edge n3 -> n4
  edge n3 -> n5
  edge n3 -> n6
  edge n3 -> n7
  edge n3 -> n8
}

Straight edges vs preserved model order

add missing documentation implement quick fixes mark remaining issues with TODO

spacing.nodeNode is now considered when constructing outline nodes in addition to any existing node margins.

For invalid graphs throw UnsupportedConfigurationException instead of IllegalArgumentException

replace string with more appropriate enum edge layout strategy

remove image include

make layer distance property add descriptions to properties

refactors all qualified names and references to the new name

Correctly compute graph size and consider padding instead of magicnumber

Number phase packages to correspond to the phases declared in the phases enum.

...ins/org.eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/EdgeRoutingStrategy.java

plugins/org.eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/InternalProperties.java

...org.eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/VertiFlexLayoutProvider.java

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/RelativeXPlacer.java

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p3absolute/AbsoluteXPlacer.java

...clipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p4edgerouting/BendEdgeRouter.java

...se.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p4edgerouting/StraightEdgeRouter.java

- Correct the constraint validity computation - Correct the y placement calculation for nodes without constraint - Add more documentation

change rol and lol to right and left outline in vars and comments

allows using the node model as a tie breaker during the x placement of nodes to avoid certain ono cases The avoided situations are: - mirrored layouts that are obviously better - nodes that have the same height do not maintain the model order

plugins/org.eclipse.elk.alg.vertiflex/build.properties

plugins/org.eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/VertiFlex.melk

plugins/org.eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/VertiFlexUtil.java

...rg.eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p1yplacement/NodeYPlacer.java

...e.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/InverseYNodeComparator.java

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/RelativeXPlacer.java

soerendomroes · 2023-11-02T10:43:38Z

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/RelativeXPlacer.java

+
+    }
+
+    /** Split nodes into two lists, while maintaining a sensible model order for nodes on the same height. */


Maybe add a full javadoc if you need one?

soerendomroes · 2023-11-02T10:46:07Z

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/RelativeXPlacer.java

+    }
+
+    /** Combine outlines of multiple siblings. */
+    private void bundleChildren(final ElkNode leftSubtree, final ElkNode a, final ElkNode b) {


I think this method deserves a bit more of a javadoc to explain what it does.

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p3absolute/AbsoluteXPlacer.java

improves documentation and cleans up comments

soerendomroes · 2024-08-28T07:14:21Z

@Eddykasp could you add a check-list to highlight what is still missing here?

plugins/org.eclipse.elk.alg.vertiflex/META-INF/MANIFEST.MF

Co-authored-by: Sören Domrös <[email protected]>

soerendomroes · 2024-08-28T11:16:53Z

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/RelativeXPlacer.java

+        x1 = o1.getRelativeX();
+        x2 = o2.getRelativeX();


This might be a problem, if the outline nodes already have positions from the previous run?

soerendomroes · 2024-08-28T11:17:40Z

....eclipse.elk.alg.vertiflex/src/org/eclipse/elk/alg/vertiflex/p2relative/RelativeXPlacer.java

+                // now change o1
+                o1 = o1.getNext();
+                if (o1 != null) {
+                    x1 += o1.getRelativeX();


Adding somehting to the x-coordinate may also be your problem.

soerendomroes · 2024-08-28T11:18:19Z

Could you add a test for the "I do layout twice and everything breaks" problem?

…cln/tree-algo

ClaasN and others added 25 commits August 18, 2023 12:37

spaeter commit

8eefe55

ein zwischenstand

18646ba

ein paar checks

9314139

neuere version aufs gitlab bringen

b7394d8

Merge remote-tracking branch 'cln/master' into cln/tree-algo

1854fb9

remove remaining force alg references

3e4fa44

Update Copyright notices

426e6e4

Documentation and Cleanup

45a4edc

add missing documentation implement quick fixes mark remaining issues with TODO

Support nodeNode spacing property

21ba60a

spacing.nodeNode is now considered when constructing outline nodes in addition to any existing node margins.

Remove unnecessary try catch blocks

973ff09

For invalid graphs throw UnsupportedConfigurationException instead of IllegalArgumentException

remove wrongly committed files

103836e

Use enum for layout strategy

aa26fcc

replace string with more appropriate enum edge layout strategy

update build.properties

2da37e1

remove image include

Extract property

fdacded

make layer distance property add descriptions to properties

clean up

ec0d332

Rename algorithm to VertiFlex

a48f53d

refactors all qualified names and references to the new name

rename to vertiflex in ELK feature

7c851b2

rename to vertiflex in ELK pom

e1605f4

Graph size calculation

1f968f4

Correctly compute graph size and consider padding instead of magicnumber

Check for invalid vertical constraints

9204ddd

Remove magic number offset

625b72c

Refactor phase packages

2e1f8e6

Number phase packages to correspond to the phases declared in the phases enum.

Fix graph size calculation

96b118d

Clean up imports

07fbbee

Add bend edge router

d5718f2

Eddykasp marked this pull request as ready for review October 19, 2023 13:19

Drakae reviewed Oct 19, 2023

View reviewed changes

Eddykasp added 3 commits October 20, 2023 09:47

Fix issues

b06244c

- Correct the constraint validity computation - Correct the y placement calculation for nodes without constraint - Add more documentation

Update documentation

d024b5d

Refactor unclear variable names

9afabc1

change rol and lol to right and left outline in vars and comments

Eddykasp added 3 commits October 23, 2023 12:30

Documentation

2430094

Document TODO

59c9f66

soerendomroes requested changes Nov 2, 2023

View reviewed changes

Eddykasp added 10 commits November 3, 2023 12:45

Update build.properties

16e0564

tidy up formatting

9a928ef

Refactor variable usage and map access

26f9216

Documentation

7d2b3ed

improves documentation and cleans up comments

Remove unused variable

0fa7c23

Add comments

288e0f8

Document outline node better

192a8d2

Merge NodeComparator and InverseYNodeComparator classes

8940da0

Refactor method names

8b02497

Improve Javadoc

d4dc7de

Eddykasp added 2 commits August 28, 2024 10:57

Merge branch 'master' into cln/tree-algo

567c0c7

update test files

8410c2d

soerendomroes reviewed Aug 28, 2024

View reviewed changes

plugins/org.eclipse.elk.alg.vertiflex/META-INF/MANIFEST.MF Outdated Show resolved Hide resolved

Update plugins/org.eclipse.elk.alg.vertiflex/META-INF/MANIFEST.MF

9e4f9ee

Co-authored-by: Sören Domrös <[email protected]>

soerendomroes reviewed Aug 28, 2024

View reviewed changes

Eddykasp added 2 commits August 28, 2024 14:25

add calculation of node micro layout

4de0be9

Merge branch 'cln/tree-algo' of [email protected]:Eddykasp/elk.git into …

019c2a8

…cln/tree-algo

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tree Layout with vertical position constraints #960

Tree Layout with vertical position constraints #960

Eddykasp commented Oct 11, 2023 •

edited

Loading

soerendomroes Nov 2, 2023

soerendomroes Nov 2, 2023

soerendomroes commented Aug 28, 2024

soerendomroes Aug 28, 2024

soerendomroes Aug 28, 2024

soerendomroes commented Aug 28, 2024


		}

		/** Split nodes into two lists, while maintaining a sensible model order for nodes on the same height. */

Tree Layout with vertical position constraints #960

Are you sure you want to change the base?

Tree Layout with vertical position constraints #960

Conversation

Eddykasp commented Oct 11, 2023 • edited Loading

Todos:

Sample ELK graph:

Straight edges vs preserved model order

soerendomroes Nov 2, 2023

Choose a reason for hiding this comment

soerendomroes Nov 2, 2023

Choose a reason for hiding this comment

soerendomroes commented Aug 28, 2024

soerendomroes Aug 28, 2024

Choose a reason for hiding this comment

soerendomroes Aug 28, 2024

Choose a reason for hiding this comment

soerendomroes commented Aug 28, 2024

Eddykasp commented Oct 11, 2023 •

edited

Loading