VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkForceDirectedLayoutStrategy Class Reference

a force directed graph layout algorithm More...

#include <vtkForceDirectedLayoutStrategy.h>

Inheritance diagram for vtkForceDirectedLayoutStrategy:
[legend]
Collaboration diagram for vtkForceDirectedLayoutStrategy:
[legend]

Public Types

typedef vtkGraphLayoutStrategy Superclass
 
- Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkForceDirectedLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetRandomSeed (int)
 Seed the random number generator used to jitter point positions. More...
 
virtual int GetRandomSeed ()
 
virtual void SetGraphBounds (double, double, double, double, double, double)
 Set / get the region in space in which to place the final graph. More...
 
virtual void SetGraphBounds (double[6])
 
virtual doubleGetGraphBounds ()
 
virtual void GetGraphBounds (double data[6])
 
virtual void SetAutomaticBoundsComputation (vtkTypeBool)
 Turn on/off automatic graph bounds calculation. More...
 
virtual vtkTypeBool GetAutomaticBoundsComputation ()
 
virtual void AutomaticBoundsComputationOn ()
 
virtual void AutomaticBoundsComputationOff ()
 
virtual void SetMaxNumberOfIterations (int)
 Set/Get the maximum number of iterations to be used. More...
 
virtual int GetMaxNumberOfIterations ()
 
virtual void SetIterationsPerLayout (int)
 Set/Get the number of iterations per layout. More...
 
virtual int GetIterationsPerLayout ()
 
virtual void SetCoolDownRate (double)
 Set/Get the Cool-down rate. More...
 
virtual double GetCoolDownRate ()
 
virtual void SetThreeDimensionalLayout (vtkTypeBool)
 Turn on/off layout of graph in three dimensions. More...
 
virtual vtkTypeBool GetThreeDimensionalLayout ()
 
virtual void ThreeDimensionalLayoutOn ()
 
virtual void ThreeDimensionalLayoutOff ()
 
virtual void SetRandomInitialPoints (vtkTypeBool)
 Turn on/off use of random positions within the graph bounds as initial points. More...
 
virtual vtkTypeBool GetRandomInitialPoints ()
 
virtual void RandomInitialPointsOn ()
 
virtual void RandomInitialPointsOff ()
 
virtual void SetInitialTemperature (float)
 Set the initial temperature. More...
 
virtual float GetInitialTemperature ()
 
void Initialize () override
 This strategy sets up some data structures for faster processing of each Layout() call. More...
 
void Layout () override
 This is the layout method where the graph that was set in SetGraph() is laid out. More...
 
int IsLayoutComplete () override
 I'm an iterative layout so this method lets the caller know if I'm done laying out the graph. More...
 
- Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetGraph (vtkGraph *graph)
 Setting the graph for the layout strategy. More...
 
virtual void SetWeightEdges (bool state)
 Whether to use edge weights in the layout or not. More...
 
virtual bool GetWeightEdges ()
 
virtual void SetEdgeWeightField (const char *field)
 Set/Get the field to use for the edge weights. More...
 
virtual char * GetEdgeWeightField ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkForceDirectedLayoutStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkForceDirectedLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGraphLayoutStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGraphLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkForceDirectedLayoutStrategy ()
 
 ~vtkForceDirectedLayoutStrategy () override
 
- Protected Member Functions inherited from vtkGraphLayoutStrategy
 vtkGraphLayoutStrategy ()
 
 ~vtkGraphLayoutStrategy () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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]
 
vtkTypeBool AutomaticBoundsComputation
 
int MaxNumberOfIterations
 
double CoolDownRate
 
double InitialTemperature
 
vtkTypeBool ThreeDimensionalLayout
 
vtkTypeBool RandomInitialPoints
 
- Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraphGraph
 
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 43 of file vtkForceDirectedLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkForceDirectedLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkForceDirectedLayoutStrategy()

vtkForceDirectedLayoutStrategy::vtkForceDirectedLayoutStrategy ( )
protected

◆ ~vtkForceDirectedLayoutStrategy()

vtkForceDirectedLayoutStrategy::~vtkForceDirectedLayoutStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkForceDirectedLayoutStrategy* vtkForceDirectedLayoutStrategy::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkForceDirectedLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkForceDirectedLayoutStrategy* vtkForceDirectedLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

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

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.

◆ SetRandomSeed()

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.

◆ GetRandomSeed()

virtual int vtkForceDirectedLayoutStrategy::GetRandomSeed ( )
virtual

◆ SetGraphBounds() [1/2]

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.

◆ SetGraphBounds() [2/2]

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

◆ GetGraphBounds() [1/2]

virtual double* vtkForceDirectedLayoutStrategy::GetGraphBounds ( )
virtual

◆ GetGraphBounds() [2/2]

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

