VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkGraphLayoutStrategy Class Reference

abstract superclass for all graph layout strategies More...

#include <vtkGraphLayoutStrategy.h>

Inheritance diagram for vtkGraphLayoutStrategy:
Inheritance graph
[legend]
Collaboration diagram for vtkGraphLayoutStrategy:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkGraphLayoutStrategyNewInstance () 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 vtkGraphLayoutStrategySafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkGraphLayoutStrategy ()
 ~vtkGraphLayoutStrategy ()

Protected Attributes

vtkGraphGraph
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


Member Function Documentation

static int vtkGraphLayoutStrategy::IsTypeOf ( const char *  name) [static]
virtual int vtkGraphLayoutStrategy::IsA ( const char *  name) [virtual]
virtual vtkObjectBase* vtkGraphLayoutStrategy::NewInstanceInternal ( ) const [protected, virtual]
void vtkGraphLayoutStrategy::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]
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]
virtual int vtkGraphLayoutStrategy::IsLayoutComplete ( ) [inline, virtual]
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

Definition at line 83 of file vtkGraphLayoutStrategy.h.

Definition at line 84 of file vtkGraphLayoutStrategy.h.

Definition at line 85 of file vtkGraphLayoutStrategy.h.


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