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
|
/**
*
* 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/tree/TreeLayout.h>
#include "tulip2ogdf/OGDFLayoutPluginBase.h"
#include <tulip/StringCollection.h>
#define ELT_ORIENTATION "Orientation"
#define ELT_ORIENTATIONLIST "topToBottom;bottomToTop;leftToRight;rightToLeft"
#define ELT_TOPTOBOTTOM 0
#define ELT_BOTTOMTOTOP 1
#define ELT_LEFTTORIGHT 2
#define ELT_RIGHTTOLEFT 3
#define ELT_ROOTSELECTION "Root selection"
#define ELT_ROOTSELECTIONLIST "rootIsSource;rootIsSink;rootByCoord"
#define ELT_ROOTSOURCE 0
#define ELT_ROOTSINK 1
#define ELT_ROOTCOORD 2
// comments below have been extracted from OGDF/src/tree/TreeLayout.cpp
/** \addtogroup layout */
/**
* Linear time layout algorithm for trees (TreeLayout)
* based on Walker's algorithm
*
* \author Christoph Buchheim
*
* \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 OGDFTree : public OGDFLayoutPluginBase {
public:
PLUGININFORMATION("Improved Walker (OGDF)","Christoph Buchheim","12/11/2007",
"Implements a linear-time tree layout algorithm with straight-line or orthogonal edge routing.","1.5","Tree")
OGDFTree(const tlp::PluginContext* context) :OGDFLayoutPluginBase(context, new ogdf::TreeLayout()) {
addInParameter<double>("siblings distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"The minimal required horizontal distance between siblings."
HTML_HELP_CLOSE(),
"20");
addInParameter<double>("subtrees distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"The minimal required horizontal distance between subtrees."
HTML_HELP_CLOSE(),
"20");
addInParameter<double>("levels distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"The minimal required vertical distance between levels."
HTML_HELP_CLOSE(),
"50");
addInParameter<double>("trees distance",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "double" )
HTML_HELP_BODY()
"The minimal required horizontal distance between trees in the forest."
HTML_HELP_CLOSE(),
"50");
addInParameter<bool>("orthogonal layout",
HTML_HELP_OPEN()
HTML_HELP_DEF( "type", "bool" )
HTML_HELP_BODY()
"Indicates whether orthogonal edge routing style is used or not."
HTML_HELP_CLOSE(),
"false");
addInParameter<StringCollection>(ELT_ORIENTATION,
HTML_HELP_DEF( "type", "StringCollection")
HTML_HELP_DEF("values", "- topToBottom <i>(Edges are oriented from top to bottom)</i><br/>- bottomToTop <i>(Edges are oriented from bottom to top)</i><br>- leftToRight <i>(Edges are oriented from left to right)</i><br/>- rightToLeft <i>(Edges are oriented from right to left)</i>")
HTML_HELP_DEF( "default", "topToBottom " )
HTML_HELP_BODY()
"This parameter indicates the orientation of the layout."
HTML_HELP_CLOSE(),
ELT_ORIENTATIONLIST);
addInParameter<StringCollection>(ELT_ROOTSELECTION,
HTML_HELP_DEF( "type", "StringCollection")
HTML_HELP_DEF("values", "- rootIsSource <i>(Select a source in the graph)</i><br>- rootIsSink <i>(Select a sink in the graph)</i><br/>- rootByCoord <i>(Use the coordinates, e.g., select the topmost node if orientation is topToBottom)</i>")
HTML_HELP_DEF( "default", "rootIsSource " )
HTML_HELP_BODY()
"This parameter that indicates how the root is selected."
HTML_HELP_CLOSE(),
ELT_ROOTSELECTIONLIST);
}
~OGDFTree() {}
void beforeCall() {
ogdf::TreeLayout *tree = static_cast<ogdf::TreeLayout*>(ogdfLayoutAlgo);
if (dataSet != NULL) {
double dval = 0;
bool bval = false;
StringCollection sc;
if (dataSet->get("siblings distance", dval))
tree->siblingDistance(dval);
if (dataSet->get("subtrees distance", dval))
tree->subtreeDistance(dval);
if (dataSet->get("levels distance", dval))
tree->levelDistance(dval);
if (dataSet->get("trees distance", dval))
tree->treeDistance(dval);
if (dataSet->get("orthogonal layout", bval))
tree->orthogonalLayout(bval);
if (dataSet->get(ELT_ORIENTATION, sc)) {
if (sc.getCurrent() == ELT_TOPTOBOTTOM) {
// because of an ununderstanding fix
// in thirdparty/OGDF/src/ogdf/tree/TreeLayout.cpp
tree->orientation(ogdf::bottomToTop);
}
else if (sc.getCurrent() == ELT_BOTTOMTOTOP) {
// same as above
tree->orientation(ogdf::topToBottom);
}
else if (sc.getCurrent() == ELT_LEFTTORIGHT) {
tree->orientation(ogdf::leftToRight);
}
else {
tree->orientation(ogdf::rightToLeft);
}
}
if (dataSet->get(ELT_ROOTSELECTION, sc)) {
if (sc.getCurrent() == ELT_ROOTSOURCE) {
tree->rootSelection(ogdf::TreeLayout::rootIsSource);
}
else if (sc.getCurrent() == ELT_ROOTSINK) {
tree->rootSelection(ogdf::TreeLayout::rootIsSink);
}
else {
tree->rootSelection(ogdf::TreeLayout::rootByCoord);
}
}
}
}
};
PLUGIN(OGDFTree)
|
