GridLayoutModule.h

Go to the documentation of this file.

/*
 * $Revision: 2299 $
 * 
 * last checkin:
 *   $Author: gutwenger $ 
 *   $Date: 2012-05-07 15:57:08 +0200 (Mon, 07 May 2012) $ 
 ***************************************************************/
 
#ifdef _MSC_VER
#pragma once
#endif

#ifndef OGDF_GRID_LAYOUT_MODULE_H
#define OGDF_GRID_LAYOUT_MODULE_H



#include <ogdf/module/LayoutModule.h>
#include <ogdf/basic/GridLayout.h>
#include <ogdf/planarity/PlanRep.h>


namespace ogdf {


class OGDF_EXPORT GridLayoutModule : public LayoutModule
{
    friend class GridLayoutPlanRepModule;
    friend class PlanarGridLayoutModule;

public:
    GridLayoutModule() : LayoutModule(), m_separation(40) { }

    virtual ~GridLayoutModule() { }

    void call(GraphAttributes &AG);

    void callGrid(const Graph &G, GridLayout &gridLayout);


    double separation() const { return m_separation; }

    void separation(double sep) { m_separation = sep; }

    const IPoint &gridBoundingBox() const { return m_gridBoundingBox; }

protected:
    virtual void doCall(const Graph &G, GridLayout &gridLayout, IPoint &boundingBox) = 0;

private:
    double m_separation; 
    IPoint m_gridBoundingBox; 

    void mapGridLayout(const Graph &G,
        GridLayout &gridLayout,
        GraphAttributes &AG);
};


class OGDF_EXPORT PlanarGridLayoutModule : public GridLayoutModule
{
public:
    PlanarGridLayoutModule() : GridLayoutModule() { }

    virtual ~PlanarGridLayoutModule() { }

    void callFixEmbed(GraphAttributes &AG, adjEntry adjExternal = 0);

    void callGridFixEmbed(const Graph &G, GridLayout &gridLayout, adjEntry adjExternal = 0);

protected:
    virtual void doCall(
        const Graph &G, 
        GridLayout &gridLayout, 
        IPoint &boundingBox)
    {
        doCall(G,0,gridLayout,boundingBox,false);
    }

    virtual void doCall(
        const Graph &G, 
        adjEntry adjExternal,
        GridLayout &gridLayout, 
        IPoint &boundingBox, 
        bool fixEmbedding) = 0;
};


class OGDF_EXPORT GridLayoutPlanRepModule : public PlanarGridLayoutModule
{
public:
    GridLayoutPlanRepModule() : PlanarGridLayoutModule() { }

    virtual ~GridLayoutPlanRepModule() { }

    void callGrid(const Graph &G, GridLayout &gridLayout) {
        PlanarGridLayoutModule::callGrid(G,gridLayout);
    }

    void callGrid(PlanRep &PG, GridLayout &gridLayout);

    void callGridFixEmbed(const Graph &G, GridLayout &gridLayout, adjEntry adjExternal = 0) {
        PlanarGridLayoutModule::callGridFixEmbed(G,gridLayout,adjExternal);
    }

    void callGridFixEmbed(PlanRep &PG, GridLayout &gridLayout, adjEntry adjExternal = 0);

protected:
    virtual void doCall(
        PlanRep &PG, 
        adjEntry adjExternal,
        GridLayout &gridLayout,
        IPoint &boundingBox,
        bool fixEmbedding) = 0;

private:
    void doCall(
        const Graph &G, 
        adjEntry adjExternal,
        GridLayout &gridLayout, 
        IPoint &boundingBox, 
        bool fixEmbedding);
};


} // end namespace ogdf


#endif