vtkConstrained2DLayoutStrategy Class Reference
#include <vtkConstrained2DLayoutStrategy.h>
Detailed Description
a simple fast 2D graph layout that looks for a 'constraint' array (vtkDoubleArray). Any entry in the constraint array will indicate the level of impedence a node has to the force calculations during the layout optimization. The array is assumed to be normalized between zero and one, with one being totally constrained, so no force will be applied to the node (i.e. no movement), and zero being full range of movement (no constraints).This class is a density grid based force directed layout strategy. Also please note that 'fast' is relative to quite slow. :) The layout running time is O(V+E) with an extremely high constant.
- Thanks:
- We would like to thank Mothra for distracting Godzilla while we wrote this class.
- Events:
- vtkCommand::ProgressEvent
Definition at line 52 of file vtkConstrained2DLayoutStrategy.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 | SetRestDistance (float) |
| virtual float | GetRestDistance () |
| virtual void | SetInputArrayName (const char *) |
| virtual char * | GetInputArrayName () |
Static Public Member Functions | |
| static vtkConstrained2DLayoutStrategy * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkConstrained2DLayoutStrategy * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkConstrained2DLayoutStrategy () | |
| ~vtkConstrained2DLayoutStrategy () | |
Protected Attributes | |
| int | MaxNumberOfIterations |
| float | InitialTemperature |
| float | CoolDownRate |
Member Typedef Documentation
Reimplemented from vtkGraphLayoutStrategy.
Definition at line 57 of file vtkConstrained2DLayoutStrategy.h.
Constructor & Destructor Documentation
| vtkConstrained2DLayoutStrategy::vtkConstrained2DLayoutStrategy | ( | ) | [protected] |
| vtkConstrained2DLayoutStrategy::~vtkConstrained2DLayoutStrategy | ( | ) | [protected] |
Member Function Documentation
| static vtkConstrained2DLayoutStrategy* vtkConstrained2DLayoutStrategy::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| virtual const char* vtkConstrained2DLayoutStrategy::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkGraphLayoutStrategy.
| static int vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy* vtkConstrained2DLayoutStrategy::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkGraphLayoutStrategy.
| void vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::SetRestDistance | ( | float | ) | [virtual] |
Manually set the resting distance. Otherwise the distance is computed automatically.
| virtual float vtkConstrained2DLayoutStrategy::GetRestDistance | ( | ) | [virtual] |
Manually set the resting distance. Otherwise the distance is computed automatically.
| virtual void vtkConstrained2DLayoutStrategy::Initialize | ( | ) | [virtual] |
This strategy sets up some data structures for faster processing of each Layout() call
Reimplemented from vtkGraphLayoutStrategy.
| virtual void vtkConstrained2DLayoutStrategy::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 vtkConstrained2DLayoutStrategy::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 124 of file vtkConstrained2DLayoutStrategy.h.
| virtual void vtkConstrained2DLayoutStrategy::SetInputArrayName | ( | const char * | ) | [virtual] |
Set/Get the input constraint array name. If no input array name is set then the name 'constraint' is used.
| virtual char* vtkConstrained2DLayoutStrategy::GetInputArrayName | ( | ) | [virtual] |
Set/Get the input constraint array name. If no input array name is set then the name 'constraint' is used.
Member Data Documentation
int vtkConstrained2DLayoutStrategy::MaxNumberOfIterations [protected] |
Definition at line 137 of file vtkConstrained2DLayoutStrategy.h.
float vtkConstrained2DLayoutStrategy::InitialTemperature [protected] |
Definition at line 138 of file vtkConstrained2DLayoutStrategy.h.
float vtkConstrained2DLayoutStrategy::CoolDownRate [protected] |
Definition at line 139 of file vtkConstrained2DLayoutStrategy.h.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkConstrained2DLayoutStrategy.h
