abstract superclass for all graph layout strategies More...

#include <vtkGraphLayoutStrategy.h>

Inheritance diagram for vtkGraphLayoutStrategy:

Collaboration diagram for vtkGraphLayoutStrategy:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkGraphLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetGraph (vtkGraph *graph)

virtual void	Initialize ()

virtual void	Layout ()=0

virtual int	IsLayoutComplete ()


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

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

abstract superclass for all graph layout strategies

All graph layouts should subclass from this class. vtkGraphLayoutStrategy works as a plug-in to the vtkGraphLayout algorithm. The Layout() function should perform some reasonable "chunk" of the layout. This allows the user to be able to see the progress of the layout. Use IsLayoutComplete() to tell the user when there is no more layout to perform.

Thanks:: Thanks to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.

Definition at line 44 of file vtkGraphLayoutStrategy.h.

Member Typedef Documentation

typedef vtkObject vtkGraphLayoutStrategy::Superclass

Definition at line 47 of file vtkGraphLayoutStrategy.h.

Constructor & Destructor Documentation

vtkGraphLayoutStrategy::vtkGraphLayoutStrategy ( )

protected

vtkGraphLayoutStrategy::~vtkGraphLayoutStrategy ( )

protected

Member Function Documentation

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

static

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

Reimplemented in vtkSpanTreeLayoutStrategy, vtkConeLayoutStrategy, vtkFast2DLayoutStrategy, vtkTreeLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkSimple3DCirclesStrategy, vtkSimple2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkForceDirectedLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCircularLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, and vtkTreeOrbitLayoutStrategy.

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

static

virtual vtkObjectBase* vtkGraphLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkSpanTreeLayoutStrategy, vtkConeLayoutStrategy, vtkFast2DLayoutStrategy, vtkTreeLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkSimple3DCirclesStrategy, vtkSimple2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkForceDirectedLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCircularLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, and vtkTreeOrbitLayoutStrategy.

vtkGraphLayoutStrategy* vtkGraphLayoutStrategy::NewInstance ( ) const

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

Reimplemented in vtkSpanTreeLayoutStrategy, vtkTreeLayoutStrategy, vtkSimple3DCirclesStrategy, vtkSimple2DLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, and vtkTreeOrbitLayoutStrategy.

virtual void vtkGraphLayoutStrategy::SetGraph ( vtkGraph * graph )

virtual

Setting the graph for the layout strategy

Reimplemented in vtkSimple3DCirclesStrategy, and vtkRandomLayoutStrategy.

virtual void vtkGraphLayoutStrategy::Initialize ( )

inlinevirtual

This method allows the layout strategy to do initialization of data structures or whatever else it might want to do.

Reimplemented in vtkForceDirectedLayoutStrategy, vtkSimple2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkClustering2DLayoutStrategy, and vtkPassThroughLayoutStrategy.

Definition at line 55 of file vtkGraphLayoutStrategy.h.

virtual void vtkGraphLayoutStrategy::Layout ( )

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

Implemented in vtkSimple3DCirclesStrategy, vtkForceDirectedLayoutStrategy, vtkSimple2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkConeLayoutStrategy, vtkSpanTreeLayoutStrategy, vtkRandomLayoutStrategy, vtkTreeLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkCircularLayoutStrategy, and vtkTreeOrbitLayoutStrategy.

virtual int vtkGraphLayoutStrategy::IsLayoutComplete ( )

inlinevirtual

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

Reimplemented in vtkForceDirectedLayoutStrategy, vtkSimple2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkClustering2DLayoutStrategy, and vtkPassThroughLayoutStrategy.

Definition at line 65 of file vtkGraphLayoutStrategy.h.

virtual void vtkGraphLayoutStrategy::SetWeightEdges ( bool state )

virtual

Whether to use edge weights in the layout or not.

virtual bool vtkGraphLayoutStrategy::GetWeightEdges ( )

virtual

Whether to use edge weights in the layout or not.

virtual void vtkGraphLayoutStrategy::SetEdgeWeightField ( const char * field )

virtual

Set/Get the field to use for the edge weights.

virtual char* vtkGraphLayoutStrategy::GetEdgeWeightField ( )

virtual

Set/Get the field to use for the edge weights.

Member Data Documentation

vtkGraph* vtkGraphLayoutStrategy::Graph

protected

Definition at line 83 of file vtkGraphLayoutStrategy.h.

char* vtkGraphLayoutStrategy::EdgeWeightField

protected

Definition at line 84 of file vtkGraphLayoutStrategy.h.

bool vtkGraphLayoutStrategy::WeightEdges

protected

Definition at line 85 of file vtkGraphLayoutStrategy.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Infovis/Layout/vtkGraphLayoutStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation