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

a list of volumes More...

#include <vtkVolumeCollection.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
vtkVolumeGetNextItem ()
void AddItem (vtkVolume *a)
vtkVolumeGetNextVolume ()
vtkVolumeGetNextVolume (vtkCollectionSimpleIterator &cookie)
- Public Member Functions inherited from vtkPropCollection
void AddItem (vtkProp *a)
vtkPropGetNextProp ()
vtkPropGetLastProp ()
int GetNumberOfPaths ()
vtkPropGetNextProp (vtkCollectionSimpleIterator &cookie)
- Public Member Functions inherited from vtkCollection
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
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkVolumeCollectionNew ()
static int IsTypeOf (const char *type)
static vtkVolumeCollectionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkVolumeCollection ()
 ~vtkVolumeCollection ()
- Protected Member Functions inherited from vtkPropCollection
 vtkPropCollection ()
 ~vtkPropCollection ()
- Protected Member Functions inherited from vtkCollection
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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Attributes inherited from vtkCollection
int NumberOfItems
vtkCollectionElementTop
vtkCollectionElementBottom
vtkCollectionElementCurrent
- Friends inherited from vtkObject

Detailed Description

a list of volumes

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

See Also
vtkCollection vtkVolume

Definition at line 33 of file vtkVolumeCollection.h.

Member Typedef Documentation

Definition at line 37 of file vtkVolumeCollection.h.

Constructor & Destructor Documentation

vtkVolumeCollection::vtkVolumeCollection ( )
inlineprotected

Definition at line 70 of file vtkVolumeCollection.h.

vtkVolumeCollection::~vtkVolumeCollection ( )
inlineprotected

Definition at line 71 of file vtkVolumeCollection.h.

Member Function Documentation

static vtkVolumeCollection* vtkVolumeCollection::New ( )
static

Construct with empty list.

Reimplemented from vtkPropCollection.

virtual const char* vtkVolumeCollection::GetClassName ( )
virtual

Reimplemented from vtkPropCollection.

static int vtkVolumeCollection::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPropCollection.

virtual int vtkVolumeCollection::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 vtkPropCollection.

static vtkVolumeCollection* vtkVolumeCollection::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkPropCollection.

virtual void vtkVolumeCollection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCollection.

void vtkVolumeCollection::AddItem ( vtkVolume a)
inline

Add a Volume to the list.

Definition at line 42 of file vtkVolumeCollection.h.

vtkVolume* vtkVolumeCollection::GetNextVolume ( )
inline

Get the next Volume in the list. Return NULL when at the end of the list.

Definition at line 51 of file vtkVolumeCollection.h.

vtkVolume* vtkVolumeCollection::GetNextItem ( )
inline

Access routine provided for compatibility with previous versions of VTK. Please use the GetNextVolume() variant where possible.

Definition at line 58 of file vtkVolumeCollection.h.

vtkVolume* vtkVolumeCollection::GetNextVolume ( 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 vtkVolumeCollection.h.


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