1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
/**
*
* This file is part of Tulip (www.tulip-software.org)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux
*
* Tulip is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* Tulip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
*/
#include <ogdf/layered/SugiyamaLayout.h>
#include <ogdf/layered/LongestPathRanking.h>
#include <ogdf/layered/OptimalRanking.h>
#include <ogdf/layered/BarycenterHeuristic.h>
#include <ogdf/layered/MedianHeuristic.h>
#include <ogdf/layered/SplitHeuristic.h>
#include <ogdf/layered/FastHierarchyLayout.h>
#include <ogdf/layered/CoffmanGrahamRanking.h>
#include <ogdf/layered/SiftingHeuristic.h>
#include <ogdf/layered/GreedyInsertHeuristic.h>
#include <ogdf/layered/GreedySwitchHeuristic.h>
#include <ogdf/layered/OptimalHierarchyLayout.h>
#include <ogdf/layered/FastSimpleHierarchyLayout.h>
#include <ogdf/layered/GridSifting.h>
#include <ogdf/layered/OptimalHierarchyLayout.h>
#include <tulip/StringCollection.h>
#include "tulip2ogdf/OGDFLayoutPluginBase.h"
#define ELT_RANKING "Ranking"
#define ELT_RANKINGLIST "LongestPathRanking;OptimalRanking;CoffmanGrahamRanking"
#define ELT_LONGESTPATHRANKING 0
#define ELT_OPTIMALRANKING 1
#define ELT_COFFMANGRAHAMRANKING 2
#define ELT_TWOLAYERCROSS "Two-layer crossing minimization"
#define ELT_TWOLAYERCROSSLIST "BarycenterHeuristic;MedianHeuristic;SplitHeuristic;SiftingHeuristic;GreedyInsertHeuristic;GreedySwitchHeuristic;GlobalSiftingHeuristic;GridSiftingHeuristic"
#define ELT_BARYCENTER 0
#define ELT_MEDIAN 1
#define ELT_SPLIT 2
#define ELT_SIFTING 3
#define ELT_GREEDYINSERT 4
#define ELT_GREEDYSWITCH 5
#define ELT_GLOBALSIFTING 6
#define ELT_GRIDSIFTING 7
#define ELT_HIERARCHYLAYOUT "Layout"
#define ELT_HIERARCHYLAYOUTLIST "FastHierarchyLayout;FastSimpleHierarchyLayout;OptimalHierarchyLayout"
#define ELT_FASTHIERARCHY 0
#define ELT_FASTSIMPLEHIERARCHY 1
#define ELT_OPTIMALHIERARCHY 2
// comments below have been extracted from OGDF/src/layered/sugiyama.cpp
/** \addtogroup layout */
/**
* Implementation of Sugiyama algorithm (classes Hierarchy,
* Level, SugiyamaLayout)
*
* \author Carsten Gutwenger
*
* \par License:
* This is part of the Open Graph Drawing Framework (OGDF).
*
* Copyright (C). All rights reserved.
* See README.txt in the root directory of the OGDF installation for details.
*
* \par
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* Version 2 or 3 as published by the Free Software Foundation
* and appearing in the files LICENSE_GPL_v2.txt and
* LICENSE_GPL_v3.txt included in the packaging of this file.
*
* \par
* In addition, as a special exception, you have permission to link
* this software with the libraries of the COIN-OR Osi project
* (http://www.coin-or.org/projects/Osi.xml), all libraries required
* by Osi, and all LP-solver libraries directly supported by the
* COIN-OR Osi project, and distribute executables, as long as
* you follow the requirements of the GNU General Public License
* in regard to all of the software in the executable aside from these
* third-party libraries.
*
* \par
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* \par
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* \see http://www.gnu.org/copyleft/gpl.html
***************************************************************/
class OGDFSugiyama : public OGDFLayoutPluginBase {
public:
OGDFSugiyama(const tlp::PluginContext *context) :OGDFLayoutPluginBase(context, new ogdf::SugiyamaLayout()) {
addInParameter<int>("fails",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "int" )
HTML_HELP_BODY()
"The number of times that the number of crossings may not decrease after a complete top-down bottom-up traversal, before a run is terminated."
HTML_HELP_CLOSE(),
"4");
addInParameter<int>("runs",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "int" )
HTML_HELP_BODY()
"Determines, how many times the crossing minimization is repeated. Each repetition (except for the first) starts with randomly permuted nodes on each layer. Deterministic behaviour can be achieved by setting runs to 1."
HTML_HELP_CLOSE(),
"15");
addInParameter<double>("node distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"the minimal horizontal distance between two nodes on the same layer."
HTML_HELP_CLOSE(),
"3");
addInParameter<double>("layer distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"the minimal vertical distance between two nodes on neighboring layers."
HTML_HELP_CLOSE(),
"3");
addInParameter<bool>("fixed layer distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "bool" )
HTML_HELP_BODY()
"if true, the distance between neighboring layers is fixed, otherwise variable (only for FastHierarchyLayout)."
HTML_HELP_CLOSE(),
"false");
addInParameter<bool>("transpose",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "bool" )
HTML_HELP_BODY()
"Determines whether the transpose step is performed after each 2-layer crossing minimization; this step tries to reduce the number of crossings by switching neighbored nodes on a layer."
HTML_HELP_CLOSE(),
"true");
addInParameter<bool>("arrangeCCs",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "bool" )
HTML_HELP_BODY()
"If set to true connected components are laid out separately and the resulting layouts are arranged afterwards using the packer module."
HTML_HELP_CLOSE(),
"true");
addInParameter<double>("minDistCC",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"Specifies the spacing between connected components of the graph.."
HTML_HELP_CLOSE(),
"20");
addInParameter<double>("pageRatio",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"The page ratio used for packing connected components."
HTML_HELP_CLOSE(),
"1.0");
addInParameter<bool>("alignBaseClasses",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "bool" )
HTML_HELP_BODY()
"Determines if base classes of inheritance hierarchies shall be aligned."
HTML_HELP_CLOSE(),
"false");
addInParameter<bool>("alignSiblings",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "bool" )
HTML_HELP_BODY()
"Sets the option alignSiblings."
HTML_HELP_CLOSE(),
"false");
addInParameter<StringCollection>(ELT_RANKING,
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "StringCollection")
HTML_HELP_DEF("values", "- CoffmanGrahamRanking <i>(The coffman graham ranking algorithm)</i><br/>"
"- LongestPathRanking <i>(the well-known longest-path ranking algorithm)</i><br/>"
"- OptimalRanking <i>(the LP-based algorithm for computing a node ranking with minimal edge lengths)</i>")
HTML_HELP_DEF( "default", "LongestPathRanking" )
HTML_HELP_BODY()
"Sets the option for the node ranking (layer assignment)."
HTML_HELP_CLOSE(),
ELT_RANKINGLIST);
addInParameter<StringCollection>(ELT_TWOLAYERCROSS,
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "StringCollection")
HTML_HELP_DEF("values", "- BarycenterHeuristic <i>(the barycenter heuristic for 2-layer crossing minimization)</i><br/>"
"- GreedyInsertHeuristic <i>(The greedy-insert heuristic for 2-layer crossing minimization)</i><br/>"
"- GreedySwitchHeuristic <i>(The greedy-switch heuristic for 2-layer crossing minimization)</i><br/>"
"- MedianHeuristic <i>(the median heuristic for 2-layer crossing minimization)</i><br/>"
"- SiftingHeuristic <i>(The sifting heuristic for 2-layer crossing minimization)</i><br/>"
"- SplitHeuristic <i>(the split heuristic for 2-layer crossing minimization)</i><br/>"
"- GridSiftingHeuristic <i>(the grid sifting heuristic for 2-layer crossing minimization)</i><br/>"
"- GlobalSiftingHeuristic <i>(the global sifting heuristic for 2-layer crossing minimization)</i>")
HTML_HELP_DEF( "default", "BarycenterHeuristic" )
HTML_HELP_BODY()
"Sets the module option for the two-layer crossing minimization."
HTML_HELP_CLOSE(),
ELT_TWOLAYERCROSSLIST);
addInParameter<StringCollection>(ELT_HIERARCHYLAYOUT,
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "StringCollection")
HTML_HELP_DEF("values", "- FastHierarchyLayout <i>(Coordinate assignment phase for the Sugiyama algorithm by Buchheim et al.)</i><br/>"
"- FastSimpleHierarchyLayout <i>(Coordinate assignment phase for the Sugiyama algorithm by Ulrik Brandes and Boris Koepf)</i><br/>"
"- OptimalHierarchyLayout <i>(The LP-based hierarchy layout algorithm)</i>")
HTML_HELP_DEF( "default", "FastHierarchyLayout" )
HTML_HELP_BODY()
"The hierarchy layout module that computes the final layout."
HTML_HELP_CLOSE(),
ELT_HIERARCHYLAYOUTLIST);
}
~OGDFSugiyama() {}
PLUGININFORMATION("Sugiyama (OGDF)","Carsten Gutwenger","12/11/2007",
"Implements the classical layout algorithm by Sugiyama, Tagawa, and Toda. It is a layer-based approach for producing upward drawings.","1.6","Hierarchical")
void beforeCall() {
ogdf::SugiyamaLayout *sugiyama = static_cast<ogdf::SugiyamaLayout*>(ogdfLayoutAlgo);
if (dataSet != NULL) {
int ival = 0;
double dval = 0;
bool bval = false;
StringCollection sc;
if (dataSet->get("fails", ival))
sugiyama->fails(ival);
if (dataSet->get("runs", ival))
sugiyama->runs(ival);
if (dataSet->get("arrangeCCS", bval))
sugiyama->arrangeCCs(bval);
if (dataSet->get("minDistCC", dval))
sugiyama->minDistCC(dval);
if (dataSet->get("pageRatio", dval))
sugiyama->pageRatio(dval);
if (dataSet->get("alignBaseClasses", bval))
sugiyama->alignBaseClasses(bval);
if (dataSet->get("alignSiblings", bval))
sugiyama->alignSiblings(bval);
if (dataSet->get(ELT_RANKING, sc)) {
if (sc.getCurrent() == ELT_LONGESTPATHRANKING) {
sugiyama->setRanking(new ogdf::LongestPathRanking());
}
else if(sc.getCurrent() == ELT_OPTIMALRANKING) {
sugiyama->setRanking(new ogdf::OptimalRanking());
}
else
sugiyama->setRanking(new ogdf::CoffmanGrahamRanking());
}
if (dataSet->get(ELT_TWOLAYERCROSS, sc)) {
if (sc.getCurrent() == ELT_BARYCENTER) {
sugiyama->setCrossMin(new ogdf::BarycenterHeuristic());
}
else if (sc.getCurrent() == ELT_MEDIAN) {
sugiyama->setCrossMin(new ogdf::MedianHeuristic());
}
else if (sc.getCurrent()==ELT_SPLIT) {
sugiyama->setCrossMin(new ogdf::SplitHeuristic());
}
else if (sc.getCurrent()==ELT_SIFTING) {
sugiyama->setCrossMin(new ogdf::SiftingHeuristic());
}
else if (sc.getCurrent()==ELT_GREEDYINSERT) {
sugiyama->setCrossMin(new ogdf::GreedyInsertHeuristic());
}
else if (sc.getCurrent()==ELT_GREEDYSWITCH) {
sugiyama->setCrossMin(new ogdf::GreedySwitchHeuristic());
}
else if (sc.getCurrent()==ELT_GLOBALSIFTING) {
sugiyama->setCrossMin(new ogdf::GlobalSifting());
}
else {
sugiyama->setCrossMin(new ogdf::GridSifting());
}
}
if(dataSet->get(ELT_HIERARCHYLAYOUT, sc)) {
double nodeDistance = 3;
double layerDistance = 3;
bool fixedLayerDistance = true;
dataSet->get("node distance", nodeDistance);
dataSet->get("layer distance", layerDistance);
dataSet->get("fixed layer distance", fixedLayerDistance);
if (sc.getCurrent()==ELT_FASTHIERARCHY) {
ogdf::FastHierarchyLayout *fhl = new FastHierarchyLayout();
fhl->nodeDistance(nodeDistance);
fhl->layerDistance(layerDistance);
fhl->fixedLayerDistance(fixedLayerDistance);
sugiyama->setLayout(fhl);
}
else if (sc.getCurrent()==ELT_FASTSIMPLEHIERARCHY) {
ogdf::FastSimpleHierarchyLayout *fshl = new ogdf::FastSimpleHierarchyLayout();
fshl->nodeDistance(nodeDistance);
fshl->layerDistance(layerDistance);
sugiyama->setLayout(fshl);
}
else {
ogdf::OptimalHierarchyLayout *ohl = new ogdf::OptimalHierarchyLayout();
ohl->nodeDistance(nodeDistance);
ohl->layerDistance(layerDistance);
sugiyama->setLayout(ohl);
}
}
}
}
void callOGDFLayoutAlgorithm(ogdf::GraphAttributes &gAttributes) {
ogdf::SugiyamaLayout *sugiyama = static_cast<ogdf::SugiyamaLayout*>(ogdfLayoutAlgo);
if (sugiyama->alignBaseClasses() || sugiyama->alignSiblings())
sugiyama->callUML(gAttributes);
else
ogdfLayoutAlgo->call(gAttributes);
}
void afterCall() {
if (dataSet != NULL) {
bool bval = false;
if (dataSet->get("transpose", bval)) {
if (bval) {
transposeLayoutVertically();
}
}
}
}
};
PLUGIN(OGDFSugiyama)
|
