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
|
/**
*
* This file is part of Tulip (https://tulip.labri.fr)
*
* 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/energybased/SpringEmbedderFRExact.h>
#include <tulip2ogdf/OGDFLayoutPluginBase.h>
#include <tulip/StringCollection.h>
#define COOLINGLIST "factor;logarithmic"
#define FACTOR 0
#define LOGARITHMIC 1
using namespace tlp;
using namespace ogdf;
static const char *paramHelp[] = {
// iterations
"The number of iterations.",
// noise
"Sets the parameter noise.",
// use node weights
"Indicates if the node weights have to be used.",
// node weights
"The metric containing node weights.",
// Cooling function
"Sets the parameter cooling function",
// ideal edge length
"The ideal edge length.",
// minDistCC
"The minimal distance between connected components.",
// pageRatio
"The page ratio used for packing connected components.",
// check convergence
"Indicates if the convergence has to be checked.",
// convergence tolerance
"The convergence tolerance parameter."};
class OGDFFruchtermanReingold : public OGDFLayoutPluginBase {
public:
PLUGININFORMATION(
"Fruchterman Reingold (OGDF)", "Stephan Hachul", "15/11/2007",
"Implements the Fruchterman and Reingold layout algorithm, first published "
"as:<br/><b>Graph Drawing by Force-Directed Placement</b>,<br/>Fruchterman, Thomas "
"M. J., Reingold, Edward M., Software – Practice & Experience (Wiley) Volume "
"21, Issue 11, pages 1129–1164, (1991)",
"1.2", "Force Directed")
OGDFFruchtermanReingold(const tlp::PluginContext *context)
: OGDFLayoutPluginBase(context, context ? new ogdf::SpringEmbedderFRExact() : nullptr) {
addInParameter<int>("iterations", paramHelp[0], "1000");
addInParameter<bool>("noise", paramHelp[1], "true");
addInParameter<bool>("use node weights", paramHelp[2], "false");
addInParameter<NumericProperty *>("node weights", paramHelp[3], "viewMetric");
addInParameter<StringCollection>("cooling function", paramHelp[4], COOLINGLIST, true,
"factor<br/>logarithmic");
addInParameter<double>("ideal edge length", paramHelp[5], "10.0");
addInParameter<double>("connected components spacing", paramHelp[6], "20.0");
addInParameter<double>("page ratio", paramHelp[7], "1.0");
addInParameter<bool>("check convergence", paramHelp[8], "true");
addInParameter<double>("convergence tolerance", paramHelp[9], "0.01");
}
~OGDFFruchtermanReingold() override {}
void beforeCall() override {
ogdf::SpringEmbedderFRExact *sefr = static_cast<ogdf::SpringEmbedderFRExact *>(ogdfLayoutAlgo);
if (dataSet != nullptr) {
int ival = 0;
double dval = 0;
bool bval = false;
StringCollection sc;
if (dataSet->get("iterations", ival))
sefr->iterations(ival);
if (dataSet->get("noise", bval))
sefr->noise(bval);
if (dataSet->get("connected components spacing", dval))
sefr->minDistCC(dval);
if (dataSet->get("page ratio", dval))
sefr->pageRatio(dval);
if (dataSet->get("cooling function", sc)) {
if (sc.getCurrent() == FACTOR) {
sefr->coolingFunction(SpringEmbedderFRExact::CoolingFunction::Factor);
} else {
sefr->coolingFunction(SpringEmbedderFRExact::CoolingFunction::Logarithmic);
}
}
if (dataSet->get("use node weights", bval)) {
sefr->nodeWeights(bval);
NumericProperty *metric = nullptr;
if (bval && dataSet->get("node weights", metric)) {
tlpToOGDF->copyTlpNumericPropertyToOGDFNodeWeight(metric);
}
}
if (dataSet->get("check convergence", bval))
sefr->checkConvergence(bval);
if (dataSet->get("convergence tolerance", dval))
sefr->convTolerance(dval);
}
}
};
PLUGIN(OGDFFruchtermanReingold)
|
