ogdf::LayoutClusterPlanRepModule Class Reference

Interface for planar cluster layout algorithms. More...

#include <ogdf/cluster/LayoutClusterPlanRepModule.h>

Inheritance diagram for ogdf::LayoutClusterPlanRepModule:

Public Member Functions
	LayoutClusterPlanRepModule ()
	Initializes a cluster planar layout module.
virtual	~LayoutClusterPlanRepModule ()
virtual void	call (ClusterPlanRep &PG, adjEntry adjExternal, Layout &drawing, List< edge > &origEdges, Graph &originalGraph)=0
	Computes a layout of PG in drawing.
const DPoint &	getBoundingBox () const
	Returns the bounding box of the computed layout.
virtual int	getOptions ()
	Returns the (generic) options.
virtual double	separation () const =0
	Returns the minimal allowed distance between edges and vertices.
virtual void	separation (double sep)=0
	Sets the minimal allowed distance between edges and vertices to sep.
virtual void	setOptions (int)
	Sets the (generic) options; derived classes have to cope with the interpretation)

Protected Attributes
DPoint	m_boundingBox
	Stores the bounding box of the computed layout.

Detailed Description

Interface for planar cluster layout algorithms.

Warning

This interface is likely to change in future releases.

See also

ClusterPlanarizationLayout

Definition at line 52 of file LayoutClusterPlanRepModule.h.

Constructor & Destructor Documentation

LayoutClusterPlanRepModule()

ogdf::LayoutClusterPlanRepModule::LayoutClusterPlanRepModule ( )

inline

Initializes a cluster planar layout module.

Definition at line 55 of file LayoutClusterPlanRepModule.h.

~LayoutClusterPlanRepModule()

virtual ogdf::LayoutClusterPlanRepModule::~LayoutClusterPlanRepModule ( )

inlinevirtual

Definition at line 57 of file LayoutClusterPlanRepModule.h.

Member Function Documentation

call()

virtual void ogdf::LayoutClusterPlanRepModule::call ( ClusterPlanRep &  PG, adjEntry  adjExternal, Layout &  drawing, List< edge > &  origEdges, Graph &  originalGraph  )

pure virtual

Computes a layout of PG in drawing.

Must be overridden by derived classes.

Parameters

PG	is the input cluster planarized representation which may be modified.
adjExternal	is an adjacenty entry on the external face.
drawing	is the computed layout of PG.
origEdges	are edges in the original graph.
originalGraph	must be the original graph of PG.

Implemented in ogdf::ClusterOrthoLayout.

getBoundingBox()

const DPoint & ogdf::LayoutClusterPlanRepModule::getBoundingBox ( ) const

inline

Returns the bounding box of the computed layout.

Definition at line 72 of file LayoutClusterPlanRepModule.h.

getOptions()

virtual int ogdf::LayoutClusterPlanRepModule::getOptions ( )

inlinevirtual

Returns the (generic) options.

Definition at line 80 of file LayoutClusterPlanRepModule.h.

separation() [1/2]

virtual double ogdf::LayoutClusterPlanRepModule::separation ( ) const

pure virtual

Returns the minimal allowed distance between edges and vertices.

Implemented in ogdf::ClusterOrthoLayout.

separation() [2/2]

virtual void ogdf::LayoutClusterPlanRepModule::separation ( double  sep )

pure virtual

Sets the minimal allowed distance between edges and vertices to sep.

Implemented in ogdf::ClusterOrthoLayout.

setOptions()

virtual void ogdf::LayoutClusterPlanRepModule::setOptions ( int  )

inlinevirtual

Sets the (generic) options; derived classes have to cope with the interpretation)

Reimplemented in ogdf::ClusterOrthoLayout.

Definition at line 75 of file LayoutClusterPlanRepModule.h.

Member Data Documentation

m_boundingBox

DPoint ogdf::LayoutClusterPlanRepModule::m_boundingBox

protected

Stores the bounding box of the computed layout.

Must be set by derived algorithms!

Definition at line 95 of file LayoutClusterPlanRepModule.h.

---

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

• include/ogdf/cluster/LayoutClusterPlanRepModule.h