Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions | Private Member Functions | Private Attributes

ogdf::ClusterOrthoLayout Class Reference

#include <ogdf/cluster/ClusterOrthoLayout.h>

Inheritance diagram for ogdf::ClusterOrthoLayout:
ogdf::LayoutClusterPlanRepModule

List of all members.

Public Member Functions

 ClusterOrthoLayout ()
 Initializes an instance of class ClusterOrthoLayout.
void call (ClusterPlanRep &PG, adjEntry adjExternal, Layout &drawing)
 Calls planar UML layout algorithm.
void call (ClusterPlanRep &PG, adjEntry adjExternal, Layout &drawing, List< NodePair > &npEdges, List< edge > &newEdges, Graph &originalGraph)
 Call method for non c-planar graphs.
double separation () const
 Returns the minimum distance between edges and vertices.
void separation (double sep)
 Sets the minimum distance between edges and vertices.
double cOverhang () const
 Returns cOverhang, where cOverhang * separation defines the minimum.
void cOverhang (double c)
 Sets cOverhang value.
double margin () const
 Returns the distance from the tight bounding box to the boundary of the drawing.
void margin (double m)
 Sets the distance from the tight bounding box to the boundary of the drawing.
OrthoDir preferedDir () const
 Returns the preferred direction of generalizations.
void preferedDir (OrthoDir dir)
 Sets the preferred direction of generalizations.
int costAssoc () const
 Returns cost of associations which is used in the compactions step.
void costAssoc (int c)
 Sets cost of associations which is used in the compactions step.
int costGen () const
 Returns cost of generalizations.
void costGen (int c)
 Sets cost of generalizations.
void optionProfile (int i)
 Sets the option profile, thereby fixing a set of drawing options.
void align (bool b)
 Sets alignment option.
void scaling (bool b)
 Sets scaling option for compaction step.
virtual void setOptions (int optionField)
 Sets generic options by setting field bits.

Private Member Functions

void computeBoundingBox (const ClusterPlanRep &PG, Layout &drawing)

Private Attributes

double m_separation
 Minimum distance between edges and vertices.
double m_cOverhang
 Factor for minimum distance between vertex corner an adjacent edges.
double m_margin
 Distance between bounding box and drawing boundary.
OrthoDir m_preferedDir
 Preferred direction of generalizations (obsolete).
int m_optionProfile
int m_costAssoc
 Compaction cost of association type edges.
int m_costGen
 Compaction cost of generalizations type edges.
bool m_align
 Horizontal alignment option.
bool m_useScalingCompaction
 Switches scaling improvement during compaction.
int m_scalingSteps
 Number of scaling steps during compaction.
int m_orthoStyle
 Type of style (traditional/progressive) used for shape step.

Detailed Description

Definition at line 76 of file ClusterOrthoLayout.h.


Constructor & Destructor Documentation

ogdf::ClusterOrthoLayout::ClusterOrthoLayout (  ) 

Initializes an instance of class ClusterOrthoLayout.


Member Function Documentation

void ogdf::ClusterOrthoLayout::align ( bool  b  )  [inline]

Sets alignment option.

Definition at line 164 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::call ( ClusterPlanRep PG,
adjEntry  adjExternal,
Layout drawing 
)

Calls planar UML layout algorithm.

Input is a planarized representation PG of a connected component of the graph, output is a layout of the (modified) planarized representation in drawing.

void ogdf::ClusterOrthoLayout::call ( ClusterPlanRep PG,
adjEntry  adjExternal,
Layout drawing,
List< NodePair > &  npEdges,
List< edge > &  newEdges,
Graph originalGraph 
) [virtual]

Call method for non c-planar graphs.

Implements ogdf::LayoutClusterPlanRepModule.

void ogdf::ClusterOrthoLayout::computeBoundingBox ( const ClusterPlanRep PG,
Layout drawing 
) [private]
int ogdf::ClusterOrthoLayout::costAssoc (  )  const [inline]

Returns cost of associations which is used in the compactions step.

Definition at line 143 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::costAssoc ( int  c  )  [inline]

Sets cost of associations which is used in the compactions step.

Definition at line 147 of file ClusterOrthoLayout.h.

int ogdf::ClusterOrthoLayout::costGen (  )  const [inline]

Returns cost of generalizations.

Definition at line 152 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::costGen ( int  c  )  [inline]

Sets cost of generalizations.

Definition at line 156 of file ClusterOrthoLayout.h.

double ogdf::ClusterOrthoLayout::cOverhang (  )  const [inline]

Returns cOverhang, where cOverhang * separation defines the minimum.

Definition at line 114 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::cOverhang ( double  c  )  [inline]

Sets cOverhang value.

Definition at line 118 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::margin ( double  m  )  [inline]

Sets the distance from the tight bounding box to the boundary of the drawing.

Definition at line 128 of file ClusterOrthoLayout.h.

double ogdf::ClusterOrthoLayout::margin (  )  const [inline]

Returns the distance from the tight bounding box to the boundary of the drawing.

Definition at line 124 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::optionProfile ( int  i  )  [inline]

Sets the option profile, thereby fixing a set of drawing options.

Definition at line 161 of file ClusterOrthoLayout.h.

OrthoDir ogdf::ClusterOrthoLayout::preferedDir (  )  const [inline]

Returns the preferred direction of generalizations.

Definition at line 134 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::preferedDir ( OrthoDir  dir  )  [inline]

Sets the preferred direction of generalizations.

Definition at line 138 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::scaling ( bool  b  )  [inline]

Sets scaling option for compaction step.

Definition at line 167 of file ClusterOrthoLayout.h.

double ogdf::ClusterOrthoLayout::separation (  )  const [inline, virtual]

Returns the minimum distance between edges and vertices.

Implements ogdf::LayoutClusterPlanRepModule.

Definition at line 104 of file ClusterOrthoLayout.h.

void ogdf::ClusterOrthoLayout::separation ( double  sep  )  [inline, virtual]

Sets the minimum distance between edges and vertices.

Implements ogdf::LayoutClusterPlanRepModule.

Definition at line 108 of file ClusterOrthoLayout.h.

virtual void ogdf::ClusterOrthoLayout::setOptions ( int  optionField  )  [inline, virtual]

Sets generic options by setting field bits.

Reimplemented from ogdf::LayoutClusterPlanRepModule.

Definition at line 175 of file ClusterOrthoLayout.h.


Member Data Documentation

Horizontal alignment option.

Definition at line 201 of file ClusterOrthoLayout.h.

Compaction cost of association type edges.

Definition at line 198 of file ClusterOrthoLayout.h.

Compaction cost of generalizations type edges.

Definition at line 199 of file ClusterOrthoLayout.h.

Factor for minimum distance between vertex corner an adjacent edges.

Definition at line 194 of file ClusterOrthoLayout.h.

Distance between bounding box and drawing boundary.

Definition at line 195 of file ClusterOrthoLayout.h.

Definition at line 197 of file ClusterOrthoLayout.h.

Type of style (traditional/progressive) used for shape step.

Definition at line 205 of file ClusterOrthoLayout.h.

Preferred direction of generalizations (obsolete).

Definition at line 196 of file ClusterOrthoLayout.h.

Number of scaling steps during compaction.

Definition at line 204 of file ClusterOrthoLayout.h.

Minimum distance between edges and vertices.

Definition at line 193 of file ClusterOrthoLayout.h.

Switches scaling improvement during compaction.

Definition at line 203 of file ClusterOrthoLayout.h.


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