Open
Graph Drawing
Framework

 v.2007.11
 

ogdf::LayoutPlanRepModule Class Reference

Interface for planar UML layout algorithms. More...

#include <LayoutPlanRepModule.h>

Inheritance diagram for ogdf::LayoutPlanRepModule:

ogdf::OrthoLayout

List of all members.

Public Member Functions

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

Protected Member Functions

void setBoundingBox (PlanRepUML &PG, Layout &drawing)
 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.

Protected Attributes

DPoint m_boundingBox
 Stores the bounding box of the computed layout. Must be set by derived algorithms!.


Detailed Description

Interface for planar UML layout algorithms.

See also:
PlanarizationLayout

Definition at line 77 of file LayoutPlanRepModule.h.


Constructor & Destructor Documentation

ogdf::LayoutPlanRepModule::LayoutPlanRepModule (  )  [inline]

Initializes a UML planar layout module.

Definition at line 80 of file LayoutPlanRepModule.h.

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

Definition at line 82 of file LayoutPlanRepModule.h.


Member Function Documentation

virtual void ogdf::LayoutPlanRepModule::call ( PlanRepUML PG,
adjEntry  adjExternal,
Layout drawing 
) [pure virtual]

Computes a planar layout of PG in drawing.

Must be overridden by derived classes.

Parameters:
PG is the input planarized representation which may be modified.
adjExternal is an adjacenty entry on the external face.
drawing is the computed layout of PG.

Implemented in ogdf::OrthoLayout.

void ogdf::LayoutPlanRepModule::operator() ( PlanRepUML PG,
adjEntry  adjExternal,
Layout drawing 
) [inline]

Computes a planar layout of PG in drawing.

Definition at line 96 of file LayoutPlanRepModule.h.

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

Returns the bounding box of the computed layout.

Definition at line 101 of file LayoutPlanRepModule.h.

virtual void ogdf::LayoutPlanRepModule::setOptions ( int   )  [inline, virtual]

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

Reimplemented in ogdf::OrthoLayout.

Definition at line 106 of file LayoutPlanRepModule.h.

virtual int ogdf::LayoutPlanRepModule::getOptions (  )  [inline, virtual]

Returns the (generic) options.

Reimplemented in ogdf::OrthoLayout.

Definition at line 109 of file LayoutPlanRepModule.h.

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

Returns the minimal allowed distance between edges and vertices.

Implemented in ogdf::OrthoLayout.

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

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

Implemented in ogdf::OrthoLayout.

void ogdf::LayoutPlanRepModule::setBoundingBox ( PlanRepUML PG,
Layout drawing 
) [protected]

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.

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

Definition at line 131 of file LayoutPlanRepModule.h.

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

Definition at line 131 of file LayoutPlanRepModule.h.

void ogdf::LayoutPlanRepModule::operator delete ( void *  p  )  [inline]

Definition at line 131 of file LayoutPlanRepModule.h.


Member Data Documentation

DPoint ogdf::LayoutPlanRepModule::m_boundingBox [protected]

Stores the bounding box of the computed layout. Must be set by derived algorithms!.

Definition at line 122 of file LayoutPlanRepModule.h.


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

© 1999-2007 by oreas GmbH, © 2005-2007 by University Dortmund and University Cologne.

Generated on Thu Nov 22 19:40:13 2007 by doxygen 1.5.4.