File: Layout.h

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 (184 lines) | stat: -rw-r--r-- 4,846 bytes parent folder | download | duplicates (2)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*
 * $Revision: 3188 $
 *
 * last checkin:
 *   $Author: gutwenger $
 *   $Date: 2013-01-10 09:53:32 +0100 (Thu, 10 Jan 2013) $
 ***************************************************************/

/** \file
 * \brief Declaration of class Layout
 *
 * \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_H
#define OGDF_LAYOUT_H


#include <ogdf/basic/GraphAttributes.h>


namespace ogdf {

	class GraphCopy;
	class PlanRep;


/**
 * \brief Stores a layout of a graph (coordinates of nodes, bend
 *        points of edges).
 *
 */
class OGDF_EXPORT Layout
{
public:
	/** @{
	 * \brief Creates a layout associated with no graph.
	 */
	Layout() { }

	/**
	 * \brief Creates a layout associated with graph \a G.
	 *
	 * The layout is initialized such that all node positions are (0,0)
	 * and all bend point lists of edges are empty.
	 *
	 * @param G is the corresponding graph .
	 */
	Layout(const Graph &G) : m_x(G,0), m_y(G,0), m_bends(G) { }

	// destruction
	~Layout() { }


	/** @} @{
	 * \brief Returns a reference to the array storing x-coordinates of nodes.
	 */
	const NodeArray<double> &x() const { return m_x; }

	/**
	 * \brief Returns a reference to the array storing x-coordinates of nodes.
	 */
	NodeArray<double> &x() { return m_x; }

	/** @} @{
	 * \brief Returns a reference to the array storing y-coordinates of nodes.
	 */
	const NodeArray<double> &y() const { return m_y; }

	/**
	 * \brief Returns a reference to the array storing y-coordinates of nodes.
	 */
	NodeArray<double> &y() { return m_y; }


	/** @} @{
	 * \brief Returns the x-coordinate of node \a v.
	 */
	const double &x(node v) const { return m_x[v]; }

	/**
	 * \brief Returns the x-coordinate of node \a v.
	 */
	double &x(node v) { return m_x[v]; }

	/** @} @{
	 * \brief Returns the y-coordinate of node \a v.
	 */
	const double &y(node v) const { return m_y[v]; }

	/**
	 * \brief Returns the y-coordinate of node \a v.
	 */
	double &y(node v) { return m_y[v]; }

	/** @} @{
	 * \brief Returns the bend point list of edge \a e.
	 */
	const DPolyline &bends(edge e) const { return m_bends[e]; }

	/**
	 * \brief Returns the bend point list of edge \a e.
	 */
	DPolyline &bends(edge e) { return m_bends[e]; }


	/** @} @{
	 * \brief Returns the polyline of edge \a eOrig in \a dpl.
	 *
	 * @param GC is the input graph copy; \a GC must also be the associated graph.
	 * @param eOrig is an edge in the original graph of \a GC.
	 * @param dpl is assigned the poyline of \a eOrig.
	 */
	void computePolyline(GraphCopy &GC, edge eOrig, DPolyline &dpl) const;

	/**
	 * \brief Returns the polyline of edge \a eOrig in \a dpl and clears the
	 *        bend points of the copies.
	 *
	 * The bend point lists of all edges in the edge path corresponding to \a eOrig are
	 * empty afterwards! This is a faster version of computePolyline().
	 *
	 * @param PG is the input graph copy; \a PG must also be the associated graph.
	 *        of this layout.
	 * @param eOrig is an edge in the original graph of \a GC.
	 * @param dpl is assigned the poyline of \a eOrig.
	 */
	void computePolylineClear(PlanRep &PG, edge eOrig, DPolyline &dpl);

	//! Computes the bounding box of the layout, which is a drawing of \a PG.
	/**
	 * @param PG must be the planarized representation associated with this layout.
	 * @return a point representing the with and height of this layout, respecting the sizes
	 *         of nodes as stored in \a PG.
	 */
	DPoint computeBoundingBox(PlanRep &PG) const;

	/** @} */

private:
	NodeArray<double> m_x;        //!< The x-coordinates of nodes.
	NodeArray<double> m_y;        //!< The y-coordinates of nodes.
	EdgeArray<DPolyline> m_bends; //!< The bend points of edges.

	OGDF_MALLOC_NEW_DELETE
};


} // end namespace ogdf

#endif