ScalingLayout.h

Go to the documentation of this file.

 
#pragma once
 
#include <ogdf/basic/basic.h>
#include <ogdf/energybased/multilevel_mixer/MultilevelLayoutModule.h>
 
#include <memory>
 
namespace ogdf {
class GraphAttributes;
class LayoutModule;
class ModularMultilevelMixer;
class MultilevelGraph;
 
 
class OGDF_EXPORT ScalingLayout : public MultilevelLayoutModule {
public:
    enum class ScalingType {
        RelativeToDrawing,
        RelativeToAvgLength,
        RelativeToDesiredLength,
        Absolute
    };
 
    ScalingLayout();
 
    using MultilevelLayoutModule::call;
 
    virtual void call(GraphAttributes& GA) override;
 
    virtual void call(MultilevelGraph& MLG) override;
 
    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.
    std::unique_ptr<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;
};
 
}