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

iterator through a vtkCollection. More...

#include <vtkCollectionIterator.h>

Inheritance diagram for vtkCollectionIterator:
[legend]
Collaboration diagram for vtkCollectionIterator:
[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...
 
vtkCollectionIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetCollection (vtkCollection *)
 Set/Get the collection over which to iterate. More...
 
virtual vtkCollectionGetCollection ()
 
void InitTraversal ()
 Position the iterator at the first item in the collection. More...
 
void GoToFirstItem ()
 Position the iterator at the first item in the collection. More...
 
void GoToNextItem ()
 Move the iterator to the next item in the collection. More...
 
int IsDoneWithTraversal ()
 Test whether the iterator is currently positioned at a valid item. More...
 
vtkObjectGetCurrentObject ()
 Get the item at the current iterator position. 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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkCollectionIteratorSafeDownCast (vtkObjectBase *o)
 
static vtkCollectionIteratorNew ()
 
- 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
 
 vtkCollectionIterator ()
 
 ~vtkCollectionIterator () override
 
vtkObjectGetObjectInternal ()
 
- 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

vtkCollectionCollection
 
vtkCollectionElementElement
 
- 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

iterator through a vtkCollection.

vtkCollectionIterator provides an alternative way to traverse through the objects in a vtkCollection. Unlike the collection's built in interface, this allows multiple iterators to simultaneously traverse the collection. If items are removed from the collection, only the iterators currently pointing to those items are invalidated. Other iterators will still continue to function normally.

Definition at line 37 of file vtkCollectionIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkCollectionIterator.h.

Constructor & Destructor Documentation

◆ vtkCollectionIterator()

vtkCollectionIterator::vtkCollectionIterator ( )
protected

◆ ~vtkCollectionIterator()

vtkCollectionIterator::~vtkCollectionIterator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCollectionIterator::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.

Reimplemented in vtkDataArrayCollectionIterator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCollectionIterator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkDataArrayCollectionIterator.

◆ NewInstance()

vtkCollectionIterator* vtkCollectionIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkCollectionIterator::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 vtkObjectBase.

Reimplemented in vtkDataArrayCollectionIterator.

◆ New()

static vtkCollectionIterator* vtkCollectionIterator::New ( )
static

◆ SetCollection()

virtual void vtkCollectionIterator::SetCollection ( vtkCollection )
virtual

Set/Get the collection over which to iterate.

Reimplemented in vtkDataArrayCollectionIterator.

◆ GetCollection()

virtual vtkCollection* vtkCollectionIterator::GetCollection ( )
virtual

◆ InitTraversal()

void vtkCollectionIterator::InitTraversal ( )
inline

Position the iterator at the first item in the collection.

Definition at line 55 of file vtkCollectionIterator.h.

◆ GoToFirstItem()

void vtkCollectionIterator::GoToFirstItem ( )

Position the iterator at the first item in the collection.

◆ GoToNextItem()

void vtkCollectionIterator::GoToNextItem ( )

Move the iterator to the next item in the collection.

◆ IsDoneWithTraversal()

int vtkCollectionIterator::IsDoneWithTraversal ( )

Test whether the iterator is currently positioned at a valid item.

Returns 1 for yes, 0 for no.

◆ GetCurrentObject()

vtkObject* vtkCollectionIterator::GetCurrentObject ( )

Get the item at the current iterator position.

Valid only when IsDoneWithTraversal() returns 1.

◆ GetObjectInternal()

vtkObject* vtkCollectionIterator::GetObjectInternal ( )
protected

Member Data Documentation

◆ Collection

vtkCollection* vtkCollectionIterator::Collection
protected

Definition at line 84 of file vtkCollectionIterator.h.

◆ Element

vtkCollectionElement* vtkCollectionIterator::Element
protected

Definition at line 87 of file vtkCollectionIterator.h.


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