a force directed graph layout algorithm More...

#include <vtkForceDirectedLayoutStrategy.h>

Inheritance diagram for vtkForceDirectedLayoutStrategy:

Collaboration diagram for vtkForceDirectedLayoutStrategy:

Public Types
typedef vtkGraphLayoutStrategy	Superclass

Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkForceDirectedLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Initialize ()

virtual void	Layout ()

virtual int	IsLayoutComplete ()


virtual void	SetRandomSeed (int)

virtual int	GetRandomSeed ()


virtual void	SetGraphBounds (double, double, double, double, double, double)

virtual void	SetGraphBounds (double[6])

virtual double *	GetGraphBounds ()

virtual void	GetGraphBounds (double data[6])


virtual void	SetAutomaticBoundsComputation (int)

virtual int	GetAutomaticBoundsComputation ()

virtual void	AutomaticBoundsComputationOn ()

virtual void	AutomaticBoundsComputationOff ()


virtual void	SetMaxNumberOfIterations (int)

virtual int	GetMaxNumberOfIterations ()


virtual void	SetIterationsPerLayout (int)

virtual int	GetIterationsPerLayout ()


virtual void	SetCoolDownRate (double)

virtual double	GetCoolDownRate ()


virtual void	SetThreeDimensionalLayout (int)

virtual int	GetThreeDimensionalLayout ()

virtual void	ThreeDimensionalLayoutOn ()

virtual void	ThreeDimensionalLayoutOff ()


virtual void	SetRandomInitialPoints (int)

virtual int	GetRandomInitialPoints ()

virtual void	RandomInitialPointsOn ()

virtual void	RandomInitialPointsOff ()


virtual void	SetInitialTemperature (float)

virtual float	GetInitialTemperature ()

Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetGraph (vtkGraph *graph)

virtual void	SetWeightEdges (bool state)

virtual bool	GetWeightEdges ()

virtual void	SetEdgeWeightField (const char *field)

virtual char *	GetEdgeWeightField ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkForceDirectedLayoutStrategy *	New ()

static int	IsTypeOf (const char *type)

static vtkForceDirectedLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkGraphLayoutStrategy
static int	IsTypeOf (const char *type)

static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkForceDirectedLayoutStrategy ()

	~vtkForceDirectedLayoutStrategy ()

Protected Member Functions inherited from vtkGraphLayoutStrategy
	vtkGraphLayoutStrategy ()

	~vtkGraphLayoutStrategy ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	GraphBounds [6]

int	AutomaticBoundsComputation

int	MaxNumberOfIterations

double	CoolDownRate

double	InitialTemperature

int	ThreeDimensionalLayout

int	RandomInitialPoints

Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraph *	Graph

char *	EdgeWeightField

bool	WeightEdges

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

a force directed graph layout algorithm

Lays out a graph in 2D or 3D using a force-directed algorithm. The user may specify whether to layout the graph randomly initially, the bounds, the number of dimensions (2 or 3), and the cool-down rate.

Thanks:: Thanks to Brian Wylie for adding functionality for allowing this layout to be incremental.

Tests:: vtkForceDirectedLayoutStrategy (Tests)

Definition at line 42 of file vtkForceDirectedLayoutStrategy.h.

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkForceDirectedLayoutStrategy::Superclass

Definition at line 47 of file vtkForceDirectedLayoutStrategy.h.

Constructor & Destructor Documentation

vtkForceDirectedLayoutStrategy::vtkForceDirectedLayoutStrategy ( )

protected

vtkForceDirectedLayoutStrategy::~vtkForceDirectedLayoutStrategy ( )

protected

Member Function Documentation

static vtkForceDirectedLayoutStrategy* vtkForceDirectedLayoutStrategy::New ( )

static

static int vtkForceDirectedLayoutStrategy::IsTypeOf ( const char * type )

static

virtual int vtkForceDirectedLayoutStrategy::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphLayoutStrategy.

static vtkForceDirectedLayoutStrategy* vtkForceDirectedLayoutStrategy::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkForceDirectedLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

vtkForceDirectedLayoutStrategy* vtkForceDirectedLayoutStrategy::NewInstance ( ) const

void vtkForceDirectedLayoutStrategy::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

virtual void vtkForceDirectedLayoutStrategy::SetRandomSeed ( int )

virtual

Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.

virtual int vtkForceDirectedLayoutStrategy::GetRandomSeed ( )

virtual

Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.

