Skip to Content
Last modified by Richard Kreissig on 2023/09/14 10:13
From version 15.1
edited by msp
on 2012/04/23 12:44
Change comment: There is no comment for this version
To version 10.1
edited by msp
on 2012/04/23 10:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,7 @@
1 1  {{panel title="Project Overview" borderStyle="dashed"}}
2 2  Responsible:
3 3  
4 -* {{mention reference="XWiki.msp" style="FULL_NAME" anchor="XWiki-msp-ulkvC"/}}
4 +* {{mention reference="XWiki.msp" style="FULL_NAME" anchor="XWiki-msp-CBllx"/}}
5 5  
6 6  Related Publications:
7 7  
... ... @@ -15,6 +15,8 @@
15 15  
16 16  ===== Contents =====
17 17  
18 +
19 +
18 18  {{toc maxLevel="2"/}}
19 19  
20 20  = Getting Started[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/wiki/Projects/KIML#GettingStarted||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] =
... ... @@ -27,6 +27,11 @@
27 27  1*. It includes the Java-based layout algorithms developed in the [[KLay project>>doc:Layout Algorithms (KLay)]].
28 28  1. Open a diagram and press the layout button [[image:attach:kieler-arrange.gif]] or use the shortcut Ctrl+R L.
29 29  
32 +For development with the KIML plug-ins, check out using team project sets:
33 +
34 +* [[(% class="icon" %) (%%)Project set for KIML with GMF>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/projectsets/de.cau.cs.kieler.kiml.gmf.psf||style="text-decoration: none;" shape="rect" class="ext-link"]]
35 +* [[(% class="icon" %) (%%)Project set for KIML with Graphiti>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/projectsets/de.cau.cs.kieler.kiml.graphiti.psf||style="text-decoration: none;" shape="rect" class="ext-link"]]
36 +
30 30  === Terminology ===
31 31  
32 32  //**Layout Graph**//
... ... @@ -83,7 +83,7 @@
83 83  
84 84  [[image:attach:context_menu.png]]
85 85  
86 -The context menu for a specific layout option has different alternatives to set the currently active value as default value: //Set as Default for this Diagram// changes the open model file so that the same value is applied to all similar objects of that model. //Set as Default for ... in this Context// applies the value to all similar objects that are displayed with the same diagram editor (the option is linked to the //edit part// class of the selected object). Choosing //Set as Default for all ...// links the option value with the domain model element or diagram type of the selected object (see the context menu depicted above). These four alternatives have different priorities: if present, the default value for the current diagram is taken first, then the default value for the edit part is checked, then the default value for the domain model element, and then the default value for the diagram type.
93 +The context menu for a specific layout option has different alternatives to set the currently active value as default value: //Set as Default for this Diagram// changes the open model file so that the same value is applied to all similar objects of that model. //Set as Default for ... in this Context// applies the value to all similar objects that are displayed with the same diagram editor (the option is linked to the //edit part// class of the selected object). Choosing //Set as Default for all ...// links the option value with the domain model element or diagram type of the selected object (see Figure [[context_menu>>attach:context_menu.png]]). These four alternatives have different priorities: if present, the default value for the current diagram is taken first, then the default value for the edit part is checked, then the default value for the domain model element, and then the default value for the diagram type.
87 87  
88 88  The information button of the view toolbar can be used to display some useful details on the current selection, such as the edit part and domain model classes.
89 89  
... ... @@ -97,53 +97,6 @@
97 97  
98 98  Creating a new entry requires the selection of the type of related element and entering its class name or identifier. Class names of edit parts and domain model elements can be explored using the information button of the layout view, while diagram type identifiers can be selected with the //Browse// button. After that, a layout option has to be selected from the list using the corresponding //Browse //button. Hitting //OK// creates an entry, and its value can then be set using the //Edit// button.
99 99  
100 -= Special Layout Options =
101 -
102 -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.
103 -
104 -== Layout Algorithm ==
105 -
106 -The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for the content of a composite node. 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.
107 -
108 -The following layout types are predefined:
109 -
110 -* **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.
111 -* **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.
112 -* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
113 -* **Circular** - Circular layout algorithms emphasize biconnected components of a graph by arranging them in circles. This is useful if a drawing is desired where such components are clearly grouped, or where cycles are shown as prominent properties of the graph.
114 -* **Tree** - Specialized layout methods for trees, i.e. acyclic graphs. The regular structure of graphs that have no undirected cycles can be emphasized using an algorithm of this type.
115 -
116 -=== Available Algorithms and Libraries ===
117 -
118 -* **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and edge labels.
119 -* (% style="color: rgb(51,51,51);" %)**Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
120 -* (((
121 -(% style="color: rgb(51,51,51);" %)**Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
122 -)))
123 -* (% style="color: rgb(51,51,51);" %)**Fixed Layout** - Does not compute a new layout, but leaves all nodes and edges where they are. If the //Position// and //Bend Points// options are set for the elements of the graph, the pre-defined layout is applied.
124 -* (% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(51, 51, 51)" %)**OGD**(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)**F** ([[www.ogdf.net>>url:http://www.ogdf.net/||shape="rect"]](% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(51, 51, 51); color: rgb(51, 51, 51)" %)) - (% style="color: rgb(51,51,51);" %)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.
125 -* **Graphviz** ([[www.graphviz.org>>url:http://www.graphviz.org/||shape="rect"]])(% style="color: rgb(51,51,51);" %) - 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.
126 -
127 -== (% style="color: rgb(0,0,0);" %)Diagram Type(%%) ==
128 -
129 -Diagram types are used to classify graphical diagrams for setting default layout option values for a set of similar diagrams. The diagram type of an element is specified with the layout option {{code language="none"}}de.cau.cs.kieler.diagramType{{/code}}. Layout algorithms can declare which diagram types they support well, and give a priority value for each supported type. KIML decides at runtime which layout algorithm has the highest priority for a given diagram, so that the most suitable algorithm is always used. Usual values for such priorities are between 1 and 10, where the highest value should only be assigned if the algorithm is especially designed for diagrams of the respective type, or if it has proven to be very adequate for them. Lower values should be given if the algorithm is able to draw the diagrams correctly, but with lower quality of the resulting layout.
130 -
131 -The following diagram types are predefined:
132 -
133 -* **General** - This type is automatically assigned to all diagrams for which no specific type is declared. A layout algorithm that has the highest priority on the //General// diagram type is taken as the default algorithm when no further information on a diagram is available to KIML.
134 -* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[SyncCharts>>doc:Thin SyncCharts Editor (ThinKCharts)]], UML Activity diagrams.
135 -* **Data Flow Diagram** - Actor-oriented diagrams, where connections are mostly done between //ports// of nodes. These diagrams can only be handled properly by very special layout algorithms, such as those developed in the [[KLay project>>doc:Layout Algorithms (KLay)]].
136 -* **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
137 -* **Use Case Diagram** - Use case diagrams as defined by the UML.
138 -* **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 [[SyncCharts>>doc:Thin SyncCharts Editor (ThinKCharts)]].\\
139 -
140 -== Other Options ==
141 -
142 -* **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.
143 -* **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.
144 -* **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.
145 -* **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.
146 -
147 147  = Internal Structure[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/wiki/Projects/KIML#InternalStructure||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] =
148 148  
149 149  The primary public interface of KIML is the [[DiagramLayoutEngine>>url:http://rtsys.informatik.uni-kiel.de/fisheye/browse/kieler/plugins/de.cau.cs.kieler.kiml.ui/src/de/cau/cs/kieler/kiml/ui/diagram/DiagramLayoutEngine.java||shape="rect"]], which is responsible for analyzing diagrams, creating a [[KGraph>>doc:KGraph Meta Model]] structure, configuring and executing the layout algorithms, and writing new position information back to the diagram. The interaction with the diagram editor or viewer is handled by [[IDiagramLayoutManager>>url:http://rtsys.informatik.uni-kiel.de/fisheye/browse/kieler/plugins/de.cau.cs.kieler.kiml.ui/src/de/cau/cs/kieler/kiml/ui/diagram/IDiagramLayoutManager.java||shape="rect"]] implementations.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -885142
1 +885125
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/885142/Infrastructure for Meta Layout (KIML)
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/885125/Infrastructure for Meta Layout (KIML)