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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMutableGraphHelperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetGraph (vtkGraph *g)
 Set the underlying graph that you want to modify with this helper. More...
 
vtkGraphGetGraph ()
 
vtkEdgeType AddEdge (vtkIdType u, vtkIdType v)
 Add an edge to the underlying mutable graph. More...
 
vtkGraphEdgeAddGraphEdge (vtkIdType u, vtkIdType v)
 
vtkIdType AddVertex ()
 Add a vertex to the underlying mutable graph. More...
 
void RemoveVertex (vtkIdType v)
 Remove a vertex from the underlying mutable graph. More...
 
void RemoveVertices (vtkIdTypeArray *verts)
 Remove a collection of vertices from the underlying mutable graph. More...
 
void RemoveEdge (vtkIdType e)
 Remove an edge from the underlying mutable graph. More...
 
void RemoveEdges (vtkIdTypeArray *edges)
 Remove a collection of edges from the underlying mutable graph. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkMutableGraphHelperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMutableGraphHelperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMutableGraphHelper ()
 
 ~vtkMutableGraphHelper () override
 
virtual vtkGraphGetInternalGraph ()
 
void SetInternalGraph (vtkGraph *g)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkGraphInternalGraph
 
vtkGraphEdgeGraphEdge
 
vtkMutableDirectedGraphDirectedGraph
 
vtkMutableUndirectedGraphUndirectedGraph
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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 47 of file vtkMutableGraphHelper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkMutableGraphHelper.h.

Constructor & Destructor Documentation

◆ vtkMutableGraphHelper()

vtkMutableGraphHelper::vtkMutableGraphHelper ( )
protected

◆ ~vtkMutableGraphHelper()

vtkMutableGraphHelper::~vtkMutableGraphHelper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkMutableGraphHelper* vtkMutableGraphHelper::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkMutableGraphHelper::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMutableGraphHelper::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkMutableGraphHelper* vtkMutableGraphHelper::NewInstance ( ) const

◆ PrintSelf()

void vtkMutableGraphHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetGraph()

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.

◆ GetGraph()

vtkGraph* vtkMutableGraphHelper::GetGraph ( )

◆ AddEdge()

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

Add an edge to the underlying mutable graph.

◆ AddGraphEdge()

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

◆ AddVertex()

vtkIdType vtkMutableGraphHelper::AddVertex ( )

Add a vertex to the underlying mutable graph.

◆ RemoveVertex()

void vtkMutableGraphHelper::RemoveVertex ( vtkIdType  v)

Remove a vertex from the underlying mutable graph.

◆ RemoveVertices()

void vtkMutableGraphHelper::RemoveVertices ( vtkIdTypeArray verts)

Remove a collection of vertices from the underlying mutable graph.

◆ RemoveEdge()

void vtkMutableGraphHelper::RemoveEdge ( vtkIdType  e)

Remove an edge from the underlying mutable graph.

◆ RemoveEdges()

void vtkMutableGraphHelper::RemoveEdges ( vtkIdTypeArray edges)

Remove a collection of edges from the underlying mutable graph.

◆ GetInternalGraph()

virtual vtkGraph* vtkMutableGraphHelper::GetInternalGraph ( )
protectedvirtual

◆ SetInternalGraph()

void vtkMutableGraphHelper::SetInternalGraph ( vtkGraph g)
protected

Member Data Documentation

◆ InternalGraph

vtkGraph* vtkMutableGraphHelper::InternalGraph
protected

Definition at line 102 of file vtkMutableGraphHelper.h.

◆ GraphEdge

vtkGraphEdge* vtkMutableGraphHelper::GraphEdge
protected

Definition at line 104 of file vtkMutableGraphHelper.h.

◆ DirectedGraph

vtkMutableDirectedGraph* vtkMutableGraphHelper::DirectedGraph
protected

Definition at line 106 of file vtkMutableGraphHelper.h.

◆ UndirectedGraph

vtkMutableUndirectedGraph* vtkMutableGraphHelper::UndirectedGraph
protected

Definition at line 107 of file vtkMutableGraphHelper.h.


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