incremental force-directed layout. More...

#include <vtkIncrementalForceLayout.h>

Inheritance diagram for vtkIncrementalForceLayout:

Collaboration diagram for vtkIncrementalForceLayout:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkIncrementalForceLayout *	SafeDownCast (vtkObjectBase *o)

static vtkIncrementalForceLayout *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkIncrementalForceLayout ()

	~vtkIncrementalForceLayout ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
vtkGraph *	Graph

Implementation *	Impl

vtkIdType	Fixed

vtkVector2f	GravityPoint

float	Alpha

float	Theta

float	Charge

float	Strength

float	Distance

float	Gravity

float	Friction

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

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

virtual vtkObjectBase* vtkIncrementalForceLayout::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkIncrementalForceLayout* vtkIncrementalForceLayout::NewInstance ( ) const

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

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.