ScalingLayout.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_SCALING_LAYOUT_H
#define OGDF_SCALING_LAYOUT_H

#include <ogdf/basic/ModuleOption.h>
#include <ogdf/module/MultilevelLayoutModule.h>
#include <ogdf/energybased/multilevelmixer/ModularMultilevelMixer.h>
#include <ogdf/internal/energybased/MultilevelGraph.h>


namespace ogdf {

class OGDF_EXPORT ScalingLayout : public MultilevelLayoutModule
{
public:
    enum ScalingType {
        st_relativeToDrawing,      
        st_relativeToAvgLength, 
        st_relativeToDesiredLength, 
        st_absolute
    };

    ScalingLayout();

    void call(GraphAttributes &GA);
    
    void call(MultilevelGraph &MLG);

    void setScaling(double min, double max);
    
    void setExtraScalingSteps(unsigned int steps);
    
    void setSecondaryLayout(LayoutModule* layout);
    
    void setMMM(ModularMultilevelMixer* mmm);
    
    void setScalingType(ScalingType type);
    
    void setLayoutRepeats(unsigned int repeats);
    //TODO: only a workaround, this should be retrieved from the layout module
    //when we have a interface class on top of Layoutmodule that allows this
    void setDesiredEdgeLength(double eLength);

private:

    // Usually a simple force-directed / energy-based Layout should be chosen.
    ModuleOption<LayoutModule> m_secondaryLayoutModule;

    double m_minScaling;
    double m_maxScaling; 
    ModularMultilevelMixer* m_mmm;
    double m_desEdgeLength;

    // 0 = scale to maxScaling only
    unsigned int m_extraScalingSteps;

    unsigned int m_layoutRepeats;

    ScalingType m_scalingType;
};

} // namespace ogdf

#endif