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
|
/*
* $Revision: 2523 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of interface for layout algorithms that allow
* calls with a MultilevelGraph parameter (class MultilevelLayoutModule).
*
* \author Karsten Klein
*
* \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_MULTILEVEL_LAYOUT_MODULE_H
#define OGDF_MULTILEVEL_LAYOUT_MODULE_H
#include <ogdf/module/LayoutModule.h>
#include <ogdf/internal/energybased/MultilevelGraph.h>
namespace ogdf {
/**
* \brief Interface of general layout algorithms that also allow
* a MultilevelGraph as call parameter, extending the interface
* of a simple LayoutModule.
*
*/
class OGDF_EXPORT MultilevelLayoutModule : public LayoutModule {
public:
//! Initializes a multilevel layout module.
MultilevelLayoutModule() { }
virtual ~MultilevelLayoutModule() { }
/**
* \brief Computes a layout of graph \a GA.
*
* This method is the actual algorithm call and must be implemented by
* derived classes.
* @param GA is the input graph and will also be assigned the layout information.
*/
virtual void call(GraphAttributes &GA) = 0;
/**
* \brief Computes a layout of graph \a GA.
*
* @param GA is the input graph and will also be assigned the layout information.
*/
void operator()(GraphAttributes &GA) { call(GA); }
/**
* \brief Computes a layout of graph \a MLG.
*
* This method can be implemented optionally to allow a LayoutModule to modify the Graph.
* This allows some Layout Algorithms to save Memory, compared to a normal call(GA)
* DO NOT implement this if you are not sure whether this would save you Memory!
* This method only helps if the Graph is already in the MultiLevelGraph Format
* (or can be converted without creating a copy) AND the layout would need a copy otherwise.
* All Incremental Layouts (especially energy based) CAN be called by ModularMultilevelMixer.
* The standard implementation converts the MLG to GA and uses call(GA).
*
* If implemented, the following Implementation of call(GA) is advised
* to ensure consistent behaviour of the two call Methods:
* void YourLayout::call(GraphAttributes &GA)
* {
* MultilevelGraph MLG(GA);
* call(MLG);
* MLG.exportAttributes(GA);
* }
*
* @param MLG is the input graph and will also be assigned the layout information.
*/
virtual void call(MultilevelGraph &MLG) {
GraphAttributes GA(MLG.getGraph());
MLG.exportAttributesSimple(GA);
call(GA);
MLG.importAttributesSimple(GA);
};
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
