Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::UPRLayoutModule Class Referenceabstract

Interface of hierarchy layout algorithms. More...

#include <ogdf/upward/UPRLayoutModule.h>

+ Inheritance diagram for ogdf::UPRLayoutModule:

Public Member Functions

 UPRLayoutModule ()
 Initializes a upward planarized representation layout module. More...
 
virtual ~UPRLayoutModule ()
 
void call (const UpwardPlanRep &UPR, GraphAttributes &AG)
 Computes a upward layout of UPR in AG. More...
 

Public Attributes

int numberOfLevels
 

Protected Member Functions

virtual void doCall (const UpwardPlanRep &UPR, GraphAttributes &AG)=0
 Implements the actual algorithm call. More...
 

Detailed Description

Interface of hierarchy layout algorithms.

See also
SugiyamaLayout

Definition at line 46 of file UPRLayoutModule.h.

Constructor & Destructor Documentation

◆ UPRLayoutModule()

ogdf::UPRLayoutModule::UPRLayoutModule ( )
inline

Initializes a upward planarized representation layout module.

Definition at line 49 of file UPRLayoutModule.h.

◆ ~UPRLayoutModule()

virtual ogdf::UPRLayoutModule::~UPRLayoutModule ( )
inlinevirtual

Definition at line 51 of file UPRLayoutModule.h.

Member Function Documentation

◆ call()

void ogdf::UPRLayoutModule::call ( const UpwardPlanRep UPR,
GraphAttributes AG 
)
inline

Computes a upward layout of UPR in AG.

Parameters
UPRis the upward planarized representation of the input graph. The original graph of UPR muss be the input graph.
AGis assigned the hierarchy layout.

Definition at line 58 of file UPRLayoutModule.h.

◆ doCall()

virtual void ogdf::UPRLayoutModule::doCall ( const UpwardPlanRep UPR,
GraphAttributes AG 
)
protectedpure virtual

Implements the actual algorithm call.

Must be implemented by derived classes.

Parameters
UPRis the upward planarized representation of the input graph. The original graph of UPR muss be the input graph.
AGhas to be assigned the hierarchy layout.

Implemented in ogdf::LayerBasedUPRLayout.

Member Data Documentation

◆ numberOfLevels

int ogdf::UPRLayoutModule::numberOfLevels

Definition at line 60 of file UPRLayoutModule.h.


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