OrthoLayoutUML.h

Go to the documentation of this file.

 
#pragma once
 
#include <ogdf/basic/Graph.h>
#include <ogdf/basic/basic.h>
#include <ogdf/orthogonal/OrthoRep.h>
#include <ogdf/uml/LayoutPlanRepUMLModule.h>
 
namespace ogdf {
class Layout;
class PlanRepUML;
 
class OGDF_EXPORT OrthoLayoutUML : public LayoutPlanRepUMLModule {
public:
    // constructor
    OrthoLayoutUML();
 
 
    // calls planar UML layout algorithm. Input is a planarized representation
    // PG of a connected component of the graph, output is a layout of the
    // (modified) planarized representation in drawing
    virtual void call(PlanRepUML& PG, adjEntry adjExternal, Layout& drawing) override;
 
    //
    // options
 
    // the minimum distance between edges and vertices
    virtual double separation() const override { return m_separation; }
 
    virtual void separation(double sep) override { m_separation = sep; }
 
    // cOverhang * separation is the minimum 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; }
 
    // the distance from the tight bounding box to the boundary of the drawing
    double margin() const { return m_margin; }
 
    void margin(double m) { m_margin = m; }
 
    // the preferred direction of generalizations
    OrthoDir preferedDir() const { return m_preferedDir; }
 
    void preferedDir(OrthoDir dir) { m_preferedDir = dir; }
 
    // cost of associations
    int costAssoc() const { return m_costAssoc; }
 
    void costAssoc(int c) { m_costAssoc = c; }
 
    // cost of generalizations
    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; }
 
    void setBendBound(int i) {
        OGDF_ASSERT(i >= 0);
        m_bendBound = i;
    }
 
    //set generic options by setting field bits,
    //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) override {
        if (optionField & UMLOpt::OpAlign) {
            m_align = true;
        } else {
            m_align = false;
        }
        if (optionField & UMLOpt::OpScale) {
            m_useScalingCompaction = true;
        } else {
            m_useScalingCompaction = false;
        }
        if (optionField & UMLOpt::OpProg) {
            m_orthoStyle = 1;
        } else {
            m_orthoStyle = 0; //traditional
        }
    }
 
    virtual int getOptions() override {
        int result = 0;
        if (m_align) {
            result = static_cast<int>(UMLOpt::OpAlign);
        }
        if (m_useScalingCompaction) {
            result += UMLOpt::OpScale;
        }
        if (m_orthoStyle == 1) {
            result += UMLOpt::OpProg;
        }
 
        return result;
    }
 
protected:
    void classifyEdges(PlanRepUML& PG, adjEntry& adjExternal);
 
private:
    // compute bounding box and move final drawing such that it is 0 aligned
    // respecting margins
    void computeBoundingBox(const PlanRepUML& 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;
    //mainly used for OrthoShaper traditional/progressive
    int m_orthoStyle;
    int m_bendBound; 
};
 
}