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
|
/**
*
* 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/tree/TreeLayout.h>
#include <tulip2ogdf/OGDFLayoutPluginBase.h>
#include <tulip/StringCollection.h>
#include <tulip/TreeTest.h>
#define ORIENTATIONLIST "top to bottom;bottom to top;left to right;right to left"
#define TOPTOBOTTOM 0
#define BOTTOMTOTOP 1
#define LEFTTORIGHT 2
#define RIGHTTOLEFT 3
#define ROOTSELECTIONLIST "source;sink;by coord"
#define ROOTSOURCE 0
#define ROOTSINK 1
#define ROOTCOORD 2
using namespace tlp;
using namespace ogdf;
static const char *paramHelp[] = {
// siblings distance
"The minimal required horizontal distance between siblings.",
// subtrees distance
"The minimal required horizontal distance between subtrees.",
// levels distance
"The minimal required vertical distance between levels.",
// trees distance
"The minimal required horizontal distance between trees in the forest.",
// orthogonal layout
"Indicates whether orthogonal edge routing style is used or not.",
// Orientation
"This parameter indicates the orientation of the layout.",
// Root selection
"This parameter indicates how the root is selected."};
static const char *orientationValuesDescription =
"top to Bottom <i>(edges are oriented from top to bottom)</i><br>"
"bottom to top <i>(edges are oriented from bottom to top)</i><br>"
"left to right <i>(edges are oriented from left to right)</i><br>"
"right to left <i>(edges are oriented from right to left)</i>";
static const char *rootSelectionValuesDescription =
"source <i>(select a source in the graph)</i><br>"
"sink <i>(select a sink in the graph)</i><br>"
"by coord <i>(use the coordinates, e.g., select the topmost node if orientation is "
"top to bottom)</i>";
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.6", "Tree")
OGDFTree(const tlp::PluginContext *context)
: OGDFLayoutPluginBase(context, context ? new ogdf::TreeLayout() : nullptr) {
addInParameter<double>("siblings distance", paramHelp[0], "20");
addInParameter<double>("subtrees distance", paramHelp[1], "20");
addInParameter<double>("levels distance", paramHelp[2], "50");
addInParameter<double>("trees distance", paramHelp[3], "50");
addInParameter<bool>("orthogonal layout", paramHelp[4], "false");
addInParameter<StringCollection>("orientation", paramHelp[5], ORIENTATIONLIST, true,
orientationValuesDescription);
addInParameter<StringCollection>("root selection", paramHelp[6], ROOTSELECTIONLIST, true,
rootSelectionValuesDescription);
}
~OGDFTree() override {}
bool check(string &error) override {
if (!tlp::TreeTest::isTree(graph)) {
error += "graph is not a directed tree";
return false;
}
return true;
}
void beforeCall() override {
ogdf::TreeLayout *tree = static_cast<ogdf::TreeLayout *>(ogdfLayoutAlgo);
if (dataSet != nullptr) {
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("orientation", sc)) {
switch (sc.getCurrent()) {
case TOPTOBOTTOM:
// because of an ununderstanding fix
// in thirdparty/OGDF/src/ogdf/tree/TreeLayout.cpp
tree->orientation(Orientation::bottomToTop);
break;
case BOTTOMTOTOP:
// same as above
tree->orientation(Orientation::topToBottom);
break;
case LEFTTORIGHT:
tree->orientation(Orientation::leftToRight);
break;
default:
tree->orientation(Orientation::rightToLeft);
}
}
if (dataSet->get("root selection", sc)) {
switch (sc.getCurrent()) {
case ROOTSOURCE:
tree->rootSelection(TreeLayout::RootSelectionType::Source);
break;
case ROOTSINK:
tree->rootSelection(TreeLayout::RootSelectionType::Sink);
break;
default:
tree->rootSelection(TreeLayout::RootSelectionType::ByCoord);
}
}
}
}
};
PLUGIN(OGDFTree)
|