ext/OGDF/ogdf/module/LayoutModule.h

   1 /*
   2  * $Revision: 2523 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of interface for layout algorithms (class
  11  *        LayoutModule)
  12  *
  13  * \author Carsten Gutwenger
  14  *
  15  * \par License:
  16  * This file is part of the Open Graph Drawing Framework (OGDF).
  17  *
  18  * \par
  19  * Copyright (C)<br>
  20  * See README.txt in the root directory of the OGDF installation for details.
  21  *
  22  * \par
  23  * This program is free software; you can redistribute it and/or
  24  * modify it under the terms of the GNU General Public License
  25  * Version 2 or 3 as published by the Free Software Foundation;
  26  * see the file LICENSE.txt included in the packaging of this file
  27  * for details.
  28  *
  29  * \par
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * \par
  36  * You should have received a copy of the GNU General Public
  37  * License along with this program; if not, write to the Free
  38  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  39  * Boston, MA 02110-1301, USA.
  40  *
  41  * \see  http://www.gnu.org/copyleft/gpl.html
  42  ***************************************************************/
  43
  44
  45 #ifdef _MSC_VER
  46 #pragma once
  47 #endif
  48
  49 #ifndef OGDF_LAYOUT_MODULE_H
  50 #define OGDF_LAYOUT_MODULE_H
  51
  52
  53
  54 #include <ogdf/basic/GraphAttributes.h>
  55 #include <ogdf/basic/Constraints.h>
  56 #include <ogdf/internal/energybased/MultilevelGraph.h>
  57
  58 namespace ogdf {
  59
  60
  61 /**
  62  * \brief Interface of general layout algorithms.
  63  *
  64  */
  65 class OGDF_EXPORT LayoutModule {
  66 public:
  67         //! Initializes a layout module.
  68         LayoutModule() { }
  69
  70         virtual ~LayoutModule() { }
  71
  72         /**
  73          * \brief Computes a layout of graph \a GA.
  74          *
  75          * This method is the actual algorithm call and must be implemented by
  76          * derived classes.
  77          * @param GA is the input graph and will also be assigned the layout information.
  78          */
  79         virtual void call(GraphAttributes &GA) = 0;
  80
  81         /**
  82          * \brief Computes a layout of graph \a GA wrt the constraints in \a GC
  83          * (if applicable).
  84          */
  85         virtual void call(GraphAttributes &GA, GraphConstraints & GC) { call(GA); }
  86
  87         /**
  88          * \brief Computes a layout of graph \a GA.
  89          *
  90          * @param GA is the input graph and will also be assigned the layout information.
  91          */
  92         void operator()(GraphAttributes &GA) { call(GA); }
  93
  94         OGDF_MALLOC_NEW_DELETE
  95 };
  96
  97
  98 } // end namespace ogdf
  99
 100
 101 #endif