Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::LayoutPlanRepModule Class Referenceabstract

Interface for planar layout algorithms (used in the planarization approach). More...

#include <ogdf/planarity/LayoutPlanRepModule.h>

+ Inheritance diagram for ogdf::LayoutPlanRepModule:

Public Member Functions

 LayoutPlanRepModule ()
 Initializes a planar layout module. More...
 
virtual ~LayoutPlanRepModule ()
 Destructor. More...
 
virtual void call (PlanRep &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...
 
void operator() (PlanRep &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...
 

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 layout algorithms (used in the planarization approach).

See also
PlanarizationLayout

Definition at line 46 of file LayoutPlanRepModule.h.

Constructor & Destructor Documentation

◆ LayoutPlanRepModule()

ogdf::LayoutPlanRepModule::LayoutPlanRepModule ( )
inline

Initializes a planar layout module.

Definition at line 49 of file LayoutPlanRepModule.h.

◆ ~LayoutPlanRepModule()

virtual ogdf::LayoutPlanRepModule::~LayoutPlanRepModule ( )
inlinevirtual

Destructor.

Definition at line 52 of file LayoutPlanRepModule.h.

Member Function Documentation

◆ call()

virtual void ogdf::LayoutPlanRepModule::call ( PlanRep PG,
adjEntry  adjExternal,
Layout drawing 
)
pure virtual

Computes a planar layout of PG in drawing.

Must be overridden by derived classes. The implementation must also set m_boundingBox, which gives the bounding box of the computed layout.

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::OrthoLayout.

◆ getBoundingBox()

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

Returns the bounding box of the computed layout.

Definition at line 73 of file LayoutPlanRepModule.h.

◆ operator()()

void ogdf::LayoutPlanRepModule::operator() ( PlanRep PG,
adjEntry  adjExternal,
Layout drawing 
)
inline

Computes a planar layout of PG in drawing.

Definition at line 68 of file LayoutPlanRepModule.h.

◆ separation() [1/2]

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

Returns the minimal allowed distance between edges and vertices.

Implemented in ogdf::OrthoLayout.

◆ separation() [2/2]

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

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

Implemented in ogdf::OrthoLayout.

◆ setBoundingBox()

void ogdf::LayoutPlanRepModule::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 95 of file LayoutPlanRepModule.h.

Member Data Documentation

◆ m_boundingBox

DPoint ogdf::LayoutPlanRepModule::m_boundingBox
protected

Stores the bounding box of the computed layout.

Must be set by derived algorithms!

Definition at line 88 of file LayoutPlanRepModule.h.


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