Interface of hierarchy layout algorithms. More...

#include <ogdf/layered/HierarchyLayoutModule.h>

Inheritance diagram for ogdf::HierarchyLayoutModule:

Public Member Functions
	HierarchyLayoutModule ()
	Initializes a hierarchy layout module. More...

virtual	~HierarchyLayoutModule ()

void	call (const HierarchyLevelsBase &levels, GraphAttributes &GA)
	Computes a hierarchy layout of `levels` in `GA`. More...

Static Public Member Functions
static void	dynLayerDistance (GraphAttributes &AGC, HierarchyLevelsBase &levels)

Protected Member Functions
virtual void	doCall (const HierarchyLevelsBase &levels, GraphAttributes &AGC)=0
	Implements the actual algorithm call. More...

Static Protected Member Functions
static double	getHeight (const GraphAttributes &GA, const HierarchyLevelsBase &levels, node v)
	Returns the `GA` height of node `v` or 0 if it is a dummy node in the hierarchy of `levels`. More...

static double	getWidth (const GraphAttributes &GA, const HierarchyLevelsBase &levels, node v)
	Returns the `GA` width of node `v` or 0 if it is a dummy node in the hierarchy of `levels`. More...

Static Private Member Functions
static void	overlap (GraphAttributes &AGC, HierarchyLevelsBase &levels, node s, node t, int i, int &ci, int &cj)
	after calling, ci (cj) contains the number of nodes of level i (j=i-1) which overlap the edge (s,t) More...

Detailed Description

Interface of hierarchy layout algorithms.

See also: SugiyamaLayout

Definition at line 52 of file HierarchyLayoutModule.h.

Constructor & Destructor Documentation

◆ HierarchyLayoutModule()

ogdf::HierarchyLayoutModule::HierarchyLayoutModule ( )

inline

Initializes a hierarchy layout module.

Definition at line 55 of file HierarchyLayoutModule.h.

◆ ~HierarchyLayoutModule()

virtual ogdf::HierarchyLayoutModule::~HierarchyLayoutModule ( )

inlinevirtual

Definition at line 57 of file HierarchyLayoutModule.h.

Member Function Documentation

◆ call()

void ogdf::HierarchyLayoutModule::call	(	const HierarchyLevelsBase &	levels,
		GraphAttributes &	GA
	)

inline

Computes a hierarchy layout of levels in GA.

Parameters

levels	is the input hierarchy.
GA	is assigned the hierarchy layout.

Definition at line 64 of file HierarchyLayoutModule.h.

◆ doCall()

virtual void ogdf::HierarchyLayoutModule::doCall	(	const HierarchyLevelsBase &	levels,
		GraphAttributes &	AGC
	)

protectedpure virtual

Implements the actual algorithm call.

Must be implemented by derived classes.

Parameters

levels	is the input hierarchy.
AGC	has to be assigned the hierarchy layout.

Implemented in ogdf::OptimalHierarchyLayout, ogdf::FastSimpleHierarchyLayout, and ogdf::FastHierarchyLayout.

◆ dynLayerDistance()

static void ogdf::HierarchyLayoutModule::dynLayerDistance	(	GraphAttributes &	AGC,
		HierarchyLevelsBase &	levels
	)

static

◆ getHeight()

static double ogdf::HierarchyLayoutModule::getHeight	(	const GraphAttributes &	GA,
		const HierarchyLevelsBase &	levels,
		node	v
	)

inlinestaticprotected

Returns the GA height of node v or 0 if it is a dummy node in the hierarchy of levels.

Definition at line 130 of file HierarchyLayoutModule.h.

◆ getWidth()

static double ogdf::HierarchyLayoutModule::getWidth	(	const GraphAttributes &	GA,
		const HierarchyLevelsBase &	levels,
		node	v
	)

inlinestaticprotected

Returns the GA width of node v or 0 if it is a dummy node in the hierarchy of levels.

Definition at line 123 of file HierarchyLayoutModule.h.

◆ overlap()

static void ogdf::HierarchyLayoutModule::overlap	(	GraphAttributes &	AGC,
		HierarchyLevelsBase &	levels,
		node	s,
		node	t,
		int	i,
		int &	ci,
		int &	cj
	)

staticprivate

after calling, ci (cj) contains the number of nodes of level i (j=i-1) which overlap the edge (s,t)

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

include/ogdf/layered/HierarchyLayoutModule.h

OpenGraph DrawingFramework

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Static Private Member Functions