incremental force-directed layout. More...

#include <vtkIncrementalForceLayout.h>

Inheritance diagram for vtkIncrementalForceLayout:

Collaboration diagram for vtkIncrementalForceLayout:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkIncrementalForceLayout *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
void	UpdatePositions ()

virtual void	SetGraph (vtkGraph *g)
virtual vtkGraph *	GetGraph ()

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 vtkIncrementalForceLayout *	SafeDownCast (vtkObjectBase *o)
static vtkIncrementalForceLayout *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkIncrementalForceLayout ()
	~vtkIncrementalForceLayout ()
Protected Attributes
vtkGraph *	Graph
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

typedef vtkObject vtkIncrementalForceLayout::Superclass

Reimplemented from vtkObject.

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 * 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 vtkObject.

virtual int vtkIncrementalForceLayout::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 vtkObject.

static vtkIncrementalForceLayout* vtkIncrementalForceLayout::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

vtkIncrementalForceLayout* vtkIncrementalForceLayout::NewInstance ( ) const

Reimplemented from vtkObject.

virtual void vtkIncrementalForceLayout::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 vtkObject.

static vtkIncrementalForceLayout* vtkIncrementalForceLayout::New ( ) [static]

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

Reimplemented from vtkObject.

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 ) [inline, virtual]

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 ( ) [inline, virtual]

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.