virtual void vtkForceDirectedLayoutStrategy::SetGraphBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Set / get the region in space in which to place the final graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.

virtual void vtkForceDirectedLayoutStrategy::SetGraphBounds ( double [6] )

virtual

Set / get the region in space in which to place the final graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.

virtual double* vtkForceDirectedLayoutStrategy::GetGraphBounds ( )

virtual

Set / get the region in space in which to place the final graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.

virtual void vtkForceDirectedLayoutStrategy::GetGraphBounds ( double data[6] )

virtual

Set / get the region in space in which to place the final graph. The GraphBounds only affects the results if AutomaticBoundsComputation is off.

virtual void vtkForceDirectedLayoutStrategy::SetAutomaticBoundsComputation ( int )

virtual

Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

virtual int vtkForceDirectedLayoutStrategy::GetAutomaticBoundsComputation ( )

virtual

Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

virtual void vtkForceDirectedLayoutStrategy::AutomaticBoundsComputationOn ( )

virtual

Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

virtual void vtkForceDirectedLayoutStrategy::AutomaticBoundsComputationOff ( )

virtual

Turn on/off automatic graph bounds calculation. If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

virtual void vtkForceDirectedLayoutStrategy::SetMaxNumberOfIterations ( int )

virtual

Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '50' for no particular reason

virtual int vtkForceDirectedLayoutStrategy::GetMaxNumberOfIterations ( )

virtual

Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '50' for no particular reason

virtual void vtkForceDirectedLayoutStrategy::SetIterationsPerLayout ( int )

virtual

Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '50' to match the default 'MaxNumberOfIterations'

virtual int vtkForceDirectedLayoutStrategy::GetIterationsPerLayout ( )

virtual

Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '50' to match the default 'MaxNumberOfIterations'

virtual void vtkForceDirectedLayoutStrategy::SetCoolDownRate ( double )

virtual

Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.

virtual double vtkForceDirectedLayoutStrategy::GetCoolDownRate ( )

virtual

Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.

virtual void vtkForceDirectedLayoutStrategy::SetThreeDimensionalLayout ( int )

virtual

Turn on/off layout of graph in three dimensions. If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.

virtual int vtkForceDirectedLayoutStrategy::GetThreeDimensionalLayout ( )

virtual

Turn on/off layout of graph in three dimensions. If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.

virtual void vtkForceDirectedLayoutStrategy::ThreeDimensionalLayoutOn ( )

virtual

Turn on/off layout of graph in three dimensions. If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.

virtual void vtkForceDirectedLayoutStrategy::ThreeDimensionalLayoutOff ( )

virtual

Turn on/off layout of graph in three dimensions. If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.

virtual void vtkForceDirectedLayoutStrategy::SetRandomInitialPoints ( int )

virtual

Turn on/off use of random positions within the graph bounds as initial points.

virtual int vtkForceDirectedLayoutStrategy::GetRandomInitialPoints ( )

virtual

Turn on/off use of random positions within the graph bounds as initial points.

virtual void vtkForceDirectedLayoutStrategy::RandomInitialPointsOn ( )

virtual

Turn on/off use of random positions within the graph bounds as initial points.

virtual void vtkForceDirectedLayoutStrategy::RandomInitialPointsOff ( )

virtual

Turn on/off use of random positions within the graph bounds as initial points.

virtual void vtkForceDirectedLayoutStrategy::SetInitialTemperature ( float )

virtual

Set the initial temperature. If zero (the default) , the initial temperature will be computed automatically.

virtual float vtkForceDirectedLayoutStrategy::GetInitialTemperature ( )

virtual

Set the initial temperature. If zero (the default) , the initial temperature will be computed automatically.

virtual void vtkForceDirectedLayoutStrategy::Initialize ( )

virtual

This strategy sets up some data structures for faster processing of each Layout() call

Reimplemented from vtkGraphLayoutStrategy.

virtual void vtkForceDirectedLayoutStrategy::Layout ( )

virtual

This is the layout method where the graph that was set in SetGraph() is laid out. The method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout please implement the IsLayoutComplete() method.

Implements vtkGraphLayoutStrategy.

virtual int vtkForceDirectedLayoutStrategy::IsLayoutComplete ( )

inlinevirtual

I'm an iterative layout so this method lets the caller know if I'm done laying out the graph

Reimplemented from vtkGraphLayoutStrategy.

Definition at line 137 of file vtkForceDirectedLayoutStrategy.h.