TreeLayout.h

Go to the documentation of this file.

 
#pragma once
 
#include <ogdf/basic/Graph.h>
#include <ogdf/basic/LayoutModule.h>
#include <ogdf/basic/basic.h>
 
namespace ogdf {
class GraphAttributes;
enum class Orientation;
template<class E>
class SListPure;
 
class OGDF_EXPORT TreeLayout : public LayoutModule {
public:
    enum class RootSelectionType {
        Source, 
        Sink, 
        ByCoord 
    };
 
private:
    double m_siblingDistance; 
    double m_subtreeDistance; 
    double m_levelDistance; 
    double m_treeDistance; 
 
    bool m_orthogonalLayout; 
    Orientation m_orientation; 
    RootSelectionType m_selectRoot; 
 
public:
    TreeLayout();
 
    TreeLayout(const TreeLayout& tl);
 
    ~TreeLayout() = default;
 
    virtual void call(GraphAttributes& GA) override;
 
    void callSortByPositions(GraphAttributes& GA, Graph& G);
 
    double siblingDistance() const { return m_siblingDistance; }
 
    void siblingDistance(double x) { m_siblingDistance = x; }
 
    double subtreeDistance() const { return m_subtreeDistance; }
 
    void subtreeDistance(double x) { m_subtreeDistance = x; }
 
    double levelDistance() const { return m_levelDistance; }
 
    void levelDistance(double x) { m_levelDistance = x; }
 
    double treeDistance() const { return m_treeDistance; }
 
    void treeDistance(double x) { m_treeDistance = x; }
 
    bool orthogonalLayout() const { return m_orthogonalLayout; }
 
    void orthogonalLayout(bool b) { m_orthogonalLayout = b; }
 
    Orientation orientation() const { return m_orientation; }
 
    void orientation(Orientation orientation) { m_orientation = orientation; }
 
    RootSelectionType rootSelection() const { return m_selectRoot; }
 
    void rootSelection(RootSelectionType rootSelection) { m_selectRoot = rootSelection; }
 
    TreeLayout& operator=(const TreeLayout& tl);
 
 
private:
    class AdjComparer;
    struct TreeStructure;
 
    void adjustEdgeDirections(Graph& G, SListPure<edge>& reversedEdges, node v, node parent);
    void setRoot(GraphAttributes& AG, Graph& tree, SListPure<edge>& reversedEdges);
    void undoReverseEdges(GraphAttributes& AG, Graph& tree, SListPure<edge>& reversedEdges);
 
    // recursive bottom up traversal of the tree for computing
    // preliminary x-coordinates
    void firstWalk(TreeStructure& ts, node subtree, bool upDown);
 
    // space out the small subtrees on the left hand side of subtree
    // defaultAncestor is used for all nodes with obsolete m_ancestor
    void apportion(TreeStructure& ts, node subtree, node& defaultAncestor, bool upDown);
 
    // recursive top down traversal of the tree for computing final
    // x-coordinates
    void secondWalkX(TreeStructure& ts, node subtree, double modifierSum);
    void secondWalkY(TreeStructure& ts, node subtree, double modifierSum);
 
    // compute y-coordinates and edge shapes
    void computeYCoordinatesAndEdgeShapes(node root, GraphAttributes& AG);
    void computeXCoordinatesAndEdgeShapes(node root, GraphAttributes& AG);
 
    void findMinX(GraphAttributes& AG, node root, double& minX);
    void findMinY(GraphAttributes& AG, node root, double& minY);
    void findMaxX(GraphAttributes& AG, node root, double& maxX);
    void findMaxY(GraphAttributes& AG, node root, double& maxY);
    void shiftTreeX(GraphAttributes& AG, node root, double shift);
    void shiftTreeY(GraphAttributes& AG, node root, double shift);
};
 
}