UpwardPlanarizationLayout.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_UPWARD_PLANARIZATION_LAYOUT_H
#define OGDF_UPWARD_PLANARIZATION_LAYOUT_H



#include <ogdf/module/LayoutModule.h>
#include <ogdf/module/HierarchyLayoutModule.h>
#include <ogdf/module/UpwardPlanarizerModule.h>
#include <ogdf/module/UPRLayoutModule.h>
#include <ogdf/basic/ModuleOption.h>
#include <ogdf/upward/UpwardPlanRep.h>
#include <ogdf/upward/LayerBasedUPRLayout.h>
#include <ogdf/upward/SubgraphUpwardPlanarizer.h>



namespace ogdf {



class OGDF_EXPORT UpwardPlanarizationLayout : public LayoutModule
{
public:

    // constructor: sets options to default values
    UpwardPlanarizationLayout()
    {
        m_cr_nr = 0;
        // set default module
        m_layout.set(new LayerBasedUPRLayout()); 
        m_UpwardPlanarizer.set(new SubgraphUpwardPlanarizer());             
    };

    // destructor
    ~UpwardPlanarizationLayout() { }


    // calls the algorithm for attributed graph AG
    // returns layout information in AG
    void call(GraphAttributes &AG)
    {           
        UpwardPlanRep UPR;
        UPR.createEmpty(AG.constGraph());       
        m_UpwardPlanarizer.get().call(UPR);
        m_layout.get().call(UPR, AG);
        m_cr_nr = UPR.numberOfCrossings();      
        m_numLevels = m_layout.get().numberOfLevels;
    }


    // module option for the computation of the final layout
    void setUPRLayout(UPRLayoutModule *pLayout) {
        m_layout.set(pLayout);
    }
    

    void setUpwardPlanarizer(UpwardPlanarizerModule *pUpwardPlanarizer) {
        m_UpwardPlanarizer.set(pUpwardPlanarizer);
    }

    // returns the number of crossings in the layout after the algorithm
    // has been applied
    int numberOfCrossings() const { return m_cr_nr; }
    
    int numberOfLevels() const {return m_numLevels;};
    
protected:
    
    int m_cr_nr;

    int m_numLevels;
    
    ModuleOption<UpwardPlanarizerModule> m_UpwardPlanarizer;

    ModuleOption<UPRLayoutModule> m_layout; 
};


}

#endif