Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::OrthoLayoutUML Class Reference

Represents planar orthogonal drawing algorithm for mixed-upward planar embedded graphs (UML-diagrams) More...

#include <ogdf/uml/OrthoLayoutUML.h>

+ Inheritance diagram for ogdf::OrthoLayoutUML:

Public Member Functions

 OrthoLayoutUML ()
 
void align (bool b)
 Set alignment option. More...
 
virtual void call (PlanRepUML &PG, adjEntry adjExternal, Layout &drawing) override
 Computes a planar layout of PG in drawing. More...
 
int costAssoc () const
 
void costAssoc (int c)
 
int costGen () const
 
void costGen (int c)
 
double cOverhang () const
 
void cOverhang (double c)
 
virtual int getOptions () override
 Returns the (generic) options. More...
 
double margin () const
 
void margin (double m)
 
void optionProfile (int i)
 Set the option profile, thereby fixing a set of drawing options. More...
 
OrthoDir preferedDir () const
 
void preferedDir (OrthoDir dir)
 
void scaling (bool b)
 Set scaling compaction. More...
 
virtual double separation () const override
 Returns the minimal allowed distance between edges and vertices. More...
 
virtual void separation (double sep) override
 Sets the minimal allowed distance between edges and vertices to sep. More...
 
void setBendBound (int i)
 Set bound on the number of bends. More...
 
virtual void setOptions (int optionField) override
 Sets the (generic) options; derived classes have to cope with the interpretation) More...
 
- Public Member Functions inherited from ogdf::LayoutPlanRepUMLModule
 LayoutPlanRepUMLModule ()
 Initializes a UML planar layout module. More...
 
virtual ~LayoutPlanRepUMLModule ()
 
const DPointgetBoundingBox () const
 Returns the bounding box of the computed layout. More...
 
void operator() (PlanRepUML &PG, adjEntry adjExternal, Layout &drawing)
 Computes a planar layout of PG in drawing. More...
 

Protected Member Functions

void classifyEdges (PlanRepUML &PG, adjEntry &adjExternal)
 
- Protected Member Functions inherited from ogdf::LayoutPlanRepUMLModule
void setBoundingBox (PlanRep &PG, Layout &drawing)
 Computes and sets the bounding box variable m_boundingBox. More...
 

Private Member Functions

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

Private Attributes

bool m_align
 
int m_bendBound
 bounds number of bends per edge in ortho shaper More...
 
int m_costAssoc
 
int m_costGen
 
double m_cOverhang
 
double m_margin
 
int m_optionProfile
 
int m_orthoStyle
 
OrthoDir m_preferedDir
 
int m_scalingSteps
 
double m_separation
 
bool m_useScalingCompaction
 

Additional Inherited Members

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

Detailed Description

Represents planar orthogonal drawing algorithm for mixed-upward planar embedded graphs (UML-diagrams)

Definition at line 43 of file OrthoLayoutUML.h.

Constructor & Destructor Documentation

◆ OrthoLayoutUML()

ogdf::OrthoLayoutUML::OrthoLayoutUML ( )

Member Function Documentation

◆ align()

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

Set alignment option.

Definition at line 119 of file OrthoLayoutUML.h.

◆ call()

virtual void ogdf::OrthoLayoutUML::call ( PlanRepUML PG,
adjEntry  adjExternal,
Layout drawing 
)
overridevirtual

Computes a planar layout of PG in drawing.

Must be overridden by derived classes.

Parameters
PGis the input planarized representation which may be modified.
adjExternalis an adjacenty entry on the external face.
drawingis the computed layout of PG.

Implements ogdf::LayoutPlanRepUMLModule.

◆ classifyEdges()

void ogdf::OrthoLayoutUML::classifyEdges ( PlanRepUML PG,
adjEntry adjExternal 
)
protected

◆ computeBoundingBox()

void ogdf::OrthoLayoutUML::computeBoundingBox ( const PlanRepUML PG,
Layout drawing 
)
private

◆ costAssoc() [1/2]

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

Definition at line 98 of file OrthoLayoutUML.h.

◆ costAssoc() [2/2]

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

