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
|
/*
* $Revision: 2583 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-12 01:02:21 +0200 (Do, 12. Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of interface for planar layout algorithms for
* UML diagrams (used in planarization approach).
*
* \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
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_LAYOUT_CLUSTER_PLAN_REP_MODULE_H
#define OGDF_LAYOUT_CLUSTER_PLAN_REP_MODULE_H
#include <ogdf/cluster/ClusterPlanRep.h>
#include <ogdf/basic/Layout.h>
namespace ogdf {
class NodePair;
/**
* \brief Interface for planar cluster layout algorithms.
*
* \warning This interface is likely to change in future releases.
* \see ClusterPlanarizationLayout
*/
class OGDF_EXPORT LayoutClusterPlanRepModule {
public:
//! Initializes a cluster planar layout module.
LayoutClusterPlanRepModule() { }
virtual ~LayoutClusterPlanRepModule() { }
/** \brief Computes a layout of \a PG in \a drawing.
*
* Must be overridden by derived classes.
* @param PG is the input cluster planarized representation which may be modified.
* @param adjExternal is an adjacenty entry on the external face.
* @param drawing is the computed layout of \a PG.
* @param npEdges are pairs of nodes in the original graph that shall be connected.
* @param newEdges are assigned the inserted edges.
* @param originalGraph must be the original graph of \a PG.
*/
virtual void call(
ClusterPlanRep &PG,
adjEntry adjExternal,
Layout &drawing,
List<NodePair>& npEdges,
List<edge>& newEdges,
Graph& originalGraph) = 0;
//! Returns the bounding box of the computed layout.
const DPoint &getBoundingBox() const {
return m_boundingBox;
}
//! Sets the (generic) options; derived classes have to cope with the interpretation)
virtual void setOptions(int /* optionField */) { } //don't make it abstract
//! Returns the (generic) options.
virtual int getOptions() { return 0; } //don't make it abstract
//! Returns the minimal allowed distance between edges and vertices.
virtual double separation() const = 0;
//! Sets the minimal allowed distance between edges and vertices to \a sep.
virtual void separation(double sep) = 0;
protected:
/**
* \brief Stores the bounding box of the computed layout.
* <b>Must be set by derived algorithms!</b>
*/
DPoint m_boundingBox;
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
