File: GEMLayout.h

package info (click to toggle)
tulip 3.7.0dfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 39,428 kB
  • sloc: cpp: 231,403; php: 11,023; python: 1,128; sh: 671; yacc: 522; makefile: 315; xml: 63; lex: 55
file content (165 lines) | stat: -rwxr-xr-x 4,962 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 (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * 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.
 *
 */
#ifndef Tulip_GEMLayout_H
#define Tulip_GEMLayout_H

#include <vector>

#include <tulip/TulipPlugin.h>

/** \addtogroup layout */
/*@{*/
/// An implementation of a spring-embedder layout.
/** This plugin is an implementation of the GEM-2d layout
 *  algorithm first published as:
 *
 *  A. Frick, A. Ludwig, and H. Mehldau, \n
 *  "A fast, adaptive layout algorithm for undirected graphs", \n
 *  In R. Tamassia and I. Tollis (Eds), \n
 *  Graph Drawing'94, \n
 *  Volume 894 of Lecture Notes in Computer Science, Springer Verlag, 1995.
 *
 *  <b>HISTORY</b>
 *
 *  The implementation started life as the public-domain
 *  code produced by Arne Frick and released at
 *
 *  www.frick-consulting.de/publications.html
 *
 *  The core "embedder" part of the algorithm was used in the
 *  implementation of a Java plugin for the CWI "Royere" tool,
 *  and then this code was ported to C++ to make the
 *  implementation given here.
 *
 *
 *  \note The embedder algorithm described by Frick involves three
 *  phases: insertion, arrangement, and optimization.  Only
 *  the first two of these phases are included here.
 *  Experiments with the Java implementation showed that the
 *  optimization phase consumed significantly more time than
 *  the first two and produced apparently marginal improvements
 *  in the final layout.\n
 *  As GEM, like other spring-embedder algorithms, is
 *  computationally expensive, I have tried to optimize the
 *  loops somewhat by storing all necessary node information
 *  into two arrays: "GemProp" carries the (scalar) values
 *  associated with each node by the layout algorithm, while
 *  "Adjacent" is an array of vectors, one vector per node,
 *  giving the index (integer) of each node.
 *
 * \note The new version has been reimplemented to manage edge length
 * it merges the 3D stuff and removes the use of integers (new CPU do not
 * require it anymore).
 *
 *  \author David Duke, University of Bath, UK: Email: D.Duke@bath.ac.uk
 *  \author David Auber,University of Bordeaux, FR: Email: david.auber@labri.fr
 *  Version 0.1: 23 July 2001.
 *  Version 0.2: September 2006
 */

class GEMLayout : public tlp::LayoutAlgorithm {
public:
  GEMLayout(const tlp::PropertyContext &context);
  ~GEMLayout();
  bool run();

private:
  tlp::Coord computeForces(unsigned int v,
                           float shake,
                           float gravity,
                           bool testPlaced);

  struct GEMparticule {
    tlp::node n;
    tlp::Coord pos;        // position
    int in;
    tlp::Coord imp;        // impulse
    float dir;        // direction
    float heat;        // heat
    float mass;        // weight = nr incident edges
    unsigned int id;
    GEMparticule(float m = 0) {
      pos.fill(0);
      imp.fill(0);
      dir  = 0.0;
      heat = 0;
      mass = m;
    }
  };

  /*
   * Functions used to implement the GEM3D layout.
   */

  unsigned int select();
  void vertexdata_init(const float starttemp);
  void insert();
  void displace(unsigned int v, tlp::Coord imp);
  void a_round();
  void arrange();
  void updateLayout();

  std::vector<GEMparticule> _particules;
  std::vector<int> _map; //for random selection
  tlp::MutableContainer<GEMparticule *> _nodeToParticules;

  /*
   * GEM3D variables
   */

  unsigned long Iteration;
  float         _temperature;
  tlp::Coord    _center;
  float         _maxtemp;
  float         _oscillation, _rotation;


  /*
   * Following parameters can be initialised in the original GEM3D
   * from a configuration file.  Here they are hard-wired, but
   * this could be replaced by configuration from a file.
   */
  float    i_maxtemp;
  float    i_starttemp;
  float    i_finaltemp;
  int      i_maxiter;
  float    i_gravity;
  float    i_oscillation;
  float    i_rotation;
  float    i_shake;

  float    a_maxtemp;
  float    a_starttemp;
  float    a_finaltemp;
  int      a_maxiter;
  float    a_gravity;
  float    a_oscillation;
  float    a_rotation;
  float    a_shake;


  unsigned int _dim; //2 or 3;
  unsigned int _nbNodes; //number of nodes in the graph
  bool _useLength; //if we manage edge length
  tlp::DoubleProperty * metric; //metric for edge length
  unsigned int max_iter; // the max number of iterations

};
/*@}*/
#endif