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 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 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGraphLayoutStrategy ()
	~vtkGraphLayoutStrategy ()
Protected Attributes
vtkGraph *	Graph
char *	EdgeWeightField
bool	WeightEdges

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

Constructor & Destructor Documentation

vtkGraphLayoutStrategy::vtkGraphLayoutStrategy ( ) [protected]

vtkGraphLayoutStrategy::~vtkGraphLayoutStrategy ( ) [protected]

Member Function Documentation

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

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

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.

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, vtkConeLayoutStrategy, vtkFast2DLayoutStrategy, vtkTreeLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkSimple3DCirclesStrategy, vtkSimple2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkForceDirectedLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCircularLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, 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 ( ) [inline, virtual]

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.