ClusterOrthoShaper.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_CLUSTER_ORTHO_FORMER_H
#define OGDF_CLUSTER_ORTHO_FORMER_H


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


namespace ogdf {

const bool angleMaxBound = true;
const bool angleMinBound = false;

enum bendCost {defaultCost, topDownCost, bottomUpCost};

class OGDF_EXPORT ClusterOrthoShaper
{

public:

    enum n_type {low, high, inner, outer}; //types of network nodes: 
                                           //nodes and faces

    ClusterOrthoShaper() {
        m_distributeEdges = true; // true;  //try to distribute edges to all node sides
        m_fourPlanar      = true;  //do not allow zero degree angles at high degree
        m_allowLowZero    = false; //do allow zero degree at low degree nodes
        m_multiAlign      = true;//true;  //start/end side of multi edges match
        m_traditional     = true;//true;  //prefer 3/1 flow at degree 2 (false: 2/2)
        m_deg4free        = false; //allow free angle assignment at degree four
        m_align           = false; //align nodes on same hierarchy level
        m_topToBottom     = 0;     //bend costs depend on edges cluster depth
    };

    ~ClusterOrthoShaper() {};

    // Given a planar representation for a UML graph and its planar 
    // combinatorial embedding, call() produces an orthogonal 
    // representation using Tamassias bend minimization algorithm
    // with a flow network where every flow unit defines 90 degree angle
    // in traditional mode.
    // A maximum number of bends per edge can be specified in 
    // startBoundBendsPerEdge. If the algorithm is not successful in 
    // producing a bend minimal representation subject to 
    // startBoundBendsPerEdge, it successively enhances the bound by 
    // one trying to compute an orthogonal representation.
    //
    // Using startBoundBendsPerEdge may not produce a bend minimal
    // representation in general.
    void call(ClusterPlanRep &PG,
        CombinatorialEmbedding &E,
        OrthoRep &OR,
        int startBoundBendsPerEdge = 0,
        bool fourPlanar = true) throw(AlgorithmFailureException);


    // returns option distributeEdges
    bool distributeEdges() { return m_distributeEdges; }
    // sets option distributeEdges to b
    void distributeEdges(bool b) { m_distributeEdges = b; }

    // returns option multiAlign
    bool multiAlign() { return m_multiAlign; }
    // sets option multiAlign to b
    void multiAlign(bool b) { m_multiAlign = b; }

    // returns option traditional
    bool traditional() { return m_traditional; }
    // sets option traditional to b
    void traditional(bool b) { m_traditional = b; }

    //returns option deg4free
    bool fixDegreeFourAngles() { return m_deg4free; }
    //sets option deg4free
    void fixDegreeFourAngles(bool b) { m_deg4free = b; }

    //alignment of brothers in hierarchies
    void align(bool al) {m_align = al;}
    bool align() {return m_align;}

    void bendCostTopDown(int i) {m_topToBottom = i;}

    //return cluster dependant bend cost for standard cost pbc
    int clusterProgBendCost(int clDepth, int treeDepth, int pbc)
    {
        int cost = 1;
        switch (m_topToBottom)
        {
            case 1: //topDownCost
                        cost = pbc*(clDepth+1); //safeInt
                        break;
            case 2: //bottomUpCOst
                        cost = pbc*(treeDepth - clDepth + 1); //safeInt
                        break;
            default: //defaultCost
                        cost = pbc;
                        break;
        }

//      cout<<"   Cost/pbc: "<<cost<<"/"<<pbc<<"\n";

        return cost;
    }

    //this is a try: I dont know why this was never implemented for traditional,
    //maybe because of the unit cost for traditional bends vs. the highbound
    //cost for progressive bends
    //return cluster dependant bend cost for standard cost pbc
    //preliminary same as progressive
    int clusterTradBendCost(int clDepth, int treeDepth, int pbc)
    {
        int cost = 1;
        switch (m_topToBottom)
        {
            case 1: //topDownCost
                        cost = pbc*(clDepth+1); //safeInt
                        break;
            case 2: //bottomUpCOst
                        cost = pbc*(treeDepth - clDepth + 1); //safeInt
                        break;
            default: //defaultCost
                        cost = pbc;
                        break;
        }

        return cost;
    }//clusterTradBendCost



private:
    bool m_distributeEdges; // distribute edges among all sides if degree > 4
    bool m_fourPlanar;      // should the input graph be four planar 
                            // (no zero degree)
    bool m_allowLowZero;    // allow low degree nodes zero degree
                            // (to low for zero...)
    bool m_multiAlign;      // multi edges aligned on the same side
    bool m_deg4free;        // allow degree four nodes free angle assignment
    bool m_traditional;     // do not prefer 180 degree angles,
                            // traditional is not tamassia,
    // traditional is a kandinsky - ILP - like network with node supply 4,
    // not traditional interprets angle flow zero as 180 degree, "flow
    // through the node"
    bool m_align;           //try to achieve an alignment in hierarchy levels

    int m_topToBottom;      //change bend costs on cluster hierarchy levels
    //set angle boundary
    //warning: sets upper AND lower bounds, therefore may interfere with existing bounds
    void setAngleBound(edge netArc, int angle, EdgeArray<int>& lowB,
                  EdgeArray<int>& upB, EdgeArray<edge>& aTwin, bool maxBound = true)
    {
        //vorlaeufig
        OGDF_ASSERT(!m_traditional);
        if (m_traditional)
        {
            switch (angle)
            {
                case 0:
                case 90:
                case 180:
                        break;
                OGDF_NODEFAULT
            }//switch
        }//trad
        else
        {
            switch (angle)
            {
                case 0: if (maxBound)
                        {
                            upB[netArc] = lowB[netArc] = 2;
                            edge e2 = aTwin[netArc];
                            if (e2) 
                            {
                                upB[e2] = lowB[e2] = 0;
                            }
                        }
                        else
                        {
                            upB[netArc] = 2; lowB[netArc] = 0;
                            edge e2 = aTwin[netArc];
                            if (e2) 
                            {
                                upB[e2] = 2;
                                lowB[e2] = 0;
                            }

                        }
                       break;
                case 90:
                        if (maxBound)
                        {
                            lowB[netArc] = 1;
                            upB[netArc] = 2;
                            edge e2 = aTwin[netArc];
                            if (e2) 
                            {
                                upB[e2] = lowB[e2] = 0;
                            }
                        }
                        else
                        {
                            upB[netArc] = 1; 
                            lowB[netArc] = 0;
                            edge e2 = aTwin[netArc];
                            if (e2) 
                            {
                                upB[e2] = 2;
                                lowB[e2] = 0;
                            }

                        }
                        break;
                case 180:
                        if (maxBound)
                        {
                            lowB[netArc] = 0;
                            upB[netArc] = 2;
                            edge e2 = aTwin[netArc];
                            if (e2) 
                            {
                                upB[e2] = lowB[e2] = 0;
                            }
                        }
                        else
                        {
                            upB[netArc] = 0; 
                            lowB[netArc] = 0;
                            edge e2 = aTwin[netArc];
                            if (e2) 
                            {
                                upB[e2] = 2;
                                lowB[e2] = 0;
                            }

                        }
                        break;
                OGDF_NODEFAULT
            }//switch       
        }//progressive

    }//setAngle
};


} // end namespace ogdf


#endif