Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::LinearLayout Class Reference

Layout the graph with nodes next to each other with natural or custom order and draw the edges as semicircular bows above them. More...

#include <ogdf/misclayout/LinearLayout.h>

+ Inheritance diagram for ogdf::LinearLayout:

Public Member Functions

 LinearLayout ()
 Constructor that uses a standard width and no custom order of the nodes. More...
 
 LinearLayout (double w, ListPure< node > o)
 Constructor that takes a desired width and a custom ordering. More...
 
virtual ~LinearLayout ()
 Standard destructor. More...
 
virtual void call (GraphAttributes &GA) override
 Computes a layout of graph GA. More...
 
virtual void setCustomOrder (bool o)
 Interface function to toggle custom ordering. More...
 
- Public Member Functions inherited from ogdf::LayoutModule
 LayoutModule ()
 Initializes a layout module. More...
 
virtual ~LayoutModule ()
 
void operator() (GraphAttributes &GA)
 Computes a layout of graph GA. More...
 

Private Attributes

bool m_customOrder
 If true a custom order stored in m_nodeOrder will be used. More...
 
ListPure< nodem_nodeOrder
 Contains a custom ordering for putting the graphs next to each other. More...
 
double m_outWidth
 

Detailed Description

Layout the graph with nodes next to each other with natural or custom order and draw the edges as semicircular bows above them.

Definition at line 52 of file LinearLayout.h.

Constructor & Destructor Documentation

◆ LinearLayout() [1/2]

ogdf::LinearLayout::LinearLayout ( double  w,
ListPure< node o 
)

Constructor that takes a desired width and a custom ordering.

Parameters
wWidth of the output
ocustom order

◆ LinearLayout() [2/2]

ogdf::LinearLayout::LinearLayout ( )

Constructor that uses a standard width and no custom order of the nodes.

◆ ~LinearLayout()

virtual ogdf::LinearLayout::~LinearLayout ( )
virtual

Standard destructor.

Member Function Documentation

◆ call()

virtual void ogdf::LinearLayout::call ( GraphAttributes GA)
overridevirtual

Computes a layout of graph GA.

This method is the actual algorithm call and must be implemented by derived classes.

Parameters
GAis the input graph and will also be assigned the layout information.

Implements ogdf::LayoutModule.

◆ setCustomOrder()

virtual void ogdf::LinearLayout::setCustomOrder ( bool  o)
virtual

Interface function to toggle custom ordering.

Member Data Documentation

◆ m_customOrder

bool ogdf::LinearLayout::m_customOrder
private

If true a custom order stored in m_nodeOrder will be used.

Definition at line 55 of file LinearLayout.h.

◆ m_nodeOrder

ListPure<node> ogdf::LinearLayout::m_nodeOrder
private

Contains a custom ordering for putting the graphs next to each other.

Definition at line 58 of file LinearLayout.h.

◆ m_outWidth

double ogdf::LinearLayout::m_outWidth
private

Definition at line 59 of file LinearLayout.h.


The documentation for this class was generated from the following file: