VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMutableGraphHelper Class Reference

Helper class for building a directed or directed graph. More...

#include <vtkMutableGraphHelper.h>

Inheritance diagram for vtkMutableGraphHelper:
[legend]
Collaboration diagram for vtkMutableGraphHelper:
[legend]

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkIdType AddVertex ()
void RemoveVertex (vtkIdType v)
void RemoveVertices (vtkIdTypeArray *verts)
void RemoveEdge (vtkIdType e)
void RemoveEdges (vtkIdTypeArray *edges)
void SetGraph (vtkGraph *g)
vtkGraphGetGraph ()
vtkEdgeType AddEdge (vtkIdType u, vtkIdType v)
vtkGraphEdgeAddGraphEdge (vtkIdType u, vtkIdType v)
- 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 vtkMutableGraphHelperNew ()
static int IsTypeOf (const char *type)
static vtkMutableGraphHelperSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkMutableGraphHelper ()
 ~vtkMutableGraphHelper ()
virtual vtkGraphGetInternalGraph ()
void SetInternalGraph (vtkGraph *g)
- 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

vtkGraphInternalGraph
vtkGraphEdgeGraphEdge
vtkMutableDirectedGraphDirectedGraph
vtkMutableUndirectedGraphUndirectedGraph
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

Helper class for building a directed or directed graph.

vtkMutableGraphHelper has helper methods AddVertex and AddEdge which add vertices/edges to the underlying mutable graph. This is helpful in filters which need to (re)construct graphs which may be either directed or undirected.

See Also
vtkGraph vtkMutableDirectedGraph vtkMutableUndirectedGraph

Definition at line 45 of file vtkMutableGraphHelper.h.

Member Typedef Documentation

Definition at line 49 of file vtkMutableGraphHelper.h.

Constructor & Destructor Documentation

vtkMutableGraphHelper::vtkMutableGraphHelper ( )
protected
vtkMutableGraphHelper::~vtkMutableGraphHelper ( )
protected

Member Function Documentation

static vtkMutableGraphHelper* vtkMutableGraphHelper::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkMutableGraphHelper::GetClassName ( )
virtual

Reimplemented from vtkObject.

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

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

static vtkMutableGraphHelper* vtkMutableGraphHelper::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkObject.

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

void vtkMutableGraphHelper::SetGraph ( vtkGraph g)

Set the underlying graph that you want to modify with this helper. The graph must be an instance of vtkMutableDirectedGraph or vtkMutableUndirectedGraph.

vtkGraph* vtkMutableGraphHelper::GetGraph ( )

Set the underlying graph that you want to modify with this helper. The graph must be an instance of vtkMutableDirectedGraph or vtkMutableUndirectedGraph.

vtkEdgeType vtkMutableGraphHelper::AddEdge ( vtkIdType  u,
vtkIdType  v 
)

Add an edge to the underlying mutable graph.

vtkGraphEdge* vtkMutableGraphHelper::AddGraphEdge ( vtkIdType  u,
vtkIdType  v 
)

Add an edge to the underlying mutable graph.

vtkIdType vtkMutableGraphHelper::AddVertex ( )

Add a vertex to the underlying mutable graph.

void vtkMutableGraphHelper::RemoveVertex ( vtkIdType  v)

Remove a vertex from the underlying mutable graph.

void vtkMutableGraphHelper::RemoveVertices ( vtkIdTypeArray verts)

Remove a collection of vertices from the underlying mutable graph.

void vtkMutableGraphHelper::RemoveEdge ( vtkIdType  e)

Remove an edge from the underlying mutable graph.

void vtkMutableGraphHelper::RemoveEdges ( vtkIdTypeArray edges)

Remove a collection of edges from the underlying mutable graph.

virtual vtkGraph* vtkMutableGraphHelper::GetInternalGraph ( )
protectedvirtual
void vtkMutableGraphHelper::SetInternalGraph ( vtkGraph g)
protected

Member Data Documentation

vtkGraph* vtkMutableGraphHelper::InternalGraph
protected

Definition at line 89 of file vtkMutableGraphHelper.h.

vtkGraphEdge* vtkMutableGraphHelper::GraphEdge
protected

Definition at line 91 of file vtkMutableGraphHelper.h.

vtkMutableDirectedGraph* vtkMutableGraphHelper::DirectedGraph
protected

Definition at line 93 of file vtkMutableGraphHelper.h.

vtkMutableUndirectedGraph* vtkMutableGraphHelper::UndirectedGraph
protected

Definition at line 94 of file vtkMutableGraphHelper.h.


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