vtkGraphLayoutStrategy Class Reference

#include <vtkGraphLayoutStrategy.h>

Inheritance diagram for vtkGraphLayoutStrategy:

Inheritance graph
Collaboration diagram for vtkGraphLayoutStrategy:

Collaboration graph

List of all members.

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 to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.

Definition at line 43 of file vtkGraphLayoutStrategy.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 (vtkObject *o)

Protected Member Functions

 vtkGraphLayoutStrategy ()
 ~vtkGraphLayoutStrategy ()

Protected Attributes

char * EdgeWeightField
bool WeightEdges

Member Typedef Documentation

Constructor & Destructor Documentation

vtkGraphLayoutStrategy::vtkGraphLayoutStrategy (  )  [protected]

vtkGraphLayoutStrategy::~vtkGraphLayoutStrategy (  )  [protected]

Member Function Documentation

virtual const char* vtkGraphLayoutStrategy::GetClassName (  )  [virtual]

static int vtkGraphLayoutStrategy::IsTypeOf ( const char *  name  )  [static]

virtual int vtkGraphLayoutStrategy::IsA ( const char *  name  )  [virtual]

static vtkGraphLayoutStrategy* vtkGraphLayoutStrategy::SafeDownCast ( vtkObject o  )  [static]

void vtkGraphLayoutStrategy::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

virtual void vtkGraphLayoutStrategy::SetGraph ( vtkGraph graph  )  [virtual]

Setting the graph for the layout strategy

Reimplemented in vtkRandomLayoutStrategy, and vtkSimple3DCirclesStrategy.

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 vtkAttributeClustering2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkForceDirectedLayoutStrategy, vtkPassThroughLayoutStrategy, and vtkSimple2DLayoutStrategy.

Definition at line 54 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 82 of file vtkGraphLayoutStrategy.h.

Definition at line 83 of file vtkGraphLayoutStrategy.h.

Definition at line 84 of file vtkGraphLayoutStrategy.h.

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

Generated on Mon Sep 27 18:26:17 2010 for VTK by  doxygen 1.5.6