a simple 2D graph layout More...

#include <vtkSimple2DLayoutStrategy.h>

Inheritance diagram for vtkSimple2DLayoutStrategy:

Collaboration diagram for vtkSimple2DLayoutStrategy:

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

vtkSimple2DLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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


virtual void	SetRandomSeed (int)
	Seed the random number generator used to jitter point positions. More...

virtual int	GetRandomSeed ()
	Seed the random number generator used to jitter point positions. More...


virtual void	SetMaxNumberOfIterations (int)
	Set/Get the maximum number of iterations to be used. More...

virtual int	GetMaxNumberOfIterations ()
	Set/Get the maximum number of iterations to be used. More...


virtual void	SetIterationsPerLayout (int)
	Set/Get the number of iterations per layout. More...

virtual int	GetIterationsPerLayout ()
	Set/Get the number of iterations per layout. More...


virtual void	SetInitialTemperature (float)
	Set the initial temperature. More...

virtual float	GetInitialTemperature ()
	Set the initial temperature. More...


virtual void	SetCoolDownRate (double)
	Set/Get the Cool-down rate. More...

virtual double	GetCoolDownRate ()
	Set/Get the Cool-down rate. More...


virtual void	SetJitter (bool)
	Set Random jitter of the nodes at initialization to on or off. More...

virtual bool	GetJitter ()
	Set Random jitter of the nodes at initialization to on or off. More...


virtual void	SetRestDistance (float)
	Manually set the resting distance. More...

virtual float	GetRestDistance ()
	Manually set the resting distance. More...

Public Member Functions inherited from vtkGraphLayoutStrategy
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkGraphLayoutStrategy *	NewInstance () 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	Initialize ()
	This method allows the layout strategy to do initialization of data structures or whatever else it might want to do. More...

virtual void	Layout ()=0
	This is the layout method where the graph that was set in SetGraph() is laid out. More...

virtual int	IsLayoutComplete ()
	If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;. More...

virtual void	SetWeightEdges (bool state)
	Whether to use edge weights in the layout or not. More...

virtual bool	GetWeightEdges ()
	Whether to use edge weights in the layout or not. More...

virtual void	SetEdgeWeightField (const char *field)
	Set/Get the field to use for the edge weights. More...

virtual char *	GetEdgeWeightField ()
	Set/Get the field to use for the edge weights. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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	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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkSimple2DLayoutStrategy *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSimple2DLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkGraphLayoutStrategy
static vtkTypeBool	IsTypeOf (const char *type)

static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSimple2DLayoutStrategy ()

	~vtkSimple2DLayoutStrategy () override

Protected Member Functions inherited from vtkGraphLayoutStrategy
virtual vtkObjectBase *	NewInstanceInternal () const

	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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	MaxNumberOfIterations

float	InitialTemperature

float	CoolDownRate

Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraph *	Graph

char *	EdgeWeightField

bool	WeightEdges

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a simple 2D graph layout

This class is an implementation of the work presented in: Fruchterman & Reingold "Graph Drawing by Force-directed Placement" Software-Practice and Experience 21(11) 1991). The class includes some optimizations but nothing too fancy.

Thanks:: Thanks to Brian Wylie from Sandia National Laboratories for creating this class.

Online Examples:

SelectedVerticesAndEdges

VisualizeDirectedGraph

VisualizeGraph

XGMLReader

Definition at line 92 of file vtkSimple2DLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkGraphLayoutStrategy vtkSimple2DLayoutStrategy::Superclass

Definition at line 97 of file vtkSimple2DLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkSimple2DLayoutStrategy()

vtkSimple2DLayoutStrategy::vtkSimple2DLayoutStrategy ( )

protected

◆ ~vtkSimple2DLayoutStrategy()

vtkSimple2DLayoutStrategy::~vtkSimple2DLayoutStrategy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSimple2DLayoutStrategy * vtkSimple2DLayoutStrategy::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy * vtkSimple2DLayoutStrategy::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSimple2DLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkSimple2DLayoutStrategy * vtkSimple2DLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkSimple2DLayoutStrategy::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 vtkGraphLayoutStrategy.

◆ SetRandomSeed()

virtual void vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy::GetRandomSeed ( )

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.

◆ SetMaxNumberOfIterations()

virtual void vtkSimple2DLayoutStrategy::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 '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

◆ GetMaxNumberOfIterations()

virtual int vtkSimple2DLayoutStrategy::GetMaxNumberOfIterations ( )

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 '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

◆ SetIterationsPerLayout()

virtual void vtkSimple2DLayoutStrategy::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 '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

◆ GetIterationsPerLayout()

virtual int vtkSimple2DLayoutStrategy::GetIterationsPerLayout ( )

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 '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

◆ SetInitialTemperature()

virtual void vtkSimple2DLayoutStrategy::SetInitialTemperature ( float )

virtual

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

◆ GetInitialTemperature()

virtual float vtkSimple2DLayoutStrategy::GetInitialTemperature ( )

virtual

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

◆ SetCoolDownRate()

virtual void vtkSimple2DLayoutStrategy::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. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

◆ GetCoolDownRate()

virtual double vtkSimple2DLayoutStrategy::GetCoolDownRate ( )

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. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

◆ SetJitter()

virtual void vtkSimple2DLayoutStrategy::SetJitter ( bool )

virtual

Set Random jitter of the nodes at initialization to on or off.

Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON

◆ GetJitter()

virtual bool vtkSimple2DLayoutStrategy::GetJitter ( )

virtual

Set Random jitter of the nodes at initialization to on or off.

Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON

◆ SetRestDistance()

virtual void vtkSimple2DLayoutStrategy::SetRestDistance ( float )

virtual

Manually set the resting distance.

Otherwise the distance is computed automatically.

◆ GetRestDistance()

virtual float vtkSimple2DLayoutStrategy::GetRestDistance ( )

virtual

Manually set the resting distance.

Otherwise the distance is computed automatically.

◆ Initialize()

void vtkSimple2DLayoutStrategy::Initialize ( )

overridevirtual

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

Reimplemented from vtkGraphLayoutStrategy.

◆ Layout()

void vtkSimple2DLayoutStrategy::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 vtkSimple2DLayoutStrategy::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 199 of file vtkSimple2DLayoutStrategy.h.

Member Data Documentation

◆ MaxNumberOfIterations

int vtkSimple2DLayoutStrategy::MaxNumberOfIterations

protected

Definition at line 205 of file vtkSimple2DLayoutStrategy.h.

◆ InitialTemperature

float vtkSimple2DLayoutStrategy::InitialTemperature

protected

Definition at line 206 of file vtkSimple2DLayoutStrategy.h.

◆ CoolDownRate

float vtkSimple2DLayoutStrategy::CoolDownRate

protected

Definition at line 207 of file vtkSimple2DLayoutStrategy.h.

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

Infovis/Layout/vtkSimple2DLayoutStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSimple2DLayoutStrategy()

◆ ~vtkSimple2DLayoutStrategy()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetRandomSeed()

◆ GetRandomSeed()

◆ SetMaxNumberOfIterations()

◆ GetMaxNumberOfIterations()

◆ SetIterationsPerLayout()

◆ GetIterationsPerLayout()

◆ SetInitialTemperature()

◆ GetInitialTemperature()

◆ SetCoolDownRate()

◆ GetCoolDownRate()

◆ SetJitter()

◆ GetJitter()

◆ SetRestDistance()

◆ GetRestDistance()

◆ Initialize()

◆ Layout()

◆ IsLayoutComplete()

Member Data Documentation

◆ MaxNumberOfIterations

◆ InitialTemperature

◆ CoolDownRate