DavidsonHarelLayout.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_DAVIDSON_HAREL_LAYOUT_H
#define OGDF_DAVIDSON_HAREL_LAYOUT_H


#include <ogdf/module/LayoutModule.h>
#include <ogdf/energybased/DavidsonHarel.h>


namespace ogdf {



class OGDF_EXPORT DavidsonHarelLayout : public LayoutModule
{
public:
    enum SettingsParameter {spStandard, spRepulse, spPlanar}; //tuning of costs

    enum SpeedParameter {sppFast, sppMedium, sppHQ};

    DavidsonHarelLayout();

    ~DavidsonHarelLayout(){}

    void call(GraphAttributes &GA);

    void fixSettings(SettingsParameter sp);


    void setSpeed(SpeedParameter sp);


    void setPreferredEdgeLengthMultiplier(double multi) {m_multiplier = multi;}
    
    void setPreferredEdgeLength(double elen) {m_prefEdgeLength = elen;}

    void setRepulsionWeight(double w);

    double getRepulsionWeight() const {return m_repulsionWeight;}

    void setAttractionWeight(double);

    double getAttractionWeight() const {return m_attractionWeight;}

    void setNodeOverlapWeight(double);

    double getNodeOverlapWeight() const {return m_nodeOverlapWeight;}

    void setPlanarityWeight(double);

    double getPlanarityWeight() const {return m_planarityWeight;}

    void setStartTemperature(int t);

    int getStartTemperature() const {return m_startTemperature;}

    void setNumberOfIterations(int steps);

    int getNumberOfIterations() const {return m_numberOfIterations;}
    
    void setIterationNumberAsFactor(bool b) {m_itAsFactor = b;} 

private:
    double m_repulsionWeight;   
    double m_attractionWeight;  
    double m_nodeOverlapWeight; 
    double m_planarityWeight;   
    int m_startTemperature;     
    int m_numberOfIterations;   
    SpeedParameter m_speed;     
    double m_multiplier;        
    double m_prefEdgeLength;    
    bool m_crossings;           
    bool m_itAsFactor;          
};

}
#endif