ext/OGDF/ogdf/simultaneous/SimDrawManipulatorModule.h

   1 /*
   2  * $Revision: 2528 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-03 23:05:08 +0200 (Tue, 03 Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Module for simdraw manipulator classes
  11  *
  12  * \author Michael Schulz
  13  *
  14  * \par License:
  15  * This file is part of the Open Graph Drawing Framework (OGDF).
  16  *
  17  * \par
  18  * Copyright (C)<br>
  19  * See README.txt in the root directory of the OGDF installation for details.
  20  *
  21  * \par
  22  * This program is free software; you can redistribute it and/or
  23  * modify it under the terms of the GNU General Public License
  24  * Version 2 or 3 as published by the Free Software Foundation;
  25  * see the file LICENSE.txt included in the packaging of this file
  26  * for details.
  27  *
  28  * \par
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * \par
  35  * You should have received a copy of the GNU General Public
  36  * License along with this program; if not, write to the Free
  37  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  38  * Boston, MA 02110-1301, USA.
  39  *
  40  * \see  http://www.gnu.org/copyleft/gpl.html
  41  ***************************************************************/
  42
  43 #ifndef OGDF_SIMDRAW_MANIPULATOR_MODULE_H
  44 #define OGDF_SIMDRAW_MANIPULATOR_MODULE_H
  45
  46 #include<ogdf/simultaneous/SimDraw.h>
  47
  48 namespace ogdf
  49 {
  50         //! Interface for simdraw manipulators
  51         /**
  52         *  To avoid class SimDraw to become too large, several functions
  53         *  have been outsourced. These are systematically
  54         *  grouped in creation methods (SimDrawCreator), algorithm calls
  55         *  (SimDrawCaller) and coloring methods (SimDrawColorizer).
  56         *
  57         *  A manipulator instance always needs a SimDraw instance (base instance)
  58         *  to work on. The base instance is linked by pointers,
  59         *  thus a change within the base instance after initializing does
  60         *  not cause trouble:
  61         *  \code
  62         *  SimDraw SD;
  63         *  SimDrawCreatorSimple SDCr(SD);
  64         *  SimDrawColorizer SDCo(SD);
  65         *  SDCr.createTrees_GKV05(4);
  66         *  SimDrawCaller SDCa(SD);
  67         *  SDCa.callUMLPlanarizationLayout();
  68         *  SDCo.addColor();
  69         *  \endcode
  70         */
  71         class OGDF_EXPORT SimDrawManipulatorModule
  72         {
  73
  74         protected:
  75                 //! pointer to current simdraw instance
  76                 SimDraw *m_SD;
  77
  78                 //! pointer to current graph
  79                 Graph *m_G;
  80
  81                 //! pointer to current graphattributes
  82                 GraphAttributes *m_GA;
  83
  84         public:
  85                 //! default constructor
  86                 /** creates its own simdraw instance
  87                 */
  88                 SimDrawManipulatorModule();
  89
  90                 //! constructor
  91                 SimDrawManipulatorModule(SimDraw &SD) { init(SD); }
  92
  93                 //! initializing base instance
  94                 void init(SimDraw &SD);
  95
  96                 //! returns base instance
  97                 const SimDraw &constSimDraw() const { return *m_SD; }
  98         };
  99
 100 } // end namespace ogdf
 101
 102 #endif