VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkCommunity2DLayoutStrategy Class Reference

a simple fast 2D graph layout that looks for a community array on it's input and strengthens edges within a community and weakens edges not within the community. More...

#include <vtkCommunity2DLayoutStrategy.h>

Inheritance diagram for vtkCommunity2DLayoutStrategy:
Inheritance graph
[legend]
Collaboration diagram for vtkCommunity2DLayoutStrategy:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkGraphLayoutStrategy Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkCommunity2DLayoutStrategyNewInstance () 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 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 char * GetCommunityArrayName ()
virtual void SetCommunityArrayName (const char *)
virtual void SetCommunityStrength (float)
virtual float GetCommunityStrength ()

Static Public Member Functions

static
vtkCommunity2DLayoutStrategy
New ()
static int IsTypeOf (const char *type)
static
vtkCommunity2DLayoutStrategy
SafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkCommunity2DLayoutStrategy ()
 ~vtkCommunity2DLayoutStrategy ()

Protected Attributes

int MaxNumberOfIterations
float InitialTemperature
float CoolDownRate

Detailed Description

a simple fast 2D graph layout that looks for a community array on it's input and strengthens edges within a community and weakens edges not within the community.

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:
Thanks to Godzilla for not eating my computer so that this class could be written.
Events:
vtkCommand::ProgressEvent

Definition at line 49 of file vtkCommunity2DLayoutStrategy.h.


Member Typedef Documentation

Reimplemented from vtkGraphLayoutStrategy.

Definition at line 54 of file vtkCommunity2DLayoutStrategy.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkObject.

static int vtkCommunity2DLayoutStrategy::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 vtkCommunity2DLayoutStrategy::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.

Reimplemented from vtkGraphLayoutStrategy.

virtual vtkObjectBase* vtkCommunity2DLayoutStrategy::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkGraphLayoutStrategy.

Reimplemented from vtkGraphLayoutStrategy.

void vtkCommunity2DLayoutStrategy::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 vtkCommunity2DLayoutStrategy::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.

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

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. :)

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. :)

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 :)

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 :)

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. :)

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. :)

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. :)

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. :)

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

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

virtual void vtkCommunity2DLayoutStrategy::Initialize ( ) [virtual]

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

Reimplemented from vtkGraphLayoutStrategy.

virtual void vtkCommunity2DLayoutStrategy::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 vtkCommunity2DLayoutStrategy::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 121 of file vtkCommunity2DLayoutStrategy.h.

Get/Set the community array name

virtual void vtkCommunity2DLayoutStrategy::SetCommunityArrayName ( const char *  ) [virtual]

Get/Set the community array name

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.


Member Data Documentation

Definition at line 142 of file vtkCommunity2DLayoutStrategy.h.

Definition at line 143 of file vtkCommunity2DLayoutStrategy.h.

Definition at line 144 of file vtkCommunity2DLayoutStrategy.h.


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