---

vtkPropCollection Class Reference

a list of Props. More...

#include <vtkPropCollection.h>

Inheritance diagram for vtkPropCollection:

[legend]Collaboration diagram for vtkPropCollection:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	AddItem (vtkProp *a)
vtkProp *	GetNextProp ()
vtkProp *	GetLastProp ()
int	GetNumberOfPaths ()
Static Public Methods
vtkPropCollection *	New ()
int	IsTypeOf (const char *type)
vtkPropCollection *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkPropCollection ()
	~vtkPropCollection ()

---

Detailed Description

a list of Props.

Date:

2001/10/11 13:36:22

Revision:

1.17

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)

Definition at line 63 of file vtkPropCollection.h.

---

Constructor & Destructor Documentation

vtkPropCollection::vtkPropCollection (    )  [inline, protected]

Definition at line 85 of file vtkPropCollection.h.

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

Definition at line 86 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]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkCollection. Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkCollection. Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, and vtkVolumeCollection.

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

Add an Prop to the list. Definition at line 98 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetNextProp (    )  [inline]

Get the next Prop in the list. Definition at line 103 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetLastProp (    )  [inline]

Get the last Prop in the list. Definition at line 108 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.

---

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

• Common/vtkPropCollection.h

---