Open Graph Drawing Framework  v.2007.11

Overview Class Hierarchy Class Index Class List Members Namespaces Source Files Search for:

ClusterOrthoLayout.h

Go to the documentation of this file.

/*
 * $Revision: 1.4 $
 * 
 * last checkin:
 *   $Author: klein $ 
 *   $Date: 2007-11-15 12:18:51 +0100 (Do, 15 Nov 2007) $ 
 ***************************************************************/
 
#ifdef _MSC_VER
#pragma once
#endif


#ifndef OGDF_CLUSTER_ORTHO_LAYOUT_H
#define OGDF_CLUSTER_ORTHO_LAYOUT_H


#include <ogdf/module/LayoutClusterPlanRepModule.h>
#include <ogdf/orthogonal/OrthoRep.h>
#include <ogdf/cluster/ClusterPlanRep.h>
#include <ogdf/cluster/CPlanarEdgeInserter.h>


namespace ogdf {

    enum OrthoDir;


//---------------------------------------------------------
// ClusterOrthoLayout
// represents planar orthogonal drawing algorithm for
// c-planar c-connected Clustergraphs
//---------------------------------------------------------
class ClusterOrthoLayout : public LayoutClusterPlanRepModule
{
public:
    ClusterOrthoLayout();

  
    void call(ClusterPlanRep &PG, adjEntry adjExternal, Layout &drawing);
    void call(ClusterPlanRep &PG, 
              adjEntry adjExternal, 
              Layout &drawing,
              List<NodePair>& npEdges,
              List<edge>& newEdges,
              Graph& originalGraph);

    //void call(PlanRepUML & /* PG */, adjEntry /* adjExternal */, Layout & /* drawing */) {}

    //
    // options

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

    //distance between the glue point of an edge and a corner of the vertex boundary
    double cOverhang() const {
        return m_cOverhang;
    }
    void cOverhang(double c) {
        m_cOverhang = c;
    }


    double margin() const {
        return m_margin;
    }
    void margin(double m) {
        m_margin = m;
    }


    OrthoDir preferedDir() const {
        return m_preferedDir;
    }
    void preferedDir(OrthoDir dir) {
        m_preferedDir = dir;
    }

    int costAssoc() const {
        return m_costAssoc;
    }
    void costAssoc(int c) {
        m_costAssoc = c;
    }

    int costGen() const {
        return m_costGen;
    }
    void costGen(int c) {
        m_costGen = c;
    }

    void optionProfile(int i) {m_optionProfile = i;} 

    void align(bool b) {m_align = b;}

    void scaling(bool b) {m_useScalingCompaction = b;}

    //Necessary to allow setting over base class pointer
    //bit 0 = alignment
    //bit 1 = scaling
    //bit 2 = progressive/traditional
    //=> 0 is standard
    virtual void setOptions(int optionField) 
    {
        if (optionField & 1) m_align = true;
        else m_align = false;
        if (optionField & 2) m_useScalingCompaction = true;
        else m_useScalingCompaction = false;
        if (optionField & 4) m_orthoStyle = 1; 
        else m_orthoStyle = 0; //traditional
    }


private:
    // compute bounding box and move final drawing such that it is 0 aligned
    // respecting margins
    void computeBoundingBox(const ClusterPlanRep &PG, Layout &drawing);


    // options
    double m_separation;
    double m_cOverhang; 
    double m_margin;    
    OrthoDir m_preferedDir; 
    int m_optionProfile;
    int m_costAssoc;    
    int m_costGen;      
    //align merger sons on same level
    bool m_align;       
    //settings for scaling compaction
    bool m_useScalingCompaction; 
    int m_scalingSteps; 
    int m_orthoStyle;   
};


} // end namespace ogdf


#endif

---