VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkIncrementalForceLayout Class Reference

incremental force-directed layout. More...

#include <vtkIncrementalForceLayout.h>

Inherits vtkObject.

Collaboration diagram for vtkIncrementalForceLayout:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkIncrementalForceLayoutNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void UpdatePositions ()
 
virtual void SetGraph (vtkGraph *g)
 
virtual vtkGraphGetGraph ()
 
virtual void SetFixed (vtkIdType fixed)
 
virtual vtkIdType GetFixed ()
 
virtual void SetAlpha (float)
 
virtual float GetAlpha ()
 
virtual void SetTheta (float)
 
virtual float GetTheta ()
 
virtual void SetCharge (float)
 
virtual float GetCharge ()
 
virtual void SetStrength (float)
 
virtual float GetStrength ()
 
virtual void SetDistance (float)
 
virtual float GetDistance ()
 
virtual void SetGravity (float)
 
virtual float GetGravity ()
 
virtual void SetFriction (float)
 
virtual float GetFriction ()
 
virtual void SetGravityPoint (const vtkVector2f &point)
 
virtual vtkVector2f GetGravityPoint ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkIncrementalForceLayoutSafeDownCast (vtkObjectBase *o)
 
static vtkIncrementalForceLayoutNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkIncrementalForceLayout ()
 
 ~vtkIncrementalForceLayout ()
 

Protected Attributes

vtkGraphGraph
 
Implementation * Impl
 
vtkIdType Fixed
 
vtkVector2f GravityPoint
 
float Alpha
 
float Theta
 
float Charge
 
float Strength
 
float Distance
 
float Gravity
 
float Friction
 

Detailed Description

incremental force-directed layout.

Performs an incremental force-directed layout of a graph. Set the graph then iteratively execute UpdatePositions() to update the vertex positions. Note that this directly modifies the vertex locations in the graph.

This layout is modeled after D3's force layout described at https://github.com/mbostock/d3/wiki/Force-Layout

Tests:
vtkIncrementalForceLayout (Tests)

Definition at line 41 of file vtkIncrementalForceLayout.h.

Member Typedef Documentation

Definition at line 44 of file vtkIncrementalForceLayout.h.

Constructor & Destructor Documentation

vtkIncrementalForceLayout::vtkIncrementalForceLayout ( )
protected
vtkIncrementalForceLayout::~vtkIncrementalForceLayout ( )
protected

Member Function Documentation

static int vtkIncrementalForceLayout::IsTypeOf ( const char *  type)
static
virtual int vtkIncrementalForceLayout::IsA ( const char *  type)
virtual
static vtkIncrementalForceLayout* vtkIncrementalForceLayout::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkIncrementalForceLayout::NewInstanceInternal ( ) const
protectedvirtual
vtkIncrementalForceLayout* vtkIncrementalForceLayout::NewInstance ( ) const
virtual void vtkIncrementalForceLayout::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
static vtkIncrementalForceLayout* vtkIncrementalForceLayout::New ( )
static
virtual void vtkIncrementalForceLayout::SetGraph ( vtkGraph g)
virtual

Set the graph to be positioned.

virtual vtkGraph* vtkIncrementalForceLayout::GetGraph ( )
virtual

Set the graph to be positioned.

virtual void vtkIncrementalForceLayout::SetFixed ( vtkIdType  fixed)
virtual

Set the id of the vertex that will not move during the simulation. Set to -1 to allow all the vertices to move.

virtual vtkIdType vtkIncrementalForceLayout::GetFixed ( )
virtual

Set the id of the vertex that will not move during the simulation. Set to -1 to allow all the vertices to move.

virtual void vtkIncrementalForceLayout::SetAlpha ( float  )
virtual

Set the level of activity in the simulation. Default is 0.1.

virtual float vtkIncrementalForceLayout::GetAlpha ( )
virtual

Set the level of activity in the simulation. Default is 0.1.

virtual void vtkIncrementalForceLayout::SetTheta ( float  )
virtual

Set the Barnes-Hut threshold for the simulation. Higher values will speed the simulation at the expense of some accuracy. Default is 0.8.

virtual float vtkIncrementalForceLayout::GetTheta ( )
virtual

Set the Barnes-Hut threshold for the simulation. Higher values will speed the simulation at the expense of some accuracy. Default is 0.8.

virtual void vtkIncrementalForceLayout::SetCharge ( float  )
virtual

Set the charge of each vertex. Higher negative values will repel vertices from each other more strongly. Default is -30.

virtual float vtkIncrementalForceLayout::GetCharge ( )
virtual

Set the charge of each vertex. Higher negative values will repel vertices from each other more strongly. Default is -30.

virtual void vtkIncrementalForceLayout::SetStrength ( float  )
virtual

Set the rigitity of links in the simulation. Default is 2.

virtual float vtkIncrementalForceLayout::GetStrength ( )
virtual

Set the rigitity of links in the simulation. Default is 2.

virtual void vtkIncrementalForceLayout::SetDistance ( float  )
virtual

Set the resting distance of each link in scene units, which is equal to pixels when there is no scene scaling. Default is 20.

virtual float vtkIncrementalForceLayout::GetDistance ( )
virtual

Set the resting distance of each link in scene units, which is equal to pixels when there is no scene scaling. Default is 20.

virtual void vtkIncrementalForceLayout::SetGravity ( float  )
virtual

Set the amount of gravitational pull toward the gravity point. Default is 0.01.

virtual float vtkIncrementalForceLayout::GetGravity ( )
virtual

Set the amount of gravitational pull toward the gravity point. Default is 0.01.

virtual void vtkIncrementalForceLayout::SetFriction ( float  )
virtual

Set the multiplier for scaling down velocity in the simulation, where values closer to 1 are more frictionless. Default is 0.95.

virtual float vtkIncrementalForceLayout::GetFriction ( )
virtual

Set the multiplier for scaling down velocity in the simulation, where values closer to 1 are more frictionless. Default is 0.95.

virtual void vtkIncrementalForceLayout::SetGravityPoint ( const vtkVector2f point)
inlinevirtual

Set the gravity point where all vertices will migrate. Generally this should be set to the location in the center of the scene. Default location is (200, 200).

Definition at line 113 of file vtkIncrementalForceLayout.h.

virtual vtkVector2f vtkIncrementalForceLayout::GetGravityPoint ( )
inlinevirtual

Set the gravity point where all vertices will migrate. Generally this should be set to the location in the center of the scene. Default location is (200, 200).

Definition at line 115 of file vtkIncrementalForceLayout.h.

void vtkIncrementalForceLayout::UpdatePositions ( )

Perform one iteration of the force-directed layout.

Member Data Documentation

vtkGraph* vtkIncrementalForceLayout::Graph
protected

Definition at line 127 of file vtkIncrementalForceLayout.h.

Implementation* vtkIncrementalForceLayout::Impl
protected

Definition at line 128 of file vtkIncrementalForceLayout.h.

vtkIdType vtkIncrementalForceLayout::Fixed
protected

Definition at line 130 of file vtkIncrementalForceLayout.h.

vtkVector2f vtkIncrementalForceLayout::GravityPoint
protected

Definition at line 131 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Alpha
protected

Definition at line 132 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Theta
protected

Definition at line 133 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Charge
protected

Definition at line 134 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Strength
protected

Definition at line 135 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Distance
protected

Definition at line 136 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Gravity
protected

Definition at line 137 of file vtkIncrementalForceLayout.h.

float vtkIncrementalForceLayout::Friction
protected

Definition at line 138 of file vtkIncrementalForceLayout.h.


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