vtkPropCollection Class Reference

#include <vtkPropCollection.h>

Inheritance diagram for vtkPropCollection:

Inheritance graph
[legend]
Collaboration diagram for vtkPropCollection:

Collaboration graph
[legend]

List of all members.


Detailed Description

a list of Props

vtkPropCollection represents and provides methods to manipulate a list of Props (i.e., vtkProp and subclasses). The list is unsorted and duplicate entries are not prevented.

See also:
vtkProp vtkCollection
Examples:
vtkPropCollection (Examples)
Tests:
vtkPropCollection (Tests)

Definition at line 39 of file vtkPropCollection.h.


Public Types

typedef vtkCollection Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void AddItem (vtkProp *a)
vtkPropGetNextProp ()
vtkPropGetLastProp ()
int GetNumberOfPaths ()
vtkPropGetNextProp (vtkCollectionSimpleIterator &cookie)

Static Public Member Functions

static vtkPropCollectionNew ()
static int IsTypeOf (const char *type)
static vtkPropCollectionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPropCollection ()
 ~vtkPropCollection ()

Member Typedef Documentation

Reimplemented from vtkCollection.

Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

Definition at line 43 of file vtkPropCollection.h.


Constructor & Destructor Documentation

vtkPropCollection::vtkPropCollection (  )  [inline, protected]

Definition at line 70 of file vtkPropCollection.h.

vtkPropCollection::~vtkPropCollection (  )  [inline, protected]

Definition at line 71 of file vtkPropCollection.h.


Member Function Documentation

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

Construct with empty list.

Reimplemented from vtkCollection.

Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

static int vtkPropCollection::IsTypeOf ( const char *  name  )  [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 vtkCollection.

Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

virtual int vtkPropCollection::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkCollection.

Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

void vtkPropCollection::AddItem ( vtkProp a  )  [inline]

Add an Prop to the list.

Definition at line 83 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetNextProp (  )  [inline]

Get the next Prop in the list.

Definition at line 88 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetLastProp (  )  [inline]

Get the last Prop in the list.

Definition at line 93 of file vtkPropCollection.h.

int vtkPropCollection::GetNumberOfPaths (  ) 

Get the number of paths contained in this list. (Recall that a vtkProp can consist of multiple parts.) Used in picking and other activities to get the parts of composite entities like vtkAssembly or vtkPropAssembly.

vtkProp* vtkPropCollection::GetNextProp ( vtkCollectionSimpleIterator cookie  )  [inline]

Reentrant safe way to get an object in a collection. Just pass the same cookie back and forth.

Definition at line 64 of file vtkPropCollection.h.


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

Generated on Sat Dec 27 13:45:18 2008 for VTK by  doxygen 1.5.6