Definition at line 102 of file OrthoLayoutUML.h.

◆ costGen() [1/2]

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

Definition at line 107 of file OrthoLayoutUML.h.

◆ costGen() [2/2]

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

Definition at line 111 of file OrthoLayoutUML.h.

◆ cOverhang() [1/2]

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

Definition at line 69 of file OrthoLayoutUML.h.

◆ cOverhang() [2/2]

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

Definition at line 73 of file OrthoLayoutUML.h.

◆ getOptions()

virtual int ogdf::OrthoLayoutUML::getOptions ( )
inlineoverridevirtual

Returns the (generic) options.

Reimplemented from ogdf::LayoutPlanRepUMLModule.

Definition at line 143 of file OrthoLayoutUML.h.

◆ margin() [1/2]

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

Definition at line 79 of file OrthoLayoutUML.h.

◆ margin() [2/2]

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

Definition at line 83 of file OrthoLayoutUML.h.

◆ optionProfile()

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

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

Definition at line 116 of file OrthoLayoutUML.h.

◆ preferedDir() [1/2]

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

Definition at line 89 of file OrthoLayoutUML.h.

◆ preferedDir() [2/2]

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

Definition at line 93 of file OrthoLayoutUML.h.

◆ scaling()

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

Set scaling compaction.

Definition at line 122 of file OrthoLayoutUML.h.

◆ separation() [1/2]

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

Returns the minimal allowed distance between edges and vertices.

Implements ogdf::LayoutPlanRepUMLModule.

Definition at line 59 of file OrthoLayoutUML.h.

◆ separation() [2/2]

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

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

Implements ogdf::LayoutPlanRepUMLModule.

Definition at line 63 of file OrthoLayoutUML.h.

◆ setBendBound()

void ogdf::OrthoLayoutUML::setBendBound ( int  i)
inline

Set bound on the number of bends.

Definition at line 125 of file OrthoLayoutUML.h.

◆ setOptions()

virtual void ogdf::OrthoLayoutUML::setOptions ( int  )
inlineoverridevirtual

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

Reimplemented from ogdf::LayoutPlanRepUMLModule.

Definition at line 133 of file OrthoLayoutUML.h.

Member Data Documentation

◆ m_align

bool ogdf::OrthoLayoutUML::m_align
private

Definition at line 171 of file OrthoLayoutUML.h.

◆ m_bendBound

int ogdf::OrthoLayoutUML::m_bendBound
private

bounds number of bends per edge in ortho shaper

Definition at line 177 of file OrthoLayoutUML.h.

◆ m_costAssoc

int ogdf::OrthoLayoutUML::m_costAssoc
private

Definition at line 168 of file OrthoLayoutUML.h.

◆ m_costGen

int ogdf::OrthoLayoutUML::m_costGen
private

Definition at line 169 of file OrthoLayoutUML.h.

◆ m_cOverhang

double ogdf::OrthoLayoutUML::m_cOverhang
private

Definition at line 164 of file OrthoLayoutUML.h.

◆ m_margin

double ogdf::OrthoLayoutUML::m_margin
private

Definition at line 165 of file OrthoLayoutUML.h.

◆ m_optionProfile

int ogdf::OrthoLayoutUML::m_optionProfile
private

Definition at line 167 of file OrthoLayoutUML.h.

◆ m_orthoStyle

int ogdf::OrthoLayoutUML::m_orthoStyle
private

Definition at line 176 of file OrthoLayoutUML.h.

◆ m_preferedDir

OrthoDir ogdf::OrthoLayoutUML::m_preferedDir
private

Definition at line 166 of file OrthoLayoutUML.h.

◆ m_scalingSteps

int ogdf::OrthoLayoutUML::m_scalingSteps
private

Definition at line 174 of file OrthoLayoutUML.h.

◆ m_separation

double ogdf::OrthoLayoutUML::m_separation
private

Definition at line 163 of file OrthoLayoutUML.h.

◆ m_useScalingCompaction

bool ogdf::OrthoLayoutUML::m_useScalingCompaction
private

Definition at line 173 of file OrthoLayoutUML.h.


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