File: OGDFPlanarizationLayout.cpp

package info (click to toggle)
tulip 4.8.0dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 179,264 kB
  • ctags: 64,517
  • sloc: cpp: 600,444; ansic: 36,311; makefile: 22,136; python: 1,304; sh: 946; yacc: 522; xml: 337; pascal: 157; php: 66; lex: 55
file content (157 lines) | stat: -rw-r--r-- 7,047 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
/**
 *
 * 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/planarity/PlanarizationLayout.h>
#include <ogdf/planarity/EmbedderMaxFace.h>
#include <ogdf/planarity/EmbedderMaxFaceLayers.h>
#include <ogdf/planarity/EmbedderMinDepth.h>
#include <ogdf/planarity/EmbedderMinDepthMaxFace.h>
#include <ogdf/planarity/EmbedderMinDepthMaxFaceLayers.h>
#include <ogdf/planarity/EmbedderMinDepthPiTa.h>
#include <ogdf/planarity/EmbedderOptimalFlexDraw.h>
#include <ogdf/planarity/SimpleEmbedder.h>

#include "tulip2ogdf/OGDFLayoutPluginBase.h"

#include <tulip/StringCollection.h>

// comments below have been extracted from OGDF/src/planarity/PlanarizationLayout.cpp
/** \addtogroup layout */

/**
 * Declaration of class PlanarizationLayout.
 *
 * \author Carsten Gutwenger
 *
 * \par License:
 * This file is part of the Open Graph Drawing Framework (OGDF).
 *
 * \par
 * Copyright (C)<br>
 * 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;
 * see the file LICENSE.txt included in the packaging of this file
 * for details.
 *
 * \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
 ***************************************************************/

#define ELT_EMBEDDER "Embedder"
#define ELT_EMBEDDER_LIST "SimpleEmbedder;EmbedderMaxFace;EmbedderMaxFaceLayers;EmbedderMinDepth;EmbedderMinDepthMaxFace;EmbedderMinDepthMaxFaceLayers;EmbedderMinDepthPiTa"//;EmbedderOptimalFlexDraw"
#define ELT_EMBEDDER_SIMPLE 0
#define ELT_EMBEDDER_MAXFACE 1
#define ELT_EMBEDDER_MAXFACELAYERS 2
#define ELT_EMBEDDER_MINDEPTH 3
#define ELT_EMBEDDER_MINDEPTHMAXFACE 4
#define ELT_EMBEDDER_MINDEPTHMAXFACELAYERS 5
#define ELT_EMBEDDER_MINDEPTHPITA 6
#define ELT_EMBEDDER_OPTIMALFLEXDRAW 7


class OGDFPlanarizationLayout : public OGDFLayoutPluginBase {

public:
  PLUGININFORMATION("Planarization Layout (OGDF)","Carsten Gutwenger","12/11/2007","The planarization approach for drawing graphs.","1.0","Planar")
  OGDFPlanarizationLayout(const tlp::PluginContext* context) :OGDFLayoutPluginBase(context, new ogdf::PlanarizationLayout()) {
    addInParameter<double>("page ratio",
                           HTML_HELP_OPEN()
                           HTML_HELP_DEF( "type", "double" )
                           HTML_HELP_BODY()
                           "Sets the option page ratio."
                           HTML_HELP_CLOSE(),
                           "1.1");
    addInParameter<StringCollection>(ELT_EMBEDDER,
                                     HTML_HELP_OPEN()
                                     HTML_HELP_DEF( "type", "StringCollection")
                                     HTML_HELP_DEF("values", "- SimpleEmbedder <i>(Planar graph embedding from the algorithm of Boyer and Myrvold)</i><br/>"
                                         "- EmbedderMaxFace <i>(Planar graph embedding with maximum external face)</i><br/>"
                                         "- EmbedderMaxFaceLayers <i>(Planar graph embedding with maximum external face, plus layers approach)</i><br/>"
                                         "- EmbedderMinDepth <i>(Planar graph embedding with minimum block-nesting depth)</i><br/>"
                                         "- EmbedderMinDepthMaxFace <i>(Planar graph embedding with minimum block-nesting depth and maximum external face)</i><br/>"
                                         "- EmbedderMinDepthMaxFaceLayers <i>(Planar graph embedding with minimum block-nesting depth and maximum external face, plus layers approach)</i><br/>"
                                         "- EmbedderMinDepthPiTa <i>(Planar graph embedding with minimum block-nesting depth for given embedded blocks)</i><br/>")
                                     //"- EmbedderOptimalFlexDraw <i>(Planar graph embedding with minimum cost)</i>")
                                     HTML_HELP_DEF("default", "SimpleEmbedder")
                                     HTML_HELP_BODY()
                                     "The result of the crossing minimization step is a planar graph, in which crossings are replaced by dummy nodes. The embedder then computes a planar embedding of this planar graph."
                                     HTML_HELP_CLOSE(),
                                     ELT_EMBEDDER_LIST);
  }

  ~OGDFPlanarizationLayout() {}

  void beforeCall() {
    ogdf::PlanarizationLayout *pl = static_cast<ogdf::PlanarizationLayout*>(ogdfLayoutAlgo);

    if (dataSet != NULL) {
      double dval = 0;
      StringCollection sc;

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

      if (dataSet->get(ELT_EMBEDDER, sc)) {
        if (sc.getCurrent() == ELT_EMBEDDER_MAXFACE) {
          pl->setEmbedder(new ogdf::EmbedderMaxFace());
        }
        else if (sc.getCurrent() == ELT_EMBEDDER_MAXFACELAYERS) {
          pl->setEmbedder(new ogdf::EmbedderMaxFaceLayers());
        }
        else if (sc.getCurrent() == ELT_EMBEDDER_MINDEPTH) {
          pl->setEmbedder(new ogdf::EmbedderMinDepth());
        }
        else if (sc.getCurrent() == ELT_EMBEDDER_MINDEPTHMAXFACE) {
          pl->setEmbedder(new ogdf::EmbedderMinDepthMaxFace());
        }
        else if (sc.getCurrent() == ELT_EMBEDDER_MINDEPTHMAXFACELAYERS) {
          pl->setEmbedder(new ogdf::EmbedderMinDepthMaxFaceLayers());
        }
        else if (sc.getCurrent() == ELT_EMBEDDER_MINDEPTHPITA) {
          pl->setEmbedder(new ogdf::EmbedderMinDepthPiTa());
// EmbedderOptimalFlexDraw embedder segfaults every time, so disable it for the moment
//        } else if (sc.getCurrent() == ELT_EMBEDDER_OPTIMALFLEXDRAW) {
//          pl->setEmbedder(new ogdf::EmbedderOptimalFlexDraw());

        }
        else {
          pl->setEmbedder(new ogdf::SimpleEmbedder());
        }
      }
    }
  }

};


PLUGIN(OGDFPlanarizationLayout)