a force directed graph layout algorithm More...
#include <vtkForceDirectedLayoutStrategy.h>
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.
Definition at line 42 of file vtkForceDirectedLayoutStrategy.h.
Member Typedef Documentation
Reimplemented from vtkGraphLayoutStrategy.
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] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| static int vtkForceDirectedLayoutStrategy::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 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] |
Reimplemented from vtkGraphLayoutStrategy.
| virtual vtkObjectBase* vtkForceDirectedLayoutStrategy::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkGraphLayoutStrategy.
Reimplemented from vtkGraphLayoutStrategy.
| 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 vtkGraphLayoutStrategy.
| 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 | ( | ) | [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 137 of file vtkForceDirectedLayoutStrategy.h.
Member Data Documentation
double vtkForceDirectedLayoutStrategy::GraphBounds[6] [protected] |
Definition at line 143 of file vtkForceDirectedLayoutStrategy.h.
Definition at line 144 of file vtkForceDirectedLayoutStrategy.h.
Definition at line 145 of file vtkForceDirectedLayoutStrategy.h.
double vtkForceDirectedLayoutStrategy::CoolDownRate [protected] |
Definition at line 146 of file vtkForceDirectedLayoutStrategy.h.
Definition at line 147 of file vtkForceDirectedLayoutStrategy.h.
Definition at line 148 of file vtkForceDirectedLayoutStrategy.h.
Definition at line 149 of file vtkForceDirectedLayoutStrategy.h.
The documentation for this class was generated from the following file:
- dox/Infovis/Layout/vtkForceDirectedLayoutStrategy.h
