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

Iterates all vertices in a graph. More...

#include <vtkVertexListIterator.h>

Inheritance diagram for vtkVertexListIterator:
[legend]
Collaboration diagram for vtkVertexListIterator:
[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...
 
vtkVertexListIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetGraph (vtkGraph *graph)
 Setup the iterator with a graph. More...
 
virtual vtkGraphGetGraph ()
 Get the graph associated with this iterator. More...
 
vtkIdType Next ()
 Returns the next edge in the graph. More...
 
bool HasNext ()
 Whether this iterator has more edges. 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 vtkVertexListIteratorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVertexListIteratorSafeDownCast (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
 
 vtkVertexListIterator ()
 
 ~vtkVertexListIterator () override
 
- 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

vtkGraphGraph
 
vtkIdType Current
 
vtkIdType End
 
- 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

Iterates all vertices in a graph.

vtkVertexListIterator iterates through all vertices in a graph. Create an instance of this and call graph->GetVertices(it) to initialize this iterator. You may alternately call SetGraph() to initialize the iterator.

See also
vtkGraph

Definition at line 44 of file vtkVertexListIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkVertexListIterator.h.

Constructor & Destructor Documentation

◆ vtkVertexListIterator()

vtkVertexListIterator::vtkVertexListIterator ( )
protected

◆ ~vtkVertexListIterator()

vtkVertexListIterator::~vtkVertexListIterator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkVertexListIterator* vtkVertexListIterator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkVertexListIterator::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 vtkVertexListIterator* vtkVertexListIterator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVertexListIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkVertexListIterator* vtkVertexListIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkVertexListIterator::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()

virtual void vtkVertexListIterator::SetGraph ( vtkGraph graph)
virtual

Setup the iterator with a graph.

◆ GetGraph()

virtual vtkGraph* vtkVertexListIterator::GetGraph ( )
virtual

Get the graph associated with this iterator.

◆ Next()

vtkIdType vtkVertexListIterator::Next ( )
inline

Returns the next edge in the graph.

Definition at line 67 of file vtkVertexListIterator.h.

◆ HasNext()

bool vtkVertexListIterator::HasNext ( )
inline

Whether this iterator has more edges.

Definition at line 78 of file vtkVertexListIterator.h.

Member Data Documentation

◆ Graph

vtkGraph* vtkVertexListIterator::Graph
protected

Definition at line 84 of file vtkVertexListIterator.h.

◆ Current

vtkIdType vtkVertexListIterator::Current
protected

Definition at line 85 of file vtkVertexListIterator.h.

◆ End

vtkIdType vtkVertexListIterator::End
protected

Definition at line 86 of file vtkVertexListIterator.h.


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