VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPropCollection Class Reference

a list of Props More...

#include <vtkPropCollection.h>

Inheritance diagram for vtkPropCollection:
[legend]
Collaboration diagram for vtkPropCollection:
[legend]

Public Types

typedef vtkCollection Superclass
 
- Public Types inherited from vtkCollection
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPropCollectionNewInstance () const
 
void AddItem (vtkProp *a)
 
vtkPropGetNextProp ()
 
vtkPropGetLastProp ()
 
int GetNumberOfPaths ()
 
vtkPropGetNextProp (vtkCollectionSimpleIterator &cookie)
 
- Public Member Functions inherited from vtkCollection
vtkCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void AddItem (vtkObject *)
 
void InsertItem (int i, vtkObject *)
 
void ReplaceItem (int i, vtkObject *)
 
void RemoveItem (int i)
 
void RemoveItem (vtkObject *)
 
void RemoveAllItems ()
 
int IsItemPresent (vtkObject *a)
 
int GetNumberOfItems ()
 
void InitTraversal ()
 
vtkObjectGetNextItemAsObject ()
 
vtkObjectGetItemAsObject (int i)
 
vtkCollectionIteratorNewIterator ()
 
void InitTraversal (vtkCollectionSimpleIterator &cookie)
 
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkPropCollectionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPropCollectionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCollection
static int IsTypeOf (const char *type)
 
static vtkCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkCollectionNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPropCollection ()
 
 ~vtkPropCollection ()
 
- Protected Member Functions inherited from vtkCollection
virtual void RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
 
virtual void DeleteElement (vtkCollectionElement *)
 
virtual void ReportReferences (vtkGarbageCollector *collector)
 
 vtkCollection ()
 
 ~vtkCollection ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- 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
 
vtkCollectionElementTop
 
vtkCollectionElementBottom
 
vtkCollectionElementCurrent
 
- 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 40 of file vtkPropCollection.h.

Member Typedef Documentation

Definition at line 44 of file vtkPropCollection.h.

Constructor & Destructor Documentation

vtkPropCollection::vtkPropCollection ( )
inlineprotected

Definition at line 71 of file vtkPropCollection.h.

vtkPropCollection::~vtkPropCollection ( )
inlineprotected

Definition at line 72 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, vtkProp3DCollection, vtkActorCollection, vtkVolumeCollection, and vtkImageSliceCollection.

static vtkPropCollection* vtkPropCollection::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPropCollection::NewInstanceInternal ( ) const
protectedvirtual
vtkPropCollection* vtkPropCollection::NewInstance ( ) const
void vtkPropCollection::AddItem ( vtkProp a)
inline

Add an Prop to the list.

Definition at line 84 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetNextProp ( )
inline

Get the next Prop in the list.

Definition at line 89 of file vtkPropCollection.h.

vtkProp * vtkPropCollection::GetLastProp ( )
inline

Get the last Prop in the list.

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


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