Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::LayoutPlanRepUMLModule Class Referenceabstract

Interface for planar UML layout algorithms. More...

#include <ogdf/uml/LayoutPlanRepUMLModule.h>

+ Inheritance diagram for ogdf::LayoutPlanRepUMLModule:

Public Member Functions

 LayoutPlanRepUMLModule ()
 Initializes a UML planar layout module. More...
 
virtual ~LayoutPlanRepUMLModule ()
 
virtual void call (PlanRepUML &PG, adjEntry adjExternal, Layout &drawing)=0
 Computes a planar layout of PG in drawing. More...
 
const DPointgetBoundingBox () const
 Returns the bounding box of the computed layout. More...
 
virtual int getOptions ()
 Returns the (generic) options. More...
 
void operator() (PlanRepUML &PG, adjEntry adjExternal, Layout &drawing)
 Computes a planar layout of PG in drawing. More...
 
virtual double separation () const =0
 Returns the minimal allowed distance between edges and vertices. More...
 
virtual void separation (double sep)=0
 Sets the minimal allowed distance between edges and vertices to sep. More...
 
virtual void setOptions (int)
 Sets the (generic) options; derived classes have to cope with the interpretation) More...
 

Protected Member Functions

void setBoundingBox (PlanRep &PG, Layout &drawing)
 Computes and sets the bounding box variable m_boundingBox. More...
 

Protected Attributes

DPoint m_boundingBox
 Stores the bounding box of the computed layout. More...
 

Detailed Description

Interface for planar UML layout algorithms.

See also
PlanarizationLayout

Definition at line 48 of file LayoutPlanRepUMLModule.h.

Constructor & Destructor Documentation

◆ LayoutPlanRepUMLModule()

ogdf::LayoutPlanRepUMLModule::LayoutPlanRepUMLModule ( )
inline

Initializes a UML planar layout module.

Definition at line 51 of file LayoutPlanRepUMLModule.h.

◆ ~LayoutPlanRepUMLModule()

virtual ogdf::LayoutPlanRepUMLModule::~LayoutPlanRepUMLModule ( )
inlinevirtual

Definition at line 53 of file LayoutPlanRepUMLModule.h.

Member Function Documentation

◆ call()

virtual void ogdf::LayoutPlanRepUMLModule::call ( PlanRepUML PG,
adjEntry  adjExternal,
Layout drawing 
)
pure virtual

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.

Implemented in ogdf::OrthoLayoutUML.

◆ getBoundingBox()

const DPoint& ogdf::LayoutPlanRepUMLModule::getBoundingBox ( ) const
inline

Returns the bounding box of the computed layout.

Definition at line 72 of file LayoutPlanRepUMLModule.h.

◆ getOptions()

virtual int ogdf::LayoutPlanRepUMLModule::getOptions ( )
inlinevirtual

Returns the (generic) options.

Reimplemented in ogdf::OrthoLayoutUML.

Definition at line 81 of file LayoutPlanRepUMLModule.h.

◆ operator()()

void ogdf::LayoutPlanRepUMLModule::operator() ( PlanRepUML PG,
adjEntry  adjExternal,
Layout drawing 
)
inline

Computes a planar layout of PG in drawing.

Definition at line 67 of file LayoutPlanRepUMLModule.h.

◆ separation() [1/2]

virtual double ogdf::LayoutPlanRepUMLModule::separation ( ) const
pure virtual

Returns the minimal allowed distance between edges and vertices.

Implemented in ogdf::OrthoLayoutUML.

◆ separation() [2/2]

virtual void ogdf::LayoutPlanRepUMLModule::separation ( double  sep)
pure virtual

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

Implemented in ogdf::OrthoLayoutUML.

◆ setBoundingBox()

void ogdf::LayoutPlanRepUMLModule::setBoundingBox ( PlanRep PG,
Layout drawing 
)
inlineprotected

Computes and sets the bounding box variable m_boundingBox.

An algorithm can call setBoundingBox() for setting the m_boundingBox variable if no faster implementation is available.

Definition at line 102 of file LayoutPlanRepUMLModule.h.

◆ setOptions()

virtual void ogdf::LayoutPlanRepUMLModule::setOptions ( int  )
inlinevirtual

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

Reimplemented in ogdf::OrthoLayoutUML.

Definition at line 77 of file LayoutPlanRepUMLModule.h.

Member Data Documentation

◆ m_boundingBox

DPoint ogdf::LayoutPlanRepUMLModule::m_boundingBox
protected

Stores the bounding box of the computed layout.

Must be set by derived algorithms!

Definition at line 95 of file LayoutPlanRepUMLModule.h.


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