Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions

ogdf::LayoutModule Class Reference

Interface of general layout algorithms. More...

#include <ogdf/module/LayoutModule.h>

Inheritance diagram for ogdf::LayoutModule:
ogdf::BalloonLayout ogdf::CircularLayout ogdf::ComponentSplitterLayout ogdf::DavidsonHarelLayout ogdf::DominanceLayout ogdf::FastMultipoleEmbedder ogdf::FastMultipoleMultilevelEmbedder ogdf::FMMMLayout ogdf::ForceLayoutModule ogdf::GEMLayout ogdf::GridLayoutModule ogdf::MixedForceLayout ogdf::MMMExampleFastLayout ogdf::MMMExampleNiceLayout ogdf::MMMExampleNoTwistLayout ogdf::ModularMultilevelMixer ogdf::PreprocessorLayout ogdf::RadialTreeLayout ogdf::ScalingLayout ogdf::SpringEmbedderFR ogdf::SpringEmbedderKK ogdf::StressMajorization ogdf::SugiyamaLayout ogdf::TreeLayout ogdf::TutteLayout ogdf::UMLLayoutModule ogdf::UpwardPlanarizationLayout ogdf::VisibilityLayout

List of all members.

Public Member Functions

 LayoutModule ()
 Initializes a layout module.
virtual ~LayoutModule ()
virtual void call (GraphAttributes &GA)=0
 Computes a layout of graph GA.
void operator() (GraphAttributes &GA)
 Computes a layout of graph GA.
virtual void call (MultilevelGraph &MLG)
 Computes a layout of graph MLG.
void * operator new (size_t nBytes)
void * operator new (size_t, void *p)
void operator delete (void *p, size_t nBytes)

Detailed Description

Interface of general layout algorithms.

Definition at line 73 of file LayoutModule.h.


Constructor & Destructor Documentation

ogdf::LayoutModule::LayoutModule (  )  [inline]

Initializes a layout module.

Definition at line 76 of file LayoutModule.h.

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

Definition at line 78 of file LayoutModule.h.


Member Function Documentation

virtual void ogdf::LayoutModule::call ( MultilevelGraph MLG  )  [inline, virtual]

Computes a layout of graph MLG.

This method can be implemented optionally to allow a LayoutModule to modify the Graph. This allows some Layout Algorithms to save Memory, compared to a normal call(GA) DO NOT implement this if you are not sure whether this would save you Memory! This Method only helps if the Graph is already in the MultiLevelGraph Format (or can be converted without creating a copy) AND the Layout would need a copy otherwise. All Incremental Layouts (especially energy based) CAN be called by ModularMultilevelMixer. The standard implementation converts the MLG to GA and uses call(GA).

If implemented, the following Implementation of call(GA) is advised to ensure consistent behaviour of the two call Methods: void YourLayout::call(GraphAttributes &GA) { MultilevelGraph MLG(GA); call(MLG); MLG.exportAttributes(GA); }

Parameters:
MLG is the input graph and will also be assigned the layout information.

Reimplemented in ogdf::PreprocessorLayout, ogdf::FastMultipoleEmbedder, ogdf::MixedForceLayout, ogdf::MMMExampleFastLayout, ogdf::MMMExampleNiceLayout, ogdf::MMMExampleNoTwistLayout, ogdf::ModularMultilevelMixer, ogdf::ScalingLayout, ogdf::ForceLayoutModule, and ogdf::ComponentSplitterLayout.

Definition at line 118 of file LayoutModule.h.

void ogdf::LayoutModule::operator delete ( void *  p,
size_t  nBytes 
) [inline]
void* ogdf::LayoutModule::operator new ( size_t  nBytes  )  [inline]
void* ogdf::LayoutModule::operator new ( size_t  ,
void *  p 
) [inline]
void ogdf::LayoutModule::operator() ( GraphAttributes GA  )  [inline]

Computes a layout of graph GA.

Parameters:
GA is the input graph and will also be assigned the layout information.

Definition at line 94 of file LayoutModule.h.


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