File: OGDFGemFrick.cpp

package info (click to toggle)
tulip 6.0.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 196,224 kB
  • sloc: cpp: 571,851; ansic: 13,983; python: 4,105; sh: 1,555; yacc: 522; xml: 484; makefile: 168; pascal: 148; lex: 55
file content (165 lines) | stat: -rw-r--r-- 5,200 bytes parent folder | download
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
/**
 *
 * 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/GEMLayout.h>

#include <tulip2ogdf/OGDFLayoutPluginBase.h>

#include <tulip/StringCollection.h>

static const char *paramHelp[] = {
    // number of rounds
    "The maximum number of rounds per node.",

    // min temperature
    "The minimum temperature.",

    // initial temperature
    "The initial temperature to x; must be >= minimalTemperature.",

    // gravitational constant
    "Gravitational constant parameter.",

    // desired length
    "The desired edge length to x; must be >= 0.",

    // max disturbance
    "The maximum disturbance to x; must be >= 0.",

    // rotation angle
    "The opening angle for rotations to x (0 &lt;= x &lt;= pi / 2).",

    // oscillation angle
    "Sets the opening angle for oscillations to x (0 &lt;= x &lt;= pi / 2).",

    // rotation sensitivity
    "The rotation sensitivity to x (0 &lt;= x &lt;= 1).",

    // oscillation sensitivity
    "The oscillation sensitivity to x (0 &lt;= x &lt;= 1).",

    // Attraction formula
    "The formula for attraction.",

    // connected components spacing
    "The minimum distance between connected components.",

    // page ratio
    "The page ratio used for packing connected components."};

using namespace tlp;

class OGDFGemFrick : public OGDFLayoutPluginBase {

public:
  PLUGININFORMATION(
      "GEM Frick (OGDF)", "Christoph Buchheim", "15/11/2007",
      "OGDF implementation of the GEM-2d layout algorithm first published as:<br/>"
      " <b>A fast, adaptive layout algorithm for undirected graphs</b>, A. Frick, A. "
      "Ludwig, and H. Mehldau, Graph Drawing'94, Volume 894 of Lecture Notes in "
      "Computer Science (1995),<br/>doi: <a "
      "href=\"https://doi.org/10.1007/3-540-58950-3_393\">10.1007/3-540-58950-3_393</a>",
      "1.2", "Force Directed")
  OGDFGemFrick(const tlp::PluginContext *context);
  ~OGDFGemFrick() override;

  void beforeCall() override;
};

OGDFGemFrick::OGDFGemFrick(const tlp::PluginContext *context)
    : OGDFLayoutPluginBase(context, context ? new ogdf::GEMLayout() : nullptr) {
  addInParameter<int>("number of rounds", paramHelp[0], "30000");
  addInParameter<double>("min temperature", paramHelp[1], "0.005");
  addInParameter<double>("initial temperature", paramHelp[2], "12.0");
  addInParameter<double>("gravitation", paramHelp[3], "0.0625");
  addInParameter<double>("desired length", paramHelp[4], "5.0");
  addInParameter<double>("max disturbance", paramHelp[5], "0.0");
  addInParameter<double>("rotation angle", paramHelp[6], "1.04719755");
  addInParameter<double>("oscillation angle", paramHelp[7], "1.57079633");
  addInParameter<double>("rotation sensitivity", paramHelp[8], "0.01");
  addInParameter<double>("oscillation sensitivity", paramHelp[9], "0.3");
  addInParameter<StringCollection>("attraction formula", paramHelp[10], "Fruchterman/Reingold;GEM",
                                   true, "Fruchterman/Reingold<br/>GEM");
  addInParameter<double>("connected components spacing", paramHelp[11], "20");
  addInParameter<double>("page ratio", paramHelp[12], "1.0");
}

OGDFGemFrick::~OGDFGemFrick() {}

void OGDFGemFrick::beforeCall() {
  ogdf::GEMLayout *gem = static_cast<ogdf::GEMLayout *>(ogdfLayoutAlgo);

  if (dataSet != nullptr) {
    int ival = 0;
    double dval = 0;
    StringCollection sc;

    if (dataSet->get("number of rounds", ival)) {
      gem->numberOfRounds(ival);
    }

    if (dataSet->get("min temperature", dval)) {
      gem->minimalTemperature(dval);
    }

    if (dataSet->get("initial temperature", dval)) {
      gem->initialTemperature(dval);
    }

    if (dataSet->get("gravitation", dval)) {
      gem->gravitationalConstant(dval);
    }

    if (dataSet->get("desired length", dval)) {
      gem->desiredLength(dval);
    }

    if (dataSet->get("max disturbance", dval)) {
      gem->maximalDisturbance(dval);
    }

    if (dataSet->get("rotation angle", dval)) {
      gem->rotationAngle(dval);
    }

    if (dataSet->get("oscillation angle", dval)) {
      gem->oscillationAngle(dval);
    }

    if (dataSet->get("rotation sensitivity", dval)) {
      gem->rotationSensitivity(dval);
    }

    if (dataSet->get("oscillation sensitivity", dval)) {
      gem->oscillationSensitivity(dval);
    }

    if (dataSet->get("attraction formula", sc)) {
      gem->attractionFormula(sc.getCurrent() + 1);
    }

    if (dataSet->get("connected components spacing", dval))
      gem->minDistCC(dval);

    if (dataSet->get("page ratio", dval))
      gem->pageRatio(dval);
  }
}

PLUGIN(OGDFGemFrick)