ext/OGDF/ogdf/module/HierarchyLayoutModule.h

   1 /*
   2  * $Revision: 2583 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-12 01:02:21 +0200 (Do, 12. Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of interface hierarchy layout algorithms
  11  *        (3. phase of Sugiyama).
  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_HIER_LAYOUT_MODULE_H
  50 #define OGDF_HIER_LAYOUT_MODULE_H
  51
  52
  53
  54 #include <ogdf/layered/Hierarchy.h>
  55 #include <ogdf/basic/GraphCopyAttributes.h>
  56
  57
  58 namespace ogdf {
  59
  60
  61 /**
  62  * \brief Interface of hierarchy layout algorithms.
  63  *
  64  * \see SugiyamaLayout
  65  */
  66 class OGDF_EXPORT HierarchyLayoutModule {
  67 public:
  68         //! Initializes a hierarchy layout module.
  69         HierarchyLayoutModule() { }
  70
  71         virtual ~HierarchyLayoutModule() { }
  72
  73         /**
  74          * \brief Computes a hierarchy layout of \a H in \a AGA
  75          * @param H is the input hierarchy.
  76          * @param GA is assigned the hierarchy layout.
  77          */
  78         void call(const Hierarchy& H, GraphAttributes &GA) {
  79                 GraphCopyAttributes AGC(H,GA);
  80                 doCall(H,AGC);
  81                 AGC.transform();
  82         }
  83
  84         //
  85         // * \brief Computes a hierarchy layout of \a H in \a AG.
  86         // * @param H is the input hierarchy.
  87         // * @param AG is assigned the hierarchy layout.
  88         // */
  89         //void call(Hierarchy& H, GraphAttributes &AG) {
  90         //      GraphCopyAttributes AGC(H,AG);
  91         //      doCall(H,AGC);
  92         //      HierarchyLayoutModule::dynLayerDistance(AGC, H);
  93         //      HierarchyLayoutModule::addBends(AGC, H);
  94         //      AGC.transform();
  95         //}
  96
  97
  98         //
  99         // * \brief Computes a hierarchy layout of \a H in \a AG.
 100         // * @param H is the input hierarchy.
 101         // * @param AG is assigned the hierarchy layout.
 102         // * @param AGC is GraphCopyAttribute init. with H and AG
 103         // */
 104         //void call(const Hierarchy& H, GraphAttributes &, GraphCopyAttributes &AGC) {
 105         //      doCall(H,AGC);
 106         //}
 107
 108
 109         //! Adds bends to edges for avoiding crossings with nodes.
 110         static void addBends(GraphCopyAttributes &AGC, Hierarchy &H);
 111
 112         static void dynLayerDistance(GraphCopyAttributes &AGC, Hierarchy &H);
 113
 114 private:
 115
 116         //! after calling, ci (cj) contains the number of nodes of level i (j=i-1) which overlap the edge (s,t)
 117         static void overlap(GraphCopyAttributes &AGC, Hierarchy &H, node s, node t, int i, int &ci, int &cj);
 118
 119 protected:
 120         /**
 121          * \brief Implements the actual algorithm call.
 122          *
 123          * Must be implemented by derived classes.
 124          *
 125          * @param H is the input hierarchy.
 126          * @param AGC has to be assigned the hierarchy layout.
 127          */
 128         virtual void doCall(const Hierarchy& H, GraphCopyAttributes &AGC) = 0;
 129
 130         OGDF_MALLOC_NEW_DELETE
 131
 132 };
 133
 134
 135 } // end namespace ogdf
 136
 137
 138 #endif