vtkPropCollection Class Reference

#include <vtkPropCollection.h>

Inheritance diagram for vtkPropCollection:

[legend]Collaboration diagram for vtkPropCollection:

[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

Created by:

Hoffman, Bill
Martin, Ken

CVS contributions (if > 5%):

Martin, Ken (51%)
Hoffman, Bill (19%)
Schroeder, Will (19%)

CVS logs (CVSweb):

.cxx (/Common/vtkPropCollection.cxx)
.h (/Common/vtkPropCollection.h)

Examples:: vtkPropCollection (Examples)

Tests:: vtkPropCollection (Tests)

Definition at line 52 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)

vtkProp * GetNextProp ()

vtkProp * GetLastProp ()

int GetNumberOfPaths ()

vtkProp * GetNextProp (vtkCollectionSimpleIterator &cookie)

Static Public Member Functions

vtkPropCollection * New ()

int IsTypeOf (const char *type)

vtkPropCollection * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkPropCollection ()

~vtkPropCollection ()

Member Typedef Documentation

typedef vtkCollection vtkPropCollection::Superclass

Reimplemented from vtkCollection.
Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.
Definition at line 56 of file vtkPropCollection.h.

Constructor & Destructor Documentation

vtkPropCollection::vtkPropCollection ( ) [inline, protected]

Definition at line 83 of file vtkPropCollection.h.

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

Definition at line 84 of file vtkPropCollection.h.

Member Function Documentation

vtkPropCollection* vtkPropCollection::New ( ) [static]

Construct with empty list.
Reimplemented from vtkCollection.
Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

Reimplemented from vtkCollection.
Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

int vtkPropCollection::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 vtkCollection.
Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

virtual int vtkPropCollection::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 vtkCollection.
Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

Reimplemented from vtkCollection.
Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

Add an Prop to the list.
Definition at line 96 of file vtkPropCollection.h.
References vtkCollection::AddItem().

vtkProp * vtkPropCollection::GetNextProp ( ) [inline]

Get the next Prop in the list.
Definition at line 101 of file vtkPropCollection.h.
References vtkCollection::GetNextItemAsObject().

vtkProp * vtkPropCollection::GetLastProp ( ) [inline]

Get the last Prop in the list.
Definition at line 106 of file vtkPropCollection.h.
References vtkCollectionElement::Item.

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 77 of file vtkPropCollection.h.
References vtkCollection::GetNextItemAsObject(), and vtkCollectionSimpleIterator.

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

dox/Common/vtkPropCollection.h


Public Types
typedef vtkCollection	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	AddItem (vtkProp *a)
vtkProp *	GetNextProp ()
vtkProp *	GetLastProp ()
int	GetNumberOfPaths ()

vtkProp *	GetNextProp (vtkCollectionSimpleIterator &cookie)
Static Public Member Functions
vtkPropCollection *	New ()
int	IsTypeOf (const char *type)
vtkPropCollection *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPropCollection ()
	~vtkPropCollection ()