vtkCollection Class Reference
#include <vtkCollection.h>
Inheritance diagram for vtkCollection:
[legend]Collaboration diagram for vtkCollection:
[legend]List of all members.
Detailed Description
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.
- See also:
- vtkActorCollection vtkAssemblyPaths vtkDataSetCollection vtkImplicitFunctionCollection vtkLightCollection vtkPolyDataCollection vtkRenderWindowCollection vtkRendererCollection vtkStructuredPointsCollection vtkTransformCollection vtkVolumeCollection
Definition at line 47 of file vtkCollection.h.
Member Typedef Documentation
|
|
Reimplemented from vtkObject.
Reimplemented in vtkActor2DCollection, vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection.
Definition at line 50 of file vtkCollection.h. |
Constructor & Destructor Documentation
| vtkCollection::vtkCollection |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkCollection::GetClassName |
( |
|
) |
[virtual] |
|
|
|
Reimplemented from vtkObject.
Reimplemented in vtkActor2DCollection, vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection. |
| int vtkCollection::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkActor2DCollection, vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection. |
| virtual int vtkCollection::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkActor2DCollection, vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection. |
|
|
Reimplemented from vtkObject.
Reimplemented in vtkActor2DCollection, vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection. |
| void vtkCollection::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
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.
Reimplemented in vtkAssemblyPath, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection. |
|
|
Construct with empty list.
Reimplemented from vtkObject.
Reimplemented in vtkActor2DCollection, vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection. |
|
|
Add an object to the list. Does not prevent duplicate entries.
Referenced by vtkVolumeCollection::AddItem(), vtkRenderWindowCollection::AddItem(), vtkRendererCollection::AddItem(), vtkProp3DCollection::AddItem(), vtkMapperCollection::AddItem(), vtkCullerCollection::AddItem(), vtkActorCollection::AddItem(), vtkStructuredPointsCollection::AddItem(), vtkPolyDataCollection::AddItem(), vtkTransformCollection::AddItem(), vtkPropCollection::AddItem(), vtkPlaneCollection::AddItem(), vtkOverrideInformationCollection::AddItem(), vtkObjectFactoryCollection::AddItem(), vtkImplicitFunctionCollection::AddItem(), vtkIdListCollection::AddItem(), vtkDataSetCollection::AddItem(), vtkDataObjectCollection::AddItem(), vtkDataArrayCollection::AddItem(), and vtkAssemblyPaths::AddItem(). |
| void vtkCollection::ReplaceItem |
( |
int |
i, |
|
|
vtkObject * |
|
|
) |
|
|
|
|
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.
Referenced by vtkAssemblyPaths::RemoveItem(). |
| 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. |
| int vtkCollection::IsItemPresent |
( |
vtkObject * |
|
) |
|
|
| int vtkCollection::GetNumberOfItems |
( |
|
) |
|
|
|
|
Return the number of objects in the list. |
| 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 86 of file vtkCollection.h. |
| void vtkCollection::InitTraversal |
( |
void *& |
cookie |
) |
[inline] |
|
|
|
Less bloated way to iterate through a collection. Just pass the same cookie value around each time
Definition at line 92 of file vtkCollection.h. |
| vtkObject * vtkCollection::GetNextItemAsObject |
( |
|
) |
[inline] |
|
|
|
Get the next item in the collection. NULL is returned if the collection is exhausted.
Definition at line 135 of file vtkCollection.h.
References Current, vtkCollectionElement::Item, and vtkCollectionElement::Next.
Referenced by vtkActorCollection::GetNextActor(), vtkActor2DCollection::GetNextActor2D(), vtkRenderWindowCollection::GetNextItem(), vtkRendererCollection::GetNextItem(), vtkMapperCollection::GetNextItem(), vtkCullerCollection::GetNextItem(), vtkStructuredPointsCollection::GetNextItem(), vtkPolyDataCollection::GetNextItem(), vtkTransformCollection::GetNextItem(), vtkPlaneCollection::GetNextItem(), vtkOverrideInformationCollection::GetNextItem(), vtkObjectFactoryCollection::GetNextItem(), vtkImplicitFunctionCollection::GetNextItem(), vtkIdListCollection::GetNextItem(), vtkDataSetCollection::GetNextItem(), vtkDataObjectCollection::GetNextItem(), vtkDataArrayCollection::GetNextItem(), vtkAssemblyPaths::GetNextItem(), vtkPropCollection::GetNextProp(), vtkProp3DCollection::GetNextProp3D(), and vtkVolumeCollection::GetNextVolume(). |
| vtkObject* vtkCollection::GetItemAsObject |
( |
int |
i |
) |
|
|
| vtkObject * vtkCollection::GetNextItemAsObject |
( |
void *& |
cookie |
) |
[inline] |
|
|
|
Get an iterator to traverse the objects in this collection. |
Friends And Related Function Documentation
Member Data Documentation
The documentation for this class was generated from the following file: