Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkCollection Class Reference

#include <vtkCollection.h>

Inheritance diagram for vtkCollection:

Inheritance graph
[legend]
Collaboration diagram for vtkCollection:

Collaboration graph
[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 48 of file vtkCollection.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void AddItem (vtkObject *)
void ReplaceItem (int i, vtkObject *)
void RemoveItem (int i)
void RemoveItem (vtkObject *)
void RemoveAllItems ()
int IsItemPresent (vtkObject *)
int GetNumberOfItems ()
vtkObject * GetNextItemAsObject ()
void InitTraversal ()
void InitTraversal (vtkCollectionSimpleIterator &cookie)
vtkObject * GetItemAsObject (int i)
vtkObject * GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
vtkCollectionIterator * NewIterator ()
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkCollection * SafeDownCast (vtkObject *o)
static vtkCollection * New ()

Protected Member Functions

 vtkCollection ()
 ~vtkCollection ()
virtual void DeleteElement (vtkCollectionElement *)
virtual void ReportReferences (vtkGarbageCollector *collector)

Protected Attributes

int NumberOfItems
vtkCollectionElement * Top
vtkCollectionElement * Bottom
vtkCollectionElement * Current

Friends

class vtkCollectionIterator

Member Typedef Documentation

typedef vtkObject vtkCollection::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkActor2DCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection.

Definition at line 51 of file vtkCollection.h.

Constructor & Destructor Documentation

vtkCollection::vtkCollection (   )  [protected]
 

vtkCollection::~vtkCollection (   )  [protected]
 

Member Function Documentation

virtual const char* vtkCollection::GetClassName (   )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkActor2DCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection.

static 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 vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkActor2DCollection, vtkDataObjectCollection, vtkDataSetCollection, 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 vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkActor2DCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection.

static vtkCollection* vtkCollection::SafeDownCast (  vtkObject *  o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkActor2DCollection, vtkDataObjectCollection, vtkDataSetCollection, 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.

static vtkCollection* vtkCollection::New (   )  [static]
 

Construct with empty list.

Reimplemented from vtkObject.

Reimplemented in vtkAssemblyPath, vtkAssemblyPaths, vtkDataArrayCollection, vtkIdListCollection, vtkImplicitFunctionCollection, vtkObjectFactoryCollection, vtkOverrideInformationCollection, vtkPlaneCollection, vtkPropCollection, vtkTransformCollection, vtkActor2DCollection, vtkDataObjectCollection, vtkDataSetCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderWindowCollection, and vtkVolumeCollection.

void vtkCollection::AddItem (  vtkObject *   ) 
 

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(), vtkDataSetCollection::AddItem(), vtkDataObjectCollection::AddItem(), vtkTransformCollection::AddItem(), vtkPropCollection::AddItem(), vtkPlaneCollection::AddItem(), vtkOverrideInformationCollection::AddItem(), vtkObjectFactoryCollection::AddItem(), vtkImplicitFunctionCollection::AddItem(), vtkIdListCollection::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 *   ) 
 

Search for an object and return location in list. If location == 0, object was not found.

Referenced by vtkActor2DCollection::IsItemPresent(), and vtkAssemblyPaths::IsItemPresent().

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 87 of file vtkCollection.h.

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 93 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 144 of file vtkCollection.h.

References Current, vtkCollectionElement::Item, and vtkCollectionElement::Next.

Referenced by vtkActorCollection::GetNextActor(), vtkActor2DCollection::GetNextActor2D(), vtkCullerCollection::GetNextCuller(), vtkDataArrayCollection::GetNextDataArray(), vtkDataObjectCollection::GetNextDataObject(), vtkDataSetCollection::GetNextDataSet(), vtkIdListCollection::GetNextIdList(), vtkImplicitFunctionCollection::GetNextImplicitFunction(), vtkRenderWindowCollection::GetNextItem(), vtkRendererCollection::GetNextItem(), vtkMapperCollection::GetNextItem(), vtkCullerCollection::GetNextItem(), vtkStructuredPointsCollection::GetNextItem(), vtkPolyDataCollection::GetNextItem(), vtkDataSetCollection::GetNextItem(), vtkDataObjectCollection::GetNextItem(), vtkTransformCollection::GetNextItem(), vtkPlaneCollection::GetNextItem(), vtkOverrideInformationCollection::GetNextItem(), vtkObjectFactoryCollection::GetNextItem(), vtkImplicitFunctionCollection::GetNextItem(), vtkIdListCollection::GetNextItem(), vtkDataArrayCollection::GetNextItem(), vtkAssemblyPaths::GetNextItem(), vtkMapperCollection::GetNextMapper(), vtkAssemblyPath::GetNextNode(), vtkObjectFactoryCollection::GetNextObjectFactory(), vtkOverrideInformationCollection::GetNextOverrideInformation(), vtkAssemblyPaths::GetNextPath(), vtkPolyDataCollection::GetNextPolyData(), vtkPropCollection::GetNextProp(), vtkProp3DCollection::GetNextProp3D(), vtkRendererCollection::GetNextRenderer(), vtkRenderWindowCollection::GetNextRenderWindow(), vtkStructuredPointsCollection::GetNextStructuredPoints(), vtkTransformCollection::GetNextTransform(), and vtkVolumeCollection::GetNextVolume().

vtkObject* vtkCollection::GetItemAsObject (  int  i  ) 
 

Get the i'th item in the collection. NULL is returned if i is out of range

Referenced by vtkDataSetCollection::GetDataSet(), vtkDataSetCollection::GetItem(), vtkDataObjectCollection::GetItem(), vtkIdListCollection::GetItem(), and vtkDataArrayCollection::GetItem().

vtkObject* vtkCollection::GetNextItemAsObject (  vtkCollectionSimpleIterator &  cookie  ) 
 

A reentrant safe way to get the next object as a collection. Just pass the same cookie back and forth.

vtkCollectionIterator* vtkCollection::NewIterator (   ) 
 

Get an iterator to traverse the objects in this collection.

virtual void vtkCollection::Register (  vtkObjectBase *  o  )  [virtual]
 

Participate in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkCollection::UnRegister (  vtkObjectBase *  o  )  [virtual]
 

Get an iterator to traverse the objects in this collection.

Reimplemented from vtkObjectBase.

virtual void vtkCollection::DeleteElement (  vtkCollectionElement *   )  [protected, virtual]
 

Reimplemented in vtkActor2DCollection.

virtual void vtkCollection::ReportReferences (  vtkGarbageCollector *  collector  )  [protected, virtual]
 

Reimplemented from vtkObjectBase.

Friends And Related Function Documentation

friend class vtkCollectionIterator [friend]
 

Definition at line 133 of file vtkCollection.h.

Member Data Documentation

int vtkCollection::NumberOfItems [protected]
 

Definition at line 127 of file vtkCollection.h.

vtkCollectionElement* vtkCollection::Top [protected]
 

Definition at line 128 of file vtkCollection.h.

vtkCollectionElement* vtkCollection::Bottom [protected]
 

Definition at line 129 of file vtkCollection.h.

Referenced by vtkActorCollection::GetLastActor(), vtkActor2DCollection::GetLastActor2D(), vtkMapperCollection::GetLastItem(), vtkCullerCollection::GetLastItem(), vtkPropCollection::GetLastProp(), and vtkProp3DCollection::GetLastProp3D().

vtkCollectionElement* vtkCollection::Current [protected]
 

Definition at line 130 of file vtkCollection.h.

Referenced by GetNextItemAsObject().

The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:37:56 2008 for VTK by  doxygen 1.4.3-20050530