Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 20.1
edited by msp
on 2014/03/08 20:42
Change comment: There is no comment for this version
To version 21.1
edited by msp
on 2014/03/08 21:51
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -146,7 +146,7 @@
146 146  
147 147  )))
148 148  |(((
149 -Layout Hierarchy
149 +[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
150 150  )))|(((
151 151  de.cau.cs.kieler.layoutHierarchy
152 152  )))|(((
... ... @@ -381,7 +381,7 @@
381 381  )))
382 382  |(% colspan="1" %)(% colspan="1" %)
383 383  (((
384 -Comment Box
384 +[[Comment Box>>doc:||anchor="commentBox"]]
385 385  )))|(% colspan="1" %)(% colspan="1" %)
386 386  (((
387 387  de.cau.cs.kieler.commentBox
... ... @@ -467,7 +467,7 @@
467 467  )))
468 468  |(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -Hypernode
470 +[[Hypernode>>doc:||anchor="hypernode"]]
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 473  de.cau.cs.kieler.hypernode
... ... @@ -565,7 +565,7 @@
565 565  )))
566 566  |(% colspan="1" %)(% colspan="1" %)
567 567  (((
568 -No Layout
568 +[[No Layout>>doc:||anchor="noLayout"]]
569 569  )))|(% colspan="1" %)(% colspan="1" %)
570 570  (((
571 571  de.cau.cs.kieler.noLayout
... ... @@ -712,6 +712,8 @@
712 712  
713 713  = Detailed Documentation =
714 714  
715 +This section explains every layout option in more detail.
716 +
715 715  == The Most Important Options ==
716 716  
717 717  While most layout options are used to affect how the active layout algorithm computes concrete coordinates for the graph elements, there are some layout options that have a special role in KIML.
... ... @@ -720,13 +720,13 @@
720 720  
721 721  {{id name="layoutAlgorithm"/}}
722 722  
723 -The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for a graph or subgraph. The value can be either the identifier of a layout algorithm or the identifier of a layout type. In the latter case the algorithm with highest priority of that type is applied. It is possible to set different values for this option on subgraphs of a hierarchical graph, where a subgraph is identified by a parent node. A layout algorithm is responsible to process only the direct content of a given parent node. An exception from this rule is made when the Layout Hierarchy option is active.
725 +The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for a graph or subgraph. The value can be either the identifier of a layout algorithm or the identifier of a layout type. In the latter case the algorithm with highest priority of that type is applied. It is possible to set different values for this option on subgraphs of a hierarchical graph, where a subgraph is identified by a parent node. A layout algorithm is responsible to process only the direct content of a given parent node. An exception from this rule is made when the [[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]] option is active.
724 724  
725 725  The following layout has been created by setting a force-based layout algorithm on the inner hierarchy level and a layer-based layout algorithm on the top level.
726 726  
727 727  [[image:attach:layout_algorithm.png]]
728 728  
729 -=== Available Algorithms and Libraries ===
731 +==== Available Algorithms and Libraries ====
730 730  
731 731  * **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and labels.
732 732  * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
... ... @@ -737,7 +737,7 @@
737 737  * **OGDF** ((% style="color: rgb(0,0,0);" %)[[www.ogdf.net>>url:http://www.ogdf.net/||shape="rect"]](%%)) - A self-contained C++ class library for the automatic layout of diagrams. The version that is shipped with KIELER is compiled as an executable that reads files in OGML format and outputs the computed concrete layout.
738 738  * **Graphviz** ([[www.graphviz.org>>url:http://www.graphviz.org/||shape="rect"]]) - An open source graph visualization tool with several graph layout programs, web and interactive graphical interfaces, auxiliary tools, libraries, and language bindings. Graphviz needs to be installed separately in order to be used within KIELER, since it is called in a separate process using the DOT language for communication.
739 739  
740 -=== Predefined Layout Types ===
742 +==== Predefined Layout Types ====
741 741  
742 742  * **Layered** - The layer-based method emphasizes the direction of edges by pointing as many edges as possible into the same direction. The nodes are arranged in layers and then reordered such that the number of edge crossings is minimized. Afterwards, concrete coordinates are computed for the nodes and edge bend points.
743 743  * **Orthogonal** - Orthogonal methods follow the "topology-shape-metrics" approach, which first applies a planarization technique, resulting in a planar representation of the graph, then compute an orthogonal shape, and finally determine concrete coordinates for nodes and edge bend points by applying a compaction method.
... ... @@ -760,15 +760,6 @@
760 760  * **Use Case Diagram** - Use case diagrams as defined by the UML.
761 761  * **Unconnected Boxes** - Sets of nodes that have no connections and are treated as resizable boxes. This is related to mathematical [[packing problems>>url:http://en.wikipedia.org/wiki/Packing_problem||shape="rect"]]. Example: Regions in [[doc:SCCharts SyncCharts]].
762 762  
763 -== Other Options ==
764 -
765 -* **Layout Hierarchy** ({{code language="none"}}de.cau.cs.kieler.layoutHierarchy{{/code}}) - If this option is supported and active, the layout algorithm is requested to process the full hierarchy contained in the input node. This means that instead of executing another algorithm on each hierarchy level, all levels are arranged in a single algorithm execution.
766 -* **Hypernode** ({{code language="none"}}de.cau.cs.kieler.hypernode{{/code}}) - A node that is marked as hypernode has a special role in the graph structure, since all its incident edges are treated as parts of the same [[hyperedge>>url:http://en.wikipedia.org/wiki/Hypergraph||shape="rect"]]. Example: relation vertices in [[Ptolemy>>url:http://ptolemy.eecs.berkeley.edu/||shape="rect"]] models.
767 -* **Comment Box** ({{code language="none"}}de.cau.cs.kieler.commentBox{{/code}}) - A node that is marked as comment box is treated as a label that needs to be placed somewhere. This is different to normal node labels, which are usually regarded as fixed.
768 -* **No Layout** ({{code language="none"}}de.cau.cs.kieler.noLayout{{/code}}) - Elements that are marked with this option are excluded from layout. This is used to identify diagram objects that should not be regarded as graph elements.
769 -
770 -This section explains every layout option in more detail.
771 -
772 772  === Edge Routing ===
773 773  
774 774  {{id name="edgeRouting"/}}
... ... @@ -778,14 +778,54 @@
778 778  * POLYLINE
779 779  Edges consist of one or more segments defined by a list of bend points.
780 780  * ORTHOGONAL
781 -Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
782 -* SPLINE
783 -Edges are routed as splines (smooth curves). (% style="color: rgb(153,51,0);" %)**TODO:** Add more documentation on how the returned bend points are to be interpreted.
774 +Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
775 +* SPLINES
776 +Edges are routed as splines (smooth curves).
784 784  * UNDEFINED
785 -No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
778 +No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
786 786  
787 -(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
780 +[[image:attach:edge_routing.png]]
788 788  
782 +When used as layout option, the edge routing is set for a whole graph or subgraph, i.e. on a parent node. However, the property is additionally used for the output of the layout algorithm in order to mark individual edges. If the edge routing assigned to an edge is anything other than SPLINES, the bend points of that edge are interpreted with their normal meaning, i.e. straight lines are drawn between consecutive bend points. If, on the other hand, a layout algorithm marks an edge with the value SPLINES, the bend points have to be interpreted as control points for a series of cubic splines following this procedure:
783 +
784 +1. Start at the source point of the edge.
785 +1. As long as there are at least three bend points left:
786 +11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
787 +11. Use the third bend point as start point for the next segment.
788 +11. Consume the three bend points and proceed to the next segment.
789 +1. Check the number of remaining bend points:
790 +11. Two bend points – draw a cubic spline segment to the target point of the edge.
791 +11. One bend point – draw a quadratic spline segment to the target point of the edge.
792 +11. No bend point – draw a straight line to the target point of the edge.
793 +
794 +== Other Options ==
795 +
796 +=== Comment Box ===
797 +
798 +{{id name="commentBox"/}}
799 +
800 +A node that is marked as comment box is treated as a label that needs to be placed somewhere. In contrast to normal node labels (modeled with a KLabel instance), comment boxes may have connections to other nodes, as in the following example.
801 +
802 +[[image:attach:comment_box.png]]
803 +
804 +=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
805 +
806 +{{id name="hypernode"/}}
807 +
808 +A node that is marked as hypernode has a special role in the graph structure, since all its incident edges are treated as parts of the same [[hyperedge>>url:http://en.wikipedia.org/wiki/Hypergraph||shape="rect"]]. Example: relation vertices in [[Ptolemy>>url:http://ptolemy.eecs.berkeley.edu/||shape="rect"]] models.
809 +
810 +=== Layout Hierarchy ===
811 +
812 +{{id name="layoutHierarchy"/}}
813 +
814 +If this option is supported and active, the layout algorithm is requested to process the full hierarchy contained in the input node. This means that instead of executing another algorithm on each hierarchy level, all levels are arranged in a single algorithm execution.
815 +
816 +=== No Layout ===
817 +
818 +{{id name="noLayout"/}}
819 +
820 +Elements that are marked with this option are excluded from layout. This is used to identify diagram objects that should not be regarded as graph elements.
821 +
789 789  === Port Offset ===
790 790  
791 791  {{id name="portOffset"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470014
1 +9470016
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470014/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470016/KIML Layout Options