vtkSimple2DLayoutStrategy Class Reference

#include <vtkSimple2DLayoutStrategy.h>

Inheritance diagram for vtkSimple2DLayoutStrategy:

[legend]

Collaboration diagram for vtkSimple2DLayoutStrategy:

[legend]

List of all members.

Detailed Description

a simple 2D graph layout

This class is an implementation of the work presented in: Fruchterman & Reingold "Graph Drawing by Force-directed Placement" Software-Practice and Experience 21(11) 1991). The class includes some optimizations but nothing too fancy.

Thanks:: Thanks to Brian Wylie from Sandia National Laboratories for creating this class.

Events:: vtkCommand::ProgressEvent

Examples:: vtkSimple2DLayoutStrategy (Examples)

Tests:: vtkSimple2DLayoutStrategy (Tests)

Definition at line 50 of file vtkSimple2DLayoutStrategy.h.


Public Types
typedef vtkGraphLayoutStrategy	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize ()
virtual void	Layout ()
virtual int	IsLayoutComplete ()

virtual void	SetRandomSeed (int)
virtual int	GetRandomSeed ()

virtual void	SetMaxNumberOfIterations (int)
virtual int	GetMaxNumberOfIterations ()

virtual void	SetIterationsPerLayout (int)
virtual int	GetIterationsPerLayout ()

virtual void	SetInitialTemperature (float)
virtual float	GetInitialTemperature ()

virtual void	SetCoolDownRate (double)
virtual double	GetCoolDownRate ()

virtual void	SetJitter (bool)
virtual bool	GetJitter ()

virtual void	SetRestDistance (float)
virtual float	GetRestDistance ()
Static Public Member Functions
static vtkSimple2DLayoutStrategy *	New ()
static int	IsTypeOf (const char *type)
static vtkSimple2DLayoutStrategy *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSimple2DLayoutStrategy ()
	~vtkSimple2DLayoutStrategy ()
Protected Attributes
int	MaxNumberOfIterations
float	InitialTemperature
float	CoolDownRate

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkSimple2DLayoutStrategy::Superclass

Reimplemented from vtkGraphLayoutStrategy.

Definition at line 55 of file vtkSimple2DLayoutStrategy.h.

Constructor & Destructor Documentation

vtkSimple2DLayoutStrategy::vtkSimple2DLayoutStrategy ( ) [protected]

vtkSimple2DLayoutStrategy::~vtkSimple2DLayoutStrategy ( ) [protected]

Member Function Documentation

static vtkSimple2DLayoutStrategy* vtkSimple2DLayoutStrategy::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkSimple2DLayoutStrategy::GetClassName ( ) [virtual]

Reimplemented from vtkGraphLayoutStrategy.

static int vtkSimple2DLayoutStrategy::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy* vtkSimple2DLayoutStrategy::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkGraphLayoutStrategy.

void vtkSimple2DLayoutStrategy::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 vtkGraphLayoutStrategy.

virtual void vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy::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 '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

virtual int vtkSimple2DLayoutStrategy::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 '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

virtual void vtkSimple2DLayoutStrategy::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 '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

virtual int vtkSimple2DLayoutStrategy::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 '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

virtual void vtkSimple2DLayoutStrategy::SetInitialTemperature ( float ) [virtual]

Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

virtual float vtkSimple2DLayoutStrategy::GetInitialTemperature ( ) [virtual]

Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

virtual void vtkSimple2DLayoutStrategy::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. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

virtual double vtkSimple2DLayoutStrategy::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. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

virtual void vtkSimple2DLayoutStrategy::SetJitter ( bool ) [virtual]

Set Random jitter of the nodes at initialization to on or off. Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON

virtual bool vtkSimple2DLayoutStrategy::GetJitter ( ) [virtual]

Set Random jitter of the nodes at initialization to on or off. Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON

virtual void vtkSimple2DLayoutStrategy::SetRestDistance ( float ) [virtual]

Manually set the resting distance. Otherwise the distance is computed automatically.

virtual float vtkSimple2DLayoutStrategy::GetRestDistance ( ) [virtual]

Manually set the resting distance. Otherwise the distance is computed automatically.

virtual void vtkSimple2DLayoutStrategy::Initialize ( ) [virtual]

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

Reimplemented from vtkGraphLayoutStrategy.

virtual void vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy::IsLayoutComplete ( ) [inline, virtual]

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 129 of file vtkSimple2DLayoutStrategy.h.