Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::CCLayoutPackModule Class Referenceabstract

Base class of algorithms that arrange/pack layouts of connected components. More...

#include <ogdf/packing/CCLayoutPackModule.h>

+ Inheritance diagram for ogdf::CCLayoutPackModule:

Public Member Functions

 CCLayoutPackModule ()
 Initializes a layout packing module. More...
 
virtual ~CCLayoutPackModule ()
 
virtual void call (Array< DPoint > &box, Array< DPoint > &offset, double pageRatio=1.0)=0
 Arranges the rectangles given by box. More...
 
virtual void call (Array< IPoint > &box, Array< IPoint > &offset, double pageRatio=1.0)=0
 Arranges the rectangles given by box. More...
 
void operator() (Array< DPoint > &box, Array< DPoint > &offset, double pageRatio=1.0)
 Arranges the rectangles given by box. More...
 
void operator() (Array< IPoint > &box, Array< IPoint > &offset, double pageRatio=1.0)
 Arranges the rectangles given by box. More...
 

Static Public Member Functions

static bool checkOffsets (const Array< DPoint > &box, const Array< DPoint > &offset)
 Checks if the rectangles in box do not overlap for given offsets. More...
 
static bool checkOffsets (const Array< IPoint > &box, const Array< IPoint > &offset)
 Checks if the rectangles in box do not overlap for given offsets. More...
 

Static Private Member Functions

template<class POINT >
static bool checkOffsetsTP (const Array< POINT > &box, const Array< POINT > &offset)
 Checks if the rectangles in box do not overlap for given offsets. More...
 

Detailed Description

Base class of algorithms that arrange/pack layouts of connected components.

See also
PlanarizationLayout
PlanarizationGridLayout

Definition at line 48 of file CCLayoutPackModule.h.

Constructor & Destructor Documentation

◆ CCLayoutPackModule()

ogdf::CCLayoutPackModule::CCLayoutPackModule ( )
inline

Initializes a layout packing module.

Definition at line 51 of file CCLayoutPackModule.h.

◆ ~CCLayoutPackModule()

virtual ogdf::CCLayoutPackModule::~CCLayoutPackModule ( )
inlinevirtual

Definition at line 53 of file CCLayoutPackModule.h.

Member Function Documentation

◆ call() [1/2]

virtual void ogdf::CCLayoutPackModule::call ( Array< DPoint > &  box,
Array< DPoint > &  offset,
double  pageRatio = 1.0 
)
pure virtual

Arranges the rectangles given by box.

The algorithm call takes an input an array box of rectangles with real coordinates and computes in offset the offset to (0,0) of each rectangle in the layout.

This method is the actual algorithm call and must be overridden by derived classes.

Parameters
boxis the array of input rectangles.
offsetis assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatiois the desired page ratio (width / height) of the resulting layout.

Implemented in ogdf::TileToRowsCCPacker.

◆ call() [2/2]

virtual void ogdf::CCLayoutPackModule::call ( Array< IPoint > &  box,
Array< IPoint > &  offset,
double  pageRatio = 1.0 
)
pure virtual

Arranges the rectangles given by box.

The algorithm call takes an input an array box of rectangles with integer coordinates and computes in offset the offset to (0,0) of each rectangle in the layout.

This method is the actual algorithm call and must be overridden by derived classes.

Parameters
boxis the array of input rectangles.
offsetis assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatiois the desired page ratio (width / height) of the resulting layout.

Implemented in ogdf::TileToRowsCCPacker.

◆ checkOffsets() [1/2]

static bool ogdf::CCLayoutPackModule::checkOffsets ( const Array< DPoint > &  box,
const Array< DPoint > &  offset 
)
static

Checks if the rectangles in box do not overlap for given offsets.

This function serves for checking if the computed offsets are correct in the sense that the rectangles do not overlap in the resulting layout.

Parameters
boxis the array of rectangles.
offsetis the array of corresponding offsets.

◆ checkOffsets() [2/2]

static bool ogdf::CCLayoutPackModule::checkOffsets ( const Array< IPoint > &  box,
const Array< IPoint > &  offset 
)
static

Checks if the rectangles in box do not overlap for given offsets.

This function serves for checking if the computed offsets are correct in the sense that the rectangles do not overlap in the resulting layout.

Parameters
boxis the array of rectangles.
offsetis the array of corresponding offsets.

◆ checkOffsetsTP()

template<class POINT >
static bool ogdf::CCLayoutPackModule::checkOffsetsTP ( const Array< POINT > &  box,
const Array< POINT > &  offset 
)
staticprivate

Checks if the rectangles in box do not overlap for given offsets.

Parameters
boxis the array of rectangles.
offsetis the array of corresponding offsets.
Template Parameters
POINTis the generic point type.

◆ operator()() [1/2]

void ogdf::CCLayoutPackModule::operator() ( Array< DPoint > &  box,
Array< DPoint > &  offset,
double  pageRatio = 1.0 
)
inline

Arranges the rectangles given by box.

The algorithm call takes an input an array box of rectangles with real coordinates and computes in offset the offset to (0,0) of each rectangle in the layout.

Parameters
boxis the array of input rectangles.
offsetis assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatiois the desired page ratio (width / height) of the resulting layout.

Definition at line 86 of file CCLayoutPackModule.h.

◆ operator()() [2/2]

void ogdf::CCLayoutPackModule::operator() ( Array< IPoint > &  box,
Array< IPoint > &  offset,
double  pageRatio = 1.0 
)
inline

Arranges the rectangles given by box.

The algorithm call takes an input an array box of rectangles with integer coordinates and computes in offset the offset to (0,0) of each rectangle in the layout.

Parameters
boxis the array of input rectangles.
offsetis assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatiois the desired page ratio (width / height) of the resulting layout.

Definition at line 124 of file CCLayoutPackModule.h.


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