vtkVolumeCollection Class Reference

a list of volumes More...

#include <vtkVolumeCollection.h>

Inheritance diagram for vtkVolumeCollection:

Collaboration diagram for vtkVolumeCollection:

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 int	IsA (const char *type)
vtkVolumeCollection *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
void	AddItem (vtkVolume *a)
vtkVolume *	GetNextVolume ()
vtkVolume *	GetNextItem ()
vtkVolume *	GetNextVolume (vtkCollectionSimpleIterator &cookie)
Public Member Functions inherited from vtkPropCollection
vtkPropCollection *	NewInstance () const
void	AddItem (vtkProp *a)
vtkProp *	GetNextProp ()
vtkProp *	GetLastProp ()
int	GetNumberOfPaths ()
vtkProp *	GetNextProp (vtkCollectionSimpleIterator &cookie)
Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const
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 ()
vtkObject *	GetNextItemAsObject ()
vtkObject *	GetItemAsObject (int i)
vtkCollectionIterator *	NewIterator ()
void	InitTraversal (vtkCollectionSimpleIterator &cookie)
vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () 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)
vtkCommand *	GetCommand (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 vtkVolumeCollection *	New ()
static int	IsTypeOf (const char *type)
static vtkVolumeCollection *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPropCollection
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 ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVolumeCollection ()
	~vtkVolumeCollection ()
Protected Member Functions inherited from vtkPropCollection
	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
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 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 34 of file vtkVolumeCollection.h.

Member Typedef Documentation

typedef vtkPropCollection vtkVolumeCollection::Superclass

Definition at line 38 of file vtkVolumeCollection.h.

Constructor & Destructor Documentation

vtkVolumeCollection::vtkVolumeCollection ( )

inlineprotected

Definition at line 72 of file vtkVolumeCollection.h.

vtkVolumeCollection::~vtkVolumeCollection ( )

inlineprotected

Definition at line 73 of file vtkVolumeCollection.h.

Member Function Documentation

static vtkVolumeCollection* vtkVolumeCollection::New ( )

static

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

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkVolumeCollection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPropCollection.

vtkVolumeCollection* vtkVolumeCollection::NewInstance

(

)

const

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 43 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 50 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 66 of file vtkVolumeCollection.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkVolumeCollection.h