SpringEmbedderFR.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_SPRING_EMBEDDER_FR_H
#define OGDF_SPRING_EMBEDDER_FR_H


#include <ogdf/module/LayoutModule.h>
#include <ogdf/basic/Array2D.h>


namespace ogdf {


    class OGDF_EXPORT GraphCopyAttributes;
    class OGDF_EXPORT GraphCopy;



class OGDF_EXPORT SpringEmbedderFR : public LayoutModule
{
public:
    enum Scaling {
        scInput,           
        scUserBoundingBox, 
        scScaleFunction    
    };


    SpringEmbedderFR();

    // destructor
    ~SpringEmbedderFR() { }


    void call(GraphAttributes &GA);


    int iterations() const {
        return m_iterations;
    }

    void iterations(int i) {
        if (i>0)
            m_iterations = i;
    }

    double fineness() const {
        return m_fineness;
    }

    void fineness(double f) {
        m_fineness = f;
    }

    bool noise() const {
        return m_noise;
    }

    void noise(bool on) {
        m_noise = on;
    }
    
    double minDistCC() const { return m_minDistCC; }

    void minDistCC(double x) { m_minDistCC = x; }

    double pageRatio() { return m_pageRatio; }

    void pageRatio(double x) { m_pageRatio = x; }

    Scaling scaling() const {
        return m_scaling;
    }

    void scaling(Scaling sc) {
        m_scaling = sc;
    }

    double scaleFunctionFactor() const {
        return m_scaleFactor;
    }

    void scaleFunctionFactor(double f) {
        m_scaleFactor = f;
    }

    void userBoundingBox(double xmin, double ymin, double xmax, double ymax) {
        m_bbXmin = xmin;
        m_bbYmin = ymin;
        m_bbXmax = xmax;
        m_bbYmax = ymax;
    }

private:
    bool initialize(GraphCopy &G, GraphCopyAttributes &AG);

    void mainStep(GraphCopy &G, GraphCopyAttributes &AG);
    void cleanup() {
        delete m_A;
        m_A = 0;
    }
    
    NodeArray<ListIterator<node> > m_lit; 

    int m_cF;
    
    double m_width;
    double m_height; 

    double m_txNull;
    double m_tyNull;
    double m_tx;
    double m_ty;

    double m_k;
    double m_k2;
    double m_kk;
    int m_ki;
    
    int m_xA;
    int m_yA;

    Array2D<List<node> > *m_A;


    double mylog2(int x) {
        double l = 0.0;
        while(x > 0) {
            l++;
            x >>= 1;
        }
        return l/2;
    }

    int    m_iterations;  
    double m_fineness;    
    double m_edgeLength;

    double m_xleft;       
    double m_xright;      
    double m_ysmall;      
    double m_ybig;        

    bool m_noise;         

    Scaling m_scaling;    
    double m_scaleFactor; 
    
    double m_bbXmin; 
    double m_bbYmin; 
    double m_bbXmax; 
    double m_bbYmax; 

    double m_minDistCC; 
    double m_pageRatio; 
};


} // end namespace ogdf


#endif