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
|
/*
* $Revision: 2546 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-04 21:16:17 +0200 (Wed, 04 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of interface for embedder for
* graphs.
*
* \author Thorsten Kerkhof (thorsten.kerkhof@udo.edu)
*
* \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_EMBEDDER_MODULE_H
#define OGDF_EMBEDDER_MODULE_H
#include <ogdf/planarity/PlanRep.h>
#include <ogdf/basic/Module.h>
#include <ogdf/basic/Timeouter.h>
namespace ogdf {
/**
* \brief Base class for embedder algorithms.
*
* An embedder algorithm computes a planar embedding of a planar
* graph.
*
* \see PlanarizationLayout, PlanarizationGridLayout
*/
class OGDF_EXPORT EmbedderModule : public Module, public Timeouter {
public:
//! Initializes an embedder module.
EmbedderModule() { }
virtual ~EmbedderModule() { }
/**
* \brief Calls the embedder algorithm for graph \a G.
* \param G is the graph that shall be embedded.
* \param adjExternal is set (by the algorithm) to an adjacency entry on the
* external face of \a G.
*/
virtual void call(Graph& G, adjEntry& adjExternal) = 0;
//! Calls the embedder algorithm for planarized representation \a PG.
void operator()(Graph& G, adjEntry& adjExternal) { call(G, adjExternal); }
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
