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:
[legend]
Collaboration diagram for vtkGraphLayoutStrategy:
[legend]

List of all members.

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject

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 ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
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 vtkGraphLayoutStrategySafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkGraphGraph
char * EdgeWeightField
bool WeightEdges
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int 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 43 of file vtkGraphLayoutStrategy.h.


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 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 54 of file vtkGraphLayoutStrategy.h.

virtual void vtkGraphLayoutStrategy::Layout ( )
pure virtual
virtual int vtkGraphLayoutStrategy::IsLayoutComplete ( )
inlinevirtual
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 82 of file vtkGraphLayoutStrategy.h.

char* vtkGraphLayoutStrategy::EdgeWeightField
protected

Definition at line 83 of file vtkGraphLayoutStrategy.h.

bool vtkGraphLayoutStrategy::WeightEdges
protected

Definition at line 84 of file vtkGraphLayoutStrategy.h.


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