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

create and manipulate ordered lists of objects More...

#include <vtkCollection.h>

Inheritance diagram for vtkCollection:
[legend]
Collaboration diagram for vtkCollection:
[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...
 
vtkCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddItem (vtkObject *)
 Add an object to the bottom of the list. More...
 
void InsertItem (int i, vtkObject *)
 Insert item into the list after the i'th item. More...
 
void ReplaceItem (int i, vtkObject *)
 Replace the i'th item in the collection with another item. More...
 
void RemoveItem (int i)
 Remove the i'th item in the list. More...
 
void RemoveItem (vtkObject *)
 Remove an object from the list. More...
 
void RemoveAllItems ()
 Remove all objects from the list. More...
 
int IsItemPresent (vtkObject *a)
 Search for an object and return location in list. More...
 
int GetNumberOfItems ()
 Return the number of objects in the list. More...
 
void InitTraversal ()
 Initialize the traversal of the collection. More...
 
void InitTraversal (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to iterate through a collection. More...
 
vtkObjectGetNextItemAsObject ()
 Get the next item in the collection. More...
 
vtkObjectGetItemAsObject (int i)
 Get the i'th item in the collection. More...
 
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to get the next object as a collection. More...
 
vtkCollectionIteratorNewIterator ()
 Get an iterator to traverse the objects in this collection. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). 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)
 
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 vtkCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkCollectionNew ()
 Construct with empty list. More...
 
- 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
 
 vtkCollection ()
 
 ~vtkCollection () override
 
virtual void RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
 
virtual void DeleteElement (vtkCollectionElement *)
 
void ReportReferences (vtkGarbageCollector *collector) 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfItems
 
vtkCollectionElementTop
 
vtkCollectionElementBottom
 
vtkCollectionElementCurrent
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkCollectionIterator
 

Detailed Description

create and manipulate ordered lists of objects

vtkCollection is a general object for creating and manipulating lists of objects. The lists are ordered and allow duplicate entries. vtkCollection also serves as a base class for lists of specific types of objects.

See also
vtkActorCollection vtkAssemblyPaths vtkDataSetCollection vtkImplicitFunctionCollection vtkLightCollection vtkPolyDataCollection vtkRenderWindowCollection vtkRendererCollection vtkStructuredPointsCollection vtkTransformCollection vtkVolumeCollection

Definition at line 52 of file vtkCollection.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 of file vtkCollection.h.

Constructor & Destructor Documentation

◆ vtkCollection()

vtkCollection::vtkCollection ( )
protected

◆ ~vtkCollection()

vtkCollection::~vtkCollection ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCollection::IsA ( const char *  name)
virtual

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCollection::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCollection* vtkCollection::NewInstance ( ) const

◆ PrintSelf()

void vtkCollection::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 vtkAssemblyPath, vtkActorCollection, vtkLightCollection, vtkMapperCollection, vtkVolumeCollection, vtkRenderPassCollection, vtkPolyDataCollection, vtkCullerCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, vtkImageReader2Collection, vtkTextPropertyCollection, vtkStructuredPointsCollection, vtkSocketCollection, and vtkViewNodeCollection.

◆ New()

static vtkCollection* vtkCollection::New ( )
static

Construct with empty list.

◆ AddItem()

void vtkCollection::AddItem ( vtkObject )

Add an object to the bottom of the list.

Does not prevent duplicate entries.

◆ InsertItem()

void vtkCollection::InsertItem ( int  i,
vtkObject  
)

Insert item into the list after the i'th item.

Does not prevent duplicate entries. If i < 0 the item is placed at the top of the list.

◆ ReplaceItem()

void vtkCollection::ReplaceItem ( int  i,
vtkObject  
)

Replace the i'th item in the collection with another item.

◆ RemoveItem() [1/2]

void vtkCollection::RemoveItem ( int  i)

Remove the i'th item in the list.

Be careful if using this function during traversal of the list using GetNextItemAsObject (or GetNextItem in derived class). The list WILL be shortened if a valid index is given! If this->Current is equal to the element being removed, have it point to then next element in the list.

◆ RemoveItem() [2/2]

void vtkCollection::RemoveItem ( vtkObject )

Remove an object from the list.

Removes the first object found, not all occurrences. If no object found, list is unaffected. See warning in description of RemoveItem(int).

◆ RemoveAllItems()

void vtkCollection::RemoveAllItems ( )

Remove all objects from the list.

◆ IsItemPresent()

int vtkCollection::IsItemPresent ( vtkObject a)

Search for an object and return location in list.

If the return value is 0, the object was not found. If the object was found, the location is the return value-1.

◆ GetNumberOfItems()

int vtkCollection::GetNumberOfItems ( )
inline

Return the number of objects in the list.

Definition at line 110 of file vtkCollection.h.

◆ InitTraversal() [1/2]

void vtkCollection::InitTraversal ( )
inline

Initialize the traversal of the collection.

This means the data pointer is set at the beginning of the list.

Definition at line 116 of file vtkCollection.h.

◆ InitTraversal() [2/2]

void vtkCollection::InitTraversal ( vtkCollectionSimpleIterator cookie)
inline

A reentrant safe way to iterate through a collection.

Just pass the same cookie value around each time

Definition at line 122 of file vtkCollection.h.

◆ GetNextItemAsObject() [1/2]

vtkObject * vtkCollection::GetNextItemAsObject ( )
inline

Get the next item in the collection.

nullptr is returned if the collection is exhausted.

Definition at line 179 of file vtkCollection.h.

◆ GetItemAsObject()

vtkObject* vtkCollection::GetItemAsObject ( int  i)

Get the i'th item in the collection.

nullptr is returned if i is out of range

◆ GetNextItemAsObject() [2/2]

vtkObject * vtkCollection::GetNextItemAsObject ( vtkCollectionSimpleIterator cookie)
inline

A reentrant safe way to get the next object as a collection.

Just pass the same cookie back and forth.

Definition at line 194 of file vtkCollection.h.

◆ NewIterator()

vtkCollectionIterator* vtkCollection::NewIterator ( )

Get an iterator to traverse the objects in this collection.

◆ Register()

void vtkCollection::Register ( vtkObjectBase o)
overridevirtual

Participate in garbage collection.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkCollection::UnRegister ( vtkObjectBase o)
overridevirtual

Decrease the reference count (release by another object).

This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented from vtkObjectBase.

◆ RemoveElement()

virtual void vtkCollection::RemoveElement ( vtkCollectionElement element,
vtkCollectionElement previous 
)
protectedvirtual

◆ DeleteElement()

virtual void vtkCollection::DeleteElement ( vtkCollectionElement )
protectedvirtual

◆ ReportReferences()

void vtkCollection::ReportReferences ( vtkGarbageCollector collector)
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Friends And Related Function Documentation

◆ vtkCollectionIterator

friend class vtkCollectionIterator
friend

Definition at line 169 of file vtkCollection.h.

Member Data Documentation

◆ NumberOfItems

int vtkCollection::NumberOfItems
protected

Definition at line 164 of file vtkCollection.h.

◆ Top

vtkCollectionElement* vtkCollection::Top
protected

Definition at line 165 of file vtkCollection.h.

◆ Bottom

vtkCollectionElement* vtkCollection::Bottom
protected

Definition at line 166 of file vtkCollection.h.

◆ Current

vtkCollectionElement* vtkCollection::Current
protected

Definition at line 167 of file vtkCollection.h.


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