◆ SetAutomaticBoundsComputation()

virtual void vtkForceDirectedLayoutStrategy::SetAutomaticBoundsComputation ( vtkTypeBool  )
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.

◆ GetAutomaticBoundsComputation()

virtual vtkTypeBool vtkForceDirectedLayoutStrategy::GetAutomaticBoundsComputation ( )
virtual

◆ AutomaticBoundsComputationOn()

virtual void vtkForceDirectedLayoutStrategy::AutomaticBoundsComputationOn ( )
virtual

◆ AutomaticBoundsComputationOff()

virtual void vtkForceDirectedLayoutStrategy::AutomaticBoundsComputationOff ( )
virtual

◆ SetMaxNumberOfIterations()

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

◆ GetMaxNumberOfIterations()

virtual int vtkForceDirectedLayoutStrategy::GetMaxNumberOfIterations ( )
virtual

◆ SetIterationsPerLayout()

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'

◆ GetIterationsPerLayout()

virtual int vtkForceDirectedLayoutStrategy::GetIterationsPerLayout ( )
virtual

◆ SetCoolDownRate()

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.

◆ GetCoolDownRate()

virtual double vtkForceDirectedLayoutStrategy::GetCoolDownRate ( )
virtual

◆ SetThreeDimensionalLayout()

virtual void vtkForceDirectedLayoutStrategy::SetThreeDimensionalLayout ( vtkTypeBool  )
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.

◆ GetThreeDimensionalLayout()

virtual vtkTypeBool vtkForceDirectedLayoutStrategy::GetThreeDimensionalLayout ( )
virtual

◆ ThreeDimensionalLayoutOn()

virtual void vtkForceDirectedLayoutStrategy::ThreeDimensionalLayoutOn ( )
virtual

◆ ThreeDimensionalLayoutOff()

virtual void vtkForceDirectedLayoutStrategy::ThreeDimensionalLayoutOff ( )
virtual

◆ SetRandomInitialPoints()

virtual void vtkForceDirectedLayoutStrategy::SetRandomInitialPoints ( vtkTypeBool  )
virtual

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

◆ GetRandomInitialPoints()

virtual vtkTypeBool vtkForceDirectedLayoutStrategy::GetRandomInitialPoints ( )
virtual

◆ RandomInitialPointsOn()

virtual void vtkForceDirectedLayoutStrategy::RandomInitialPointsOn ( )
virtual

◆ RandomInitialPointsOff()

virtual void vtkForceDirectedLayoutStrategy::RandomInitialPointsOff ( )
virtual

◆ SetInitialTemperature()

virtual void vtkForceDirectedLayoutStrategy::SetInitialTemperature ( float  )
virtual

Set the initial temperature.

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

◆ GetInitialTemperature()

virtual float vtkForceDirectedLayoutStrategy::GetInitialTemperature ( )
virtual

◆ Initialize()

void vtkForceDirectedLayoutStrategy::Initialize ( )
overridevirtual

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

Reimplemented from vtkGraphLayoutStrategy.

◆ Layout()

void vtkForceDirectedLayoutStrategy::Layout ( )
overridevirtual

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.

◆ IsLayoutComplete()

int vtkForceDirectedLayoutStrategy::IsLayoutComplete ( )
inlineoverridevirtual

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 162 of file vtkForceDirectedLayoutStrategy.h.

Member Data Documentation

◆ GraphBounds

double vtkForceDirectedLayoutStrategy::GraphBounds[6]
protected

Definition at line 168 of file vtkForceDirectedLayoutStrategy.h.

◆ AutomaticBoundsComputation

vtkTypeBool vtkForceDirectedLayoutStrategy::AutomaticBoundsComputation
protected

Definition at line 169 of file vtkForceDirectedLayoutStrategy.h.

◆ MaxNumberOfIterations

int vtkForceDirectedLayoutStrategy::MaxNumberOfIterations
protected

Definition at line 170 of file vtkForceDirectedLayoutStrategy.h.

◆ CoolDownRate

double vtkForceDirectedLayoutStrategy::CoolDownRate
protected

Definition at line 171 of file vtkForceDirectedLayoutStrategy.h.

◆ InitialTemperature

double vtkForceDirectedLayoutStrategy::InitialTemperature
protected

Definition at line 172 of file vtkForceDirectedLayoutStrategy.h.

◆ ThreeDimensionalLayout

vtkTypeBool vtkForceDirectedLayoutStrategy::ThreeDimensionalLayout
protected

Definition at line 173 of file vtkForceDirectedLayoutStrategy.h.

◆ RandomInitialPoints

vtkTypeBool vtkForceDirectedLayoutStrategy::RandomInitialPoints
protected

Definition at line 174 of file vtkForceDirectedLayoutStrategy.h.


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