ext/OGDF/ogdf/planarity/SimpleEmbedder.h

   1 /*
   2  * $Revision: 2599 $
   3  *
   4  * last checkin:
   5  *   $Author: chimani $
   6  *   $Date: 2012-07-15 22:39:24 +0200 (So, 15. Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief A simple embedder algorithm.
  11  *
  12  * \author Thorsten Kerkhof (thorsten.kerkhof@udo.edu)
  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 #ifdef _MSC_VER
  44 #pragma once
  45 #endif
  46
  47 #ifndef OGDF_SIMPLE_EMBEDDER_H
  48 #define OGDF_SIMPLE_EMBEDDER_H
  49
  50 #include <ogdf/module/EmbedderModule.h>
  51 #include <ogdf/basic/extended_graph_alg.h>
  52 #include <ogdf/basic/CombinatorialEmbedding.h>
  53 #include <ogdf/planarity/PlanRep.h>
  54
  55 namespace ogdf {
  56
  57 //! Planar graph embedding by using default planarEmbed.
  58 class OGDF_EXPORT SimpleEmbedder : public EmbedderModule
  59 {
  60 public:
  61         // construction / destruction
  62         SimpleEmbedder() { }
  63         ~SimpleEmbedder() { }
  64
  65         /**
  66          * \brief Call embedder algorithm.
  67          * \param G is the original graph. Its adjacency list is changed by the embedder.
  68          * \param adjExternal is an adjacency entry on the external face and is set by the embedder.
  69          */
  70         void call(Graph& G, adjEntry& adjExternal);
  71
  72 private:
  73         /**
  74          * \brief Find best suited external face according to certain criteria.
  75          * \param PG is a planar representation of the original graph.
  76          * \param E is a combinatorial embedding of the original graph.
  77          * \return Best suited external face.
  78          */
  79         face findBestExternalFace(const PlanRep& PG, const CombinatorialEmbedding& E);
  80
  81 };
  82
  83 } // end namespace ogdf
  84
  85 #endif