GridLayoutModule.h

Go to the documentation of this file.

 
#pragma once
 
#include <ogdf/basic/GridLayout.h>
#include <ogdf/basic/LayoutModule.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(LayoutStandards::defaultNodeSeparation()) { }
 
    virtual ~GridLayoutModule() { }
 
    virtual void call(GraphAttributes& GA) override final;
 
    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;
 
    IPoint m_gridBoundingBox; 
 
private:
    double m_separation; 
 
    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 = nullptr);
 
    void callGridFixEmbed(const Graph& G, GridLayout& gridLayout, adjEntry adjExternal = nullptr);
 
protected:
    virtual void doCall(const Graph& G, adjEntry adjExternal, GridLayout& gridLayout,
            IPoint& boundingBox, bool fixEmbedding) = 0;
 
    virtual void doCall(const Graph& G, GridLayout& gridLayout, IPoint& boundingBox) override {
        doCall(G, nullptr, gridLayout, boundingBox, false);
    }
 
    bool handleTrivial(const Graph& G, GridLayout& gridLayout, IPoint& boundingBox);
};
 
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 = nullptr) {
        PlanarGridLayoutModule::callGridFixEmbed(G, gridLayout, adjExternal);
    }
 
    void callGridFixEmbed(PlanRep& PG, GridLayout& gridLayout, adjEntry adjExternal = nullptr);
 
protected:
    virtual void doCall(PlanRep& PG, adjEntry adjExternal, GridLayout& gridLayout,
            IPoint& boundingBox, bool fixEmbedding) = 0;
 
 
    void doCall(const Graph& G, adjEntry adjExternal, GridLayout& gridLayout, IPoint& boundingBox,
            bool fixEmbedding) override;
 
    using PlanarGridLayoutModule::doCall;
};
 
}