Changes for page KIML

Last modified by Richard Kreissig on 2025/01/30 12:04
<
From version < 8.1 >
edited by msp
on 2013/04/09 10:14
To version < 10.1 >
edited by cds
on 2013/04/11 13:55
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.msp
1 +XWiki.cds
Content
... ... @@ -2,9 +2,15 @@
2 2  This tutorial is still being worked on. Don't start working on it just yet.
3 3  {{/warning}}
4 4  
5 -Welcome to the second tutorial! We will work our way through installing a proper Eclipse setup and developing a first very basic layout algorithm. The layout algorithm will integrate with KIML (KIELER Infrastructure for Meta-Layout), our very own framework that connects graphical editors with layout algorithms. Once you're finished, you should be able to create new Eclipse plug-ins and know how to write layout algorithms for KIML.
5 +Welcome to the second tutorial! We will work our way through installing a proper Eclipse setup and developing a first very basic layout algorithm. The layout algorithm will integrate with KIML (KIELER Infrastructure for Meta-Layout), our very own framework that connects graphical editors with layout algorithms. Once you're finished, you should be able to create new Eclipse plug-ins and know how to write layout algorithms for KIML. And you should have a running Eclipse-based application that should look something like this:
6 6  
7 +
8 +
7 7  {{warning title="ToDo"}}
10 +Insert screen shot of final application.
11 +{{/warning}}
12 +
13 +{{warning title="ToDo"}}
8 8  Insert link to presentation slides.
9 9  {{/warning}}
10 10  
... ... @@ -96,41 +96,111 @@
96 96  
97 97  1. Start Eclipse and create a new workspace.
98 98  1. Setup your workspace as explained in [[this guide>>doc:KIELER.Configuring Eclipse]].
105 +1. We will now make the two local clones of our Git repositories known to Eclipse. To that end, open the //Git Repository Exploring// perspective through //Window// -> //Open Perspective// -> //Other//.
106 +1. Click on //Add an existing local Git repository// and choose the location of the tutorial repository. Note that when you open the repository entry, the branch you previously checked out is marked as the current branch under //Branches// -> //Local//.
107 +1. Add the KIML repository.
108 +1. We will now import the projects required for KIML development to your workspace. Right-click on the KIML repository and choose //Import Projects//.
109 +1. Choose //Import existing projects//, and select the //plugins// folder from the //Working Directory//. Then click //Next//.
110 +1. Import the following plug-ins. This consitutes a basic configuration for the development of layout algorithms.\\
111 +1*. de.cau.cs.kieler.core
112 +1*. de.cau.cs.kieler.core.kgraph
113 +1*. de.cau.cs.kieler.kiml
114 +1*. de.cau.cs.kieler.kiml.gmf
115 +1*. de.cau.cs.kieler.kiml.service
116 +1*. de.cau.cs.kieler.kiml.ui
117 +1*. de.cau.cs.kieler.klay.layered
118 +1. To actually test your layout algorithms, you will need some kind of simple graph editor. The following plug-ins will add our KEG editor to your installation, which is just that.\\
119 +1*. de.cau.cs.kieler.core.annotations
120 +1*. de.cau.cs.kieler.core.kgraph.edit
121 +1*. de.cau.cs.kieler.core.kivi
122 +1*. de.cau.cs.kieler.core.model
123 +1*. de.cau.cs.kieler.core.model.gmf
124 +1*. de.cau.cs.kieler.core.ui
125 +1*. de.cau.cs.kieler.karma
126 +1*. de.cau.cs.kieler.keg
127 +1*. de.cau.cs.kieler.keg.diagram
128 +1*. de.cau.cs.kieler.keg.diagram.custom
129 +1*. de.cau.cs.kieler.keg.edit
99 99  
100 100  == Adding a New Plug-in ==
101 101  
102 -
133 +We need to create a new plug-in to implement the layout algorithm in. Switch back to the Java or Plug-in Development perspective and follow these steps:
103 103  
135 +1. Click //File// > //New// > //Other...// > //Plug-in Development// > //Plug-in Project//.
136 +1. Enter {{code language="none"}}de.cau.cs.rtprak.login_name.tutorial2{{/code}} as the project name. Uncheck //Use default location// and use {{code language="none"}}tutorial_repository_path/de.cau.cs.rtprak.login_name.tutorial2{{/code}} as the location. Click //Next//.
137 +1. Set the version to {{code language="none"}}0.1.0.qualifier{{/code}}, vendor to {{code language="none"}}Christian-Albrechts-Universität zu Kiel{{/code}}, and execution environment to //J2SE-1.5//. (do this for all plug-ins that you create!)
138 +1. Uncheck all checkboxes in the //Options// group and click //Finish//.
139 +1. If Eclipse asks you whether the //Plug-in Development// perspective should be opened, choose either //Yes// or //No//. It doesn't make much of a difference anyway.
140 +
141 +You should now commit your new, empty project to the Git repository. We will do that from within Eclipse.
142 +
143 +1. Right-click your project in the //Package Explorer// and click //Team// > //Share Project...//
144 +1. As the repository type, select //Git// and click //Next//.
145 +1. Tell Eclipse what repository to add the project to. The repository you placed the project in is already preselected. Simply click //Finish//.
146 +1. Since Git support is now enabled for the project, right-click it again and click //Team// > //Commit...//
147 +1. Select all files, enter a (meaningful) commit message, and click //Commit//.
148 +
104 104  == Writing the Layout Algorithm ==
105 105  
106 -
151 +When writing our layout algorithm, we are going to need to be able to access code defined in several other plug-ins. To do that, we need to add dependencies to those plug-ins:
107 107  
108 -
153 +1. In your new plug-in, open the file {{code language="none"}}META-INF/MANIFEST.MF{{/code}}. The plug-in manifest editor will open. Open its //Dependencies// tab.
154 +1. Add dependencies to the following plug-ins:\\
155 +1*. {{code language="none"}}de.cau.cs.kieler.core{{/code}}
156 +1*. {{code language="none"}}de.cau.cs.kieler.core.kgraph{{/code}}
157 +1*. {{code language="none"}}de.cau.cs.kieler.kiml{{/code}}
158 +1. Save the editor.
109 109  
160 +Layout algorithms interface with KIML by means of a layout provider class that has to be created and registered with KIML.
161 +
162 +1. Right-click the source folder of your plug-in and click //New// > //Class//.
163 +1. Set the package to {{code language="none"}}de.cau.cs.rtprak.login_name.tutorial2{{/code}}, enter {{code language="none"}}Login_nameLayoutProvider{{/code}} as the class name, and select {{code language="none"}}de.cau.cs.kieler.kiml.AbstractLayoutProvider{{/code}} as the superclass. (This will only be available through the //Browse// dialog if you have saved the plug-in manifest editor; if you haven't, Eclipse won't know about the new dependencies yet.)
164 +1. Select //Generate comments// and click //Finish//.
165 +
166 +Implement the layout provider class:
167 +
168 +1. (((
169 +Add the following constants:
170 +
171 +{{code language="java"}}
172 +/** default value for spacing between nodes. */
173 +private static final float DEFAULT_SPACING = 15.0f;
174 +{{/code}}
175 +)))
176 +1. (((
177 +Use the following code as the skeleton of the {{code language="none"}}doLayout(...){{/code}} method:
178 +
179 +{{code language="java"}}
180 +progressMonitor.begin("Login_name layouter", 1);
181 +KShapeLayout parentLayout = layoutNode.getData(KShapeLayout.class);
182 +
183 +float objectSpacing = parentLayout.getPRoperty(LayoutOptions.SPACING);
184 +if (objectSpacing < 0) {
185 + objectSpacing = DEFAULT_SPACING;
186 +}
187 +
188 +float borderSpacing = parentLayout.getProperty(LayoutOptions.BORDER_SPACING);
189 +if (borderSpacing < 0) {
190 + borderSpacing = DEFAULT_SPACING;
191 +}
192 +
193 +// TODO: Insert actual layout code.
194 +
195 +progressMonitor.done();
196 +{{/code}}
197 +)))
198 +1. (((
199 +Put the following code at the end of the {{code language="none"}}doLayout(...){{/code}} method:
200 +
201 +{{code language="java"}}
202 +progressMonitor.done();
203 +{{/code}}
204 +)))
205 +
110 110  
111 111  
112 112  This exercise will introduce the usage of the Eclipse Plugin Development Environment for developing new layout algorithms to be used in Eclipse diagram editors. Replace each <login> by your own login name (e.g. msp), and each <Login> by your login name with capitalized first letter (e.g. Msp). For any questions contact msp.
113 113  
114 -1. Install and set up Eclipse ((% style="color: rgb(255,0,0);" %)TODO: describe steps to install and set up Eclipse(%%))
115 -1. Import the following KIELER plugins: ((% style="color: rgb(255,0,0);" %)TODO: describe steps to access and import the KIELER plugins and update the list(%%))\\
116 -1*. de.cau.cs.kieler.core
117 -1*. de.cau.cs.kieler.core.kgraph
118 -1*. (% style="font-size: 10.0pt;line-height: 13.0pt;" %)de.cau.cs.kieler.kiml
119 -1*. (% style="font-size: 10.0pt;line-height: 13.0pt;" %)de.cau.cs.kieler.kiml.service
120 -1*. de.cau.cs.kieler.kiml.ui
121 -1*. (% style="font-size: 10.0pt;line-height: 13.0pt;" %)de.cau.cs.kieler.klay.layered
122 -1. Create a new plugin\\
123 -11. //File → New →// Other... //→// Plug-in Development //→// Plug-in Project
124 -11. Project name: de.cau.cs.rtprak.<login>.tutorial2
125 -11. //Next// //→// set version to //0.1.0.qualifier//, provider to //Christian-Albrechts-Universität zu Kiel//, and execution environment to //J2SE-1.5// (do this for all plugins that you create!)
126 -11. The checkboxes in the //Options// group can be deactivated -> //Finish//
127 -1. Commit the new plugin project ((% style="color: rgb(255,0,0);" %)TODO: describe steps to commit plugin projects(%%))
128 -1. (% style="font-size: 10.0pt;line-height: 13.0pt;" %)Open the file META-INF/MANIFEST.MF //→// //Dependencies// tab(%%)\\
129 -1*. Add the plugins de.cau.cs.kieler.core and de.cau.cs.kieler.kiml to the list of dependencies, then save the file.
130 -1. Create a //layout provider// class with the //New →// Class wizard\\
131 -1*. Package: de.cau.cs.rtprak.<login>.tutorial2
132 -1*. Name: <Login>LayoutProvider
133 -1*. Superclass: de.cau.cs.kieler.kiml.AbstractLayoutProvider
134 134  1. (((
135 135  Implement the layout provider class
136 136  1. (% style="font-size: 10.0pt;line-height: 13.0pt;" %)Add the following constant to the class:
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -6160470
1 +6160474
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS13LayPract/pages/6160470/KIML
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS13LayPract/pages/6160474/KIML

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage