Open Graph Drawing Framework  v.2007.11

Overview Class Hierarchy Class Index Class List Members Namespaces Source Files Search for:

ogdf::ClusterPlanarizationLayout Class Reference

The cluster planarization layout algorithm. More...

#include <ClusterPlanarizationLayout.h>

List of all members.

Public Member Functions
	ClusterPlanarizationLayout ()
	Creates an instance of cluster planarization layout.
virtual	~ClusterPlanarizationLayout ()
virtual void	call (Graph &G, ClusterGraphAttributes &acGraph, ClusterGraph &cGraph, bool simpleCConnect=true)
	Calls cluster planarization layout with cluster-graph attributes acGraph.
double	pageRatio () const
	Returns the current page ratio (= desired width / height of layout).
void	pageRatio (double ratio)
	Sets the page ratio to ratio.
void	setPlanarLayouter (LayoutClusterPlanRepModule *pPlanarLayouter)
	Sets the module option for the planar layout algorithm to pPlanarLayouter.
void	setPacker (CCLayoutPackModule *pPacker)
	Sets the module option for the arrangement of connected components to pPacker.
Protected Member Functions
void	computeClusterPositions (ClusterPlanRep &CP, Layout drawing, HashArray< int, ClusterPosition > &CA)
Private Attributes
ModuleOption < LayoutClusterPlanRepModule >	m_planarLayouter
	The planar layouter.
ModuleOption< CCLayoutPackModule >	m_packer
	The packing algorithm.
double	m_pageRatio
	The page ratio.
int	m_nCrossings
	The number of crossings (not yet used!).
Classes
struct	ClusterPosition

---

Detailed Description

The cluster planarization layout algorithm.

The class ClusterPlanarizationLayout implements the planarization approach for drawing clustered graphs. Its implementation is based on the following publication:

Giuseppe Di Battista, Walter Didimo, A. Marcandalli: Planarization of Clustered Graphs. LNCS 2265 (Proc. Graph Drawing 2001), pp. 60-74.

Optional parameters

Option	Type	Default	Description
pageRatio	double	1.0	Specifies the desired ration of width / height of the computed layout. It is currently only used when packing connected components.

Module options

The algorithm provides the following module options:

Option	Type	Default	Description
planarLayouter	LayoutClusterPlanRepModule	ClusterOrthoLayout	The c-planar layout algorithm used to compute a c-planar layout of the c-planarized representation resulting from the crossing minimization step.
packer	CCLayoutPackModule	TileToRowsCCPacker	The packer module used for arranging connected components.

Definition at line 105 of file ClusterPlanarizationLayout.h.

---

Constructor & Destructor Documentation

ogdf::ClusterPlanarizationLayout::ClusterPlanarizationLayout

(

)

Creates an instance of cluster planarization layout.

virtual ogdf::ClusterPlanarizationLayout::~ClusterPlanarizationLayout

(

)

[inline, virtual]

Definition at line 112 of file ClusterPlanarizationLayout.h.

---

Member Function Documentation

virtual void ogdf::ClusterPlanarizationLayout::call	(	Graph &	G,
		ClusterGraphAttributes &	acGraph,
		ClusterGraph &	cGraph,
		bool	simpleCConnect = true
	)			[virtual]

Calls cluster planarization layout with cluster-graph attributes acGraph.

Parameters:

	G	is the input graph.
	acGraph	is assigned the computed layout.
	cGraph	is the input cluster graph.
	simpleCConnect

double ogdf::ClusterPlanarizationLayout::pageRatio

(

)

const [inline]

Returns the current page ratio (= desired width / height of layout).

Definition at line 130 of file ClusterPlanarizationLayout.h.

void ogdf::ClusterPlanarizationLayout::pageRatio

(

double

ratio

)

[inline]

Sets the page ratio to ratio.

Definition at line 135 of file ClusterPlanarizationLayout.h.

void ogdf::ClusterPlanarizationLayout::setPlanarLayouter

(

LayoutClusterPlanRepModule *

pPlanarLayouter

)

[inline]

Sets the module option for the planar layout algorithm to pPlanarLayouter.

Definition at line 140 of file ClusterPlanarizationLayout.h.

void ogdf::ClusterPlanarizationLayout::setPacker

(

CCLayoutPackModule *

pPacker

)

[inline]

Sets the module option for the arrangement of connected components to pPacker.

Definition at line 145 of file ClusterPlanarizationLayout.h.

void ogdf::ClusterPlanarizationLayout::computeClusterPositions	(	ClusterPlanRep &	CP,
		Layout	drawing,
		HashArray< int, ClusterPosition > &	CA
	)			[protected]

---

Member Data Documentation

ModuleOption<LayoutClusterPlanRepModule> ogdf::ClusterPlanarizationLayout::m_planarLayouter [private]

The planar layouter.

Definition at line 168 of file ClusterPlanarizationLayout.h.

ModuleOption<CCLayoutPackModule> ogdf::ClusterPlanarizationLayout::m_packer [private]

The packing algorithm.

Definition at line 169 of file ClusterPlanarizationLayout.h.

double ogdf::ClusterPlanarizationLayout::m_pageRatio [private]

The page ratio.

Definition at line 171 of file ClusterPlanarizationLayout.h.

int ogdf::ClusterPlanarizationLayout::m_nCrossings [private]

The number of crossings (not yet used!).

Definition at line 173 of file ClusterPlanarizationLayout.h.

---

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

• ogdf/cluster/ClusterPlanarizationLayout.h

---