Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::ClusterOrthoLayout Class Reference

Represents a planar orthogonal drawing algorithm for c-planar, c-connected clustered graphs. More...

#include <ogdf/cluster/ClusterOrthoLayout.h>

+ Inheritance diagram for ogdf::ClusterOrthoLayout:

Public Member Functions

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

Private Member Functions

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

Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from ogdf::LayoutClusterPlanRepModule
DPoint m_boundingBox
 Stores the bounding box of the computed layout. More...
 

Detailed Description

Represents a planar orthogonal drawing algorithm for c-planar, c-connected clustered graphs.

Definition at line 46 of file ClusterOrthoLayout.h.

Constructor & Destructor Documentation

◆ ClusterOrthoLayout()

ogdf::ClusterOrthoLayout::ClusterOrthoLayout ( )

Initializes an instance of class ClusterOrthoLayout.

Member Function Documentation

◆ align()

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

Sets alignment option.

Definition at line 134 of file ClusterOrthoLayout.h.

◆ call() [1/2]

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.

◆ call() [2/2]

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

Call method for non c-planar graphs.

Implements ogdf::LayoutClusterPlanRepModule.

◆ computeBoundingBox()

void ogdf::ClusterOrthoLayout::computeBoundingBox ( const ClusterPlanRep PG,
Layout drawing 
)
private

◆ costAssoc() [1/2]

int ogdf::ClusterOrthoLayout::costAssoc ( ) const
inline

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

Definition at line 113 of file ClusterOrthoLayout.h.

◆ costAssoc() [2/2]

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

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

Definition at line 117 of file ClusterOrthoLayout.h.

◆ costGen() [1/2]

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

Returns cost of generalizations.

Definition at line 122 of file ClusterOrthoLayout.h.

◆ costGen() [2/2]

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

Sets cost of generalizations.

Definition at line 126 of file ClusterOrthoLayout.h.

◆ cOverhang() [1/2]

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

Returns cOverhang, where cOverhang * separation defines the minimum.

Definition at line 84 of file ClusterOrthoLayout.h.

◆ cOverhang() [2/2]

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

Sets cOverhang value.

Definition at line 88 of file ClusterOrthoLayout.h.

◆ margin() [1/2]

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

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

Definition at line 94 of file ClusterOrthoLayout.h.

◆ margin() [2/2]

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

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

Definition at line 98 of file ClusterOrthoLayout.h.

◆ optionProfile()

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

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

Definition at line 131 of file ClusterOrthoLayout.h.

◆ preferedDir() [1/2]

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

Returns the preferred direction of generalizations.

Definition at line 104 of file ClusterOrthoLayout.h.

◆ preferedDir() [2/2]

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

Sets the preferred direction of generalizations.

Definition at line 108 of file ClusterOrthoLayout.h.

◆ scaling()

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

Sets scaling option for compaction step.

Definition at line 137 of file ClusterOrthoLayout.h.

◆ separation() [1/2]

virtual double ogdf::ClusterOrthoLayout::separation ( ) const
inlineoverridevirtual

Returns the minimum distance between edges and vertices.

Implements ogdf::LayoutClusterPlanRepModule.

Definition at line 74 of file ClusterOrthoLayout.h.

◆ separation() [2/2]

virtual void ogdf::ClusterOrthoLayout::separation ( double  sep)
inlineoverridevirtual

Sets the minimum distance between edges and vertices.

Implements ogdf::LayoutClusterPlanRepModule.

Definition at line 78 of file ClusterOrthoLayout.h.

◆ setOptions()

virtual void ogdf::ClusterOrthoLayout::setOptions ( int  optionField)
inlineoverridevirtual

Sets generic options by setting field bits.

Reimplemented from ogdf::LayoutClusterPlanRepModule.

Definition at line 145 of file ClusterOrthoLayout.h.

Member Data Documentation

◆ m_align

bool ogdf::ClusterOrthoLayout::m_align
private

Horizontal alignment option.

Definition at line 168 of file ClusterOrthoLayout.h.

◆ m_costAssoc

int ogdf::ClusterOrthoLayout::m_costAssoc
private

Compaction cost of association type edges.

Definition at line 165 of file ClusterOrthoLayout.h.

◆ m_costGen

int ogdf::ClusterOrthoLayout::m_costGen
private

Compaction cost of generalizations type edges.

Definition at line 166 of file ClusterOrthoLayout.h.

◆ m_cOverhang

double ogdf::ClusterOrthoLayout::m_cOverhang
private

Factor for minimum distance between vertex corner an adjacent edges.

Definition at line 161 of file ClusterOrthoLayout.h.

◆ m_margin

double ogdf::ClusterOrthoLayout::m_margin
private

Distance between bounding box and drawing boundary.

Definition at line 162 of file ClusterOrthoLayout.h.

◆ m_optionProfile

int ogdf::ClusterOrthoLayout::m_optionProfile
private

Definition at line 164 of file ClusterOrthoLayout.h.

◆ m_orthoStyle

int ogdf::ClusterOrthoLayout::m_orthoStyle
private

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

Definition at line 172 of file ClusterOrthoLayout.h.

◆ m_preferedDir

OrthoDir ogdf::ClusterOrthoLayout::m_preferedDir
private

Preferred direction of generalizations (obsolete).

Definition at line 163 of file ClusterOrthoLayout.h.

◆ m_scalingSteps

int ogdf::ClusterOrthoLayout::m_scalingSteps
private

Number of scaling steps during compaction.

Definition at line 171 of file ClusterOrthoLayout.h.

◆ m_separation

double ogdf::ClusterOrthoLayout::m_separation
private

Minimum distance between edges and vertices.

Definition at line 160 of file ClusterOrthoLayout.h.

◆ m_useScalingCompaction

bool ogdf::ClusterOrthoLayout::m_useScalingCompaction
private

Switches scaling improvement during compaction.

Definition at line 170 of file ClusterOrthoLayout.h.


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