Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions | Static Public Member Functions | Static Private Member Functions

ogdf::CCLayoutPackModule Class Reference

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

#include <ogdf/module/CCLayoutPackModule.h>

Inheritance diagram for ogdf::CCLayoutPackModule:
ogdf::TileToRowsCCPacker

List of all members.

Public Member Functions

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

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.
static bool checkOffsets (const Array< IPoint > &box, const Array< IPoint > &offset)
 Checks if the rectangles in box do not overlap for given offsets.

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.

Detailed Description

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

See also:
PlanarizationLayout
PlanarizationGridLayout

Definition at line 75 of file CCLayoutPackModule.h.


Constructor & Destructor Documentation

ogdf::CCLayoutPackModule::CCLayoutPackModule (  )  [inline]

Initializes a layout packing module.

Definition at line 78 of file CCLayoutPackModule.h.

virtual ogdf::CCLayoutPackModule::~CCLayoutPackModule (  )  [inline, virtual]

Definition at line 80 of file CCLayoutPackModule.h.


Member Function Documentation

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:
box is the array of input rectangles.
offset is assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatio is the desired page ratio (width / height) of the resulting layout.

Implemented in ogdf::TileToRowsCCPacker.

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:
box is the array of input rectangles.
offset is assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatio is the desired page ratio (width / height) of the resulting layout.

Implemented in ogdf::TileToRowsCCPacker.

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:
box is the array of rectangles.
offset is the array of corresponding offsets.
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:
box is the array of rectangles.
offset is the array of corresponding offsets.
template<class POINT >
static bool ogdf::CCLayoutPackModule::checkOffsetsTP ( const Array< POINT > &  box,
const Array< POINT > &  offset 
) [static, private]

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

This is a parameterized function for generic point types POINT.

Parameters:
box is the array of rectangles.
offset is the array of corresponding offsets.
void ogdf::CCLayoutPackModule::operator delete ( void *  p,
size_t  nBytes 
) [inline]

Definition at line 181 of file CCLayoutPackModule.h.

void* ogdf::CCLayoutPackModule::operator new ( size_t  ,
void *  p 
) [inline]

Definition at line 181 of file CCLayoutPackModule.h.

void* ogdf::CCLayoutPackModule::operator new ( size_t  nBytes  )  [inline]

Definition at line 181 of file CCLayoutPackModule.h.

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:
box is the array of input rectangles.
offset is assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatio is the desired page ratio (width / height) of the resulting layout.

Definition at line 151 of file CCLayoutPackModule.h.

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:
box is the array of input rectangles.
offset is assigned the offset of each rectangle to the origin (0,0). The offset of a rectangle is its lower left point in the layout.
pageRatio is the desired page ratio (width / height) of the resulting layout.

Definition at line 113 of file CCLayoutPackModule.h.


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