a simple fast 2D graph layout that looks for a community array on it's input and strengthens edges within a community and weakens edges not within the community. More...

#include <vtkCommunity2DLayoutStrategy.h>

Inheritance diagram for vtkCommunity2DLayoutStrategy:

[legend]

Collaboration diagram for vtkCommunity2DLayoutStrategy:

[legend]

Public Types
typedef vtkGraphLayoutStrategy	Superclass

Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCommunity2DLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Initialize ()

virtual void	Layout ()

virtual int	IsLayoutComplete ()


virtual void	SetRandomSeed (int)

virtual int	GetRandomSeed ()


virtual void	SetMaxNumberOfIterations (int)

virtual int	GetMaxNumberOfIterations ()


virtual void	SetIterationsPerLayout (int)

virtual int	GetIterationsPerLayout ()


virtual void	SetInitialTemperature (float)

virtual float	GetInitialTemperature ()


virtual void	SetCoolDownRate (double)

virtual double	GetCoolDownRate ()


virtual void	SetRestDistance (float)

virtual float	GetRestDistance ()


virtual char *	GetCommunityArrayName ()

virtual void	SetCommunityArrayName (const char *)


virtual void	SetCommunityStrength (float)

virtual float	GetCommunityStrength ()

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetGraph (vtkGraph *graph)

virtual void	SetWeightEdges (bool state)

virtual bool	GetWeightEdges ()

virtual void	SetEdgeWeightField (const char *field)

virtual char *	GetEdgeWeightField ()

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 vtkCommunity2DLayoutStrategy *	New ()

static int	IsTypeOf (const char *type)

static vtkCommunity2DLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

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

static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

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

	vtkCommunity2DLayoutStrategy ()

	~vtkCommunity2DLayoutStrategy ()

Protected Member Functions inherited from vtkGraphLayoutStrategy
	vtkGraphLayoutStrategy ()

	~vtkGraphLayoutStrategy ()

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
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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

a simple fast 2D graph layout that looks for a community array on it's input and strengthens edges within a community and weakens edges not within the community.

This class is a density grid based force directed layout strategy. Also please note that 'fast' is relative to quite slow. :) The layout running time is O(V+E) with an extremely high constant.

Thanks:: Thanks to Godzilla for not eating my computer so that this class could be written.

Events:: vtkCommand::ProgressEvent

Definition at line 49 of file vtkCommunity2DLayoutStrategy.h.

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkCommunity2DLayoutStrategy::Superclass

Definition at line 54 of file vtkCommunity2DLayoutStrategy.h.

Constructor & Destructor Documentation

vtkCommunity2DLayoutStrategy::vtkCommunity2DLayoutStrategy ( )

protected

vtkCommunity2DLayoutStrategy::~vtkCommunity2DLayoutStrategy ( )

protected

Member Function Documentation

static vtkCommunity2DLayoutStrategy* vtkCommunity2DLayoutStrategy::New ( )

static

static int vtkCommunity2DLayoutStrategy::IsTypeOf ( const char * type )

static

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

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

static

virtual vtkObjectBase* vtkCommunity2DLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

vtkCommunity2DLayoutStrategy* vtkCommunity2DLayoutStrategy::NewInstance ( ) const

void vtkCommunity2DLayoutStrategy::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.

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

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

virtual void vtkCommunity2DLayoutStrategy::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. :)

virtual int vtkCommunity2DLayoutStrategy::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. :)

virtual void vtkCommunity2DLayoutStrategy::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 :)

virtual int vtkCommunity2DLayoutStrategy::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 :)

virtual void vtkCommunity2DLayoutStrategy::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. :)

virtual float vtkCommunity2DLayoutStrategy::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. :)

virtual void vtkCommunity2DLayoutStrategy::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. :)

virtual double vtkCommunity2DLayoutStrategy::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. :)

virtual void vtkCommunity2DLayoutStrategy::SetRestDistance ( float )

virtual

Manually set the resting distance. Otherwise the distance is computed automatically.

virtual float vtkCommunity2DLayoutStrategy::GetRestDistance ( )

virtual

Manually set the resting distance. Otherwise the distance is computed automatically.

virtual void vtkCommunity2DLayoutStrategy::Initialize ( )

virtual

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

Reimplemented from vtkGraphLayoutStrategy.

virtual void vtkCommunity2DLayoutStrategy::Layout ( )

virtual

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.

virtual int vtkCommunity2DLayoutStrategy::IsLayoutComplete ( )

inlinevirtual

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 121 of file vtkCommunity2DLayoutStrategy.h.

virtual char* vtkCommunity2DLayoutStrategy::GetCommunityArrayName ( )

virtual

Get/Set the community array name

virtual void vtkCommunity2DLayoutStrategy::SetCommunityArrayName ( const char * )

virtual

Get/Set the community array name

virtual void vtkCommunity2DLayoutStrategy::SetCommunityStrength ( float )

virtual

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.

virtual float vtkCommunity2DLayoutStrategy::GetCommunityStrength ( )

virtual

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.