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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
|
/*
* $Revision: 3388 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2013-04-10 14:56:08 +0200 (Wed, 10 Apr 2013) $
***************************************************************/
/** \file
* \brief Declaration of interface for mixed-model crossings
* beautifier algorithms
*
* \author Carsten Gutwenger
*
* \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_MIXED_MODEL_CROSSINGS_BEAUTIFIER_MODULE_H
#define OGDF_MIXED_MODEL_CROSSINGS_BEAUTIFIER_MODULE_H
#include <ogdf/planarity/PlanRep.h>
#include <ogdf/basic/GridLayout.h>
namespace ogdf {
/**
* \brief The base class for Mixed-Model crossings beautifier algorithms.
*
* The class MixedModelCrossingsBeautifierModule is the base class for
* mixed model bend crossing modules. Such a module transforms an input
* graph \a G into an output graph \a G' such that crossings of edges don't
* look weird.
*
* <H3>Implementation of Mixed-Model Crossings Beautifier Algorithms</H3>
*
* An implementation of a Mixed-Model crossings beautifier module must override
* the protected method doCall().
*/
class OGDF_EXPORT MixedModelCrossingsBeautifierModule {
public:
//! Initializes the Mixed-Model crossings beautifier module.
MixedModelCrossingsBeautifierModule() { }
// destruction
virtual ~MixedModelCrossingsBeautifierModule() { }
/*
* \brief Calls the Mixed-Model crossings beautifier module for graph \a PG and grid layout \a gl.
*
* @param PG is the input graph.
* @param gl is the grid layout of \a PG.
*/
void call(const PlanRep &PG, GridLayout &gl);
//! Returns the number of processed crossings.
int numberOfCrossings() const {
return m_nCrossings;
}
protected:
/**
* \brief Implements the crossings beautifier module.
*
* @param PG is the input graph.
* @param gl is the grid layout of \a PG.
* @param L is the list of crossing nodes.
*/
virtual void doCall(const PlanRep &PG, GridLayout &gl, const List<node> &L) = 0;
private:
int m_nCrossings; //!< the number of processed crossings.
OGDF_MALLOC_NEW_DELETE
};
//! Dummy implementation of Mixed-Model crossings beautifier.
/**
* This implementation does no beautification at all and can thus be used
* for obtaining the original Mixed-Model layout.
*/
class MMDummyCrossingsBeautifier : public MixedModelCrossingsBeautifierModule
{
protected:
//!< Dummy implementation.
void doCall(const PlanRep &, GridLayout &, const List<node> &) { }
};
} // end namespace ogdf
#endif
|