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

Private Attributes
bool	m_customOrder
	If true a custom order stored in m_nodeOrder will be used.
ListPure< node >	m_nodeOrder
	Contains a custom ordering for putting the graphs next to each other.
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 54 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

w	Width of the output
o	custom 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

GA	is 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 57 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 60 of file LinearLayout.h.

m_outWidth

double ogdf::LinearLayout::m_outWidth

private

Definition at line 61 of file LinearLayout.h.

---

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

• include/ogdf/misclayout/LinearLayout.h