a list of Props More...

#include <vtkPropCollection.h>

Inheritance diagram for vtkPropCollection:

Collaboration diagram for vtkPropCollection:

Public Types
typedef vtkCollection	Superclass

Public Types inherited from vtkCollection
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkPropCollection *	NewInstance () const

void	AddItem (vtkProp *a)
	Add an Prop to the list. More...

vtkProp *	GetNextProp ()
	Get the next Prop in the list. More...

vtkProp *	GetLastProp ()
	Get the last Prop in the list. More...

int	GetNumberOfPaths ()
	Get the number of paths contained in this list. More...

vtkProp *	GetNextProp (vtkCollectionSimpleIterator &cookie)
	Reentrant safe way to get an object in a collection. More...

Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	AddItem (vtkObject *)
	Add an object to the list. More...

void	InsertItem (int i, vtkObject *)
	Insert item into the list after the i'th item. More...

void	ReplaceItem (int i, vtkObject *)
	Replace the i'th item in the collection with a. More...

void	RemoveItem (int i)
	Remove the i'th item in the list. More...

void	RemoveItem (vtkObject *)
	Remove an object from the list. More...

void	RemoveAllItems ()
	Remove all objects from the list. More...

int	IsItemPresent (vtkObject *a)
	Search for an object and return location in list. More...

int	GetNumberOfItems ()
	Return the number of objects in the list. More...

void	InitTraversal ()
	Initialize the traversal of the collection. More...

void	InitTraversal (vtkCollectionSimpleIterator &cookie)
	A reentrant safe way to iterate through a collection. More...

vtkObject *	GetNextItemAsObject ()
	Get the next item in the collection. More...

vtkObject *	GetItemAsObject (int i)
	Get the i'th item in the collection. More...

vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
	A reentrant safe way to get the next object as a collection. More...

VTK_NEWINSTANCE vtkCollectionIterator *	NewIterator ()
	Get an iterator to traverse the objects in this collection. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkPropCollection *	New ()

static int	IsTypeOf (const char *type)

static vtkPropCollection *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkCollection
static int	IsTypeOf (const char *type)

static vtkCollection *	SafeDownCast (vtkObjectBase *o)

static vtkCollection *	New ()
	Construct with empty list. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPropCollection ()

	~vtkPropCollection ()

Protected Member Functions inherited from vtkCollection
	vtkCollection ()

	~vtkCollection () override

virtual void	RemoveElement (vtkCollectionElement element, vtkCollectionElement previous)

virtual void	DeleteElement (vtkCollectionElement *)

void	ReportReferences (vtkGarbageCollector *collector) override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkCollection
int	NumberOfItems

vtkCollectionElement *	Top

vtkCollectionElement *	Bottom

vtkCollectionElement *	Current

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 41 of file vtkPropCollection.h.

Member Typedef Documentation

typedef vtkCollection vtkPropCollection::Superclass

Definition at line 45 of file vtkPropCollection.h.

Constructor & Destructor Documentation

vtkPropCollection::vtkPropCollection ( )

inlineprotected

Definition at line 78 of file vtkPropCollection.h.

vtkPropCollection::~vtkPropCollection ( )

inlineprotected

Definition at line 79 of file vtkPropCollection.h.

Member Function Documentation

static vtkPropCollection* vtkPropCollection::New ( )

static

static int vtkPropCollection::IsTypeOf ( const char * type )

static

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCollection.

Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, vtkVolumeCollection, and vtkImageSliceCollection.

static vtkPropCollection* vtkPropCollection::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPropCollection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCollection.

Reimplemented in vtkActor2DCollection, vtkActorCollection, vtkProp3DCollection, vtkVolumeCollection, and vtkImageSliceCollection.

vtkPropCollection* vtkPropCollection::NewInstance ( ) const

void vtkPropCollection::AddItem ( vtkProp * a )

inline

Add an Prop to the list.

Definition at line 91 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetNextProp ( )

inline

Get the next Prop in the list.

Definition at line 96 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetLastProp ( )

inline

Get the last Prop in the list.

Definition at line 101 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 74 of file vtkPropCollection.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkPropCollection.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation