VTK
|
create and manipulate unsorted lists of objects More...
#include <vtkCollection.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkCollection * | NewInstance () 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 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 a. 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... | |
vtkObject * | GetNextItemAsObject () |
Get the next item in the collection. More... | |
vtkObject * | GetItemAsObject (int i) |
Get the i'th item in the collection. More... | |
vtkObject * | GetNextItemAsObject (vtkCollectionSimpleIterator &cookie) |
A reentrant safe way to get the next object as a collection. More... | |
VTK_NEWINSTANCE vtkCollectionIterator * | NewIterator () |
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 |
Participate in garbage collection. 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... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
int | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
int | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
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, 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) |
This method invokes an event and return whether the event was aborted or not. More... | |
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... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
void | PrintRevisions (ostream &) |
Legacy. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkCollection * | SafeDownCast (vtkObjectBase *o) |
static vtkCollection * | New () |
Construct with empty list. More... | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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=NULL) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
int | NumberOfItems |
vtkCollectionElement * | Top |
vtkCollectionElement * | Bottom |
vtkCollectionElement * | Current |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Friends | |
class | vtkCollectionIterator |
create and manipulate unsorted lists of objects
vtkCollection is a general object for creating and manipulating lists of objects. The lists are unsorted and allow duplicate entries. vtkCollection also serves as a base class for lists of specific types of objects.
Definition at line 51 of file vtkCollection.h.
typedef vtkObject vtkCollection::Superclass |
Definition at line 54 of file vtkCollection.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkActor2DCollection, vtkPropCollection, vtkAssemblyPath, vtkActorCollection, vtkLightCollection, vtkRenderPassCollection, vtkAssemblyPaths, vtkProp3DCollection, vtkTextPropertyCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkMapperCollection, vtkVolumeCollection, vtkRenderPassCollection, vtkShader2Collection, vtkDataArrayCollection, vtkIdListCollection, vtkDataObjectCollection, vtkPolyDataCollection, vtkTransformCollection, vtkCullerCollection, vtkRendererCollection, vtkRenderWindowCollection, vtkViewNodeCollection, vtkObjectFactoryCollection, vtkImageSliceCollection, vtkImplicitFunctionCollection, vtkImageReader2Collection, vtkDataSetCollection, vtkStructuredPointsCollection, and vtkSocketCollection.
|
static |
|
protectedvirtual |
Reimplemented in vtkActor2DCollection, vtkPropCollection, vtkAssemblyPath, vtkActorCollection, vtkLightCollection, vtkRenderPassCollection, vtkAssemblyPaths, vtkProp3DCollection, vtkTextPropertyCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkMapperCollection, vtkVolumeCollection, vtkRenderPassCollection, vtkShader2Collection, vtkDataArrayCollection, vtkIdListCollection, vtkDataObjectCollection, vtkPolyDataCollection, vtkTransformCollection, vtkCullerCollection, vtkRendererCollection, vtkRenderWindowCollection, vtkViewNodeCollection, vtkObjectFactoryCollection, vtkImageSliceCollection, vtkImplicitFunctionCollection, vtkImageReader2Collection, vtkDataSetCollection, vtkStructuredPointsCollection, and vtkSocketCollection.
vtkCollection* vtkCollection::NewInstance | ( | ) | const |
|
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, vtkRenderPassCollection, vtkProp3DCollection, vtkTextPropertyCollection, vtkMapperCollection, vtkVolumeCollection, vtkRenderPassCollection, vtkShader2Collection, vtkPolyDataCollection, vtkCullerCollection, vtkRendererCollection, vtkRenderWindowCollection, vtkViewNodeCollection, vtkImageReader2Collection, vtkStructuredPointsCollection, and vtkSocketCollection.
|
static |
Construct with empty list.
void vtkCollection::AddItem | ( | vtkObject * | ) |
Add an object to the list.
Does not prevent duplicate entries.
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.
Replace the i'th item in the collection with a.
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.
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).
void vtkCollection::RemoveAllItems | ( | ) |
Remove all objects from the list.
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.
|
inline |
Return the number of objects in the list.
Definition at line 109 of file vtkCollection.h.
|
inline |
Initialize the traversal of the collection.
This means the data pointer is set at the beginning of the list.
Definition at line 115 of file vtkCollection.h.
|
inline |
A reentrant safe way to iterate through a collection.
Just pass the same cookie value around each time
Definition at line 121 of file vtkCollection.h.
|
inline |
Get the next item in the collection.
NULL is returned if the collection is exhausted.
Definition at line 177 of file vtkCollection.h.
Get the i'th item in the collection.
NULL is returned if i is out of range
|
inline |
A reentrant safe way to get the next object as a collection.
Just pass the same cookie back and forth.
Definition at line 192 of file vtkCollection.h.
VTK_NEWINSTANCE vtkCollectionIterator* vtkCollection::NewIterator | ( | ) |
Get an iterator to traverse the objects in this collection.
|
overridevirtual |
Participate in garbage collection.
Reimplemented from vtkObjectBase.
|
overridevirtual |
Participate in garbage collection.
Reimplemented from vtkObjectBase.
|
protectedvirtual |
|
protectedvirtual |
Reimplemented in vtkActor2DCollection, and vtkImageSliceCollection.
|
overrideprotectedvirtual |
Reimplemented from vtkObjectBase.
|
friend |
Definition at line 167 of file vtkCollection.h.
|
protected |
Definition at line 162 of file vtkCollection.h.
|
protected |
Definition at line 163 of file vtkCollection.h.
|
protected |
Definition at line 164 of file vtkCollection.h.
|
protected |
Definition at line 165 of file vtkCollection.h.