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

a list of 2D actors More...

#include <vtkActor2DCollection.h>

Inheritance diagram for vtkActor2DCollection:
[legend]
Collaboration diagram for vtkActor2DCollection:
[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)
 
void Sort ()
 
void AddItem (vtkActor2D *a)
 
void RenderOverlay (vtkViewport *viewport)
 
int IsItemPresent (vtkActor2D *a)
 
vtkActor2DGetNextActor2D ()
 
vtkActor2DGetLastActor2D ()
 
vtkActor2DGetNextItem ()
 
vtkActor2DGetLastItem ()
 
vtkActor2DGetNextActor2D (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 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
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 vtkActor2DCollectionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkActor2DCollectionSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPropCollection
static vtkPropCollectionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPropCollectionSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCollection
static int IsTypeOf (const char *type)
 
static vtkCollectionSafeDownCast (vtkObject *o)
 
static vtkCollectionNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *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

 vtkActor2DCollection ()
 
 ~vtkActor2DCollection ()
 
virtual void DeleteElement (vtkCollectionElement *)
 
- Protected Member Functions inherited from vtkPropCollection
 vtkPropCollection ()
 
 ~vtkPropCollection ()
 
- Protected Member Functions inherited from vtkCollection
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
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a list of 2D actors

vtkActor2DCollection is a subclass of vtkCollection. vtkActor2DCollection maintains a collection of vtkActor2D objects that is sorted by layer number, with lower layer numbers at the start of the list. This allows the vtkActor2D objects to be rendered in the correct order.

See Also
vtkActor2D vtkCollection

Definition at line 36 of file vtkActor2DCollection.h.

Member Typedef Documentation

Definition at line 43 of file vtkActor2DCollection.h.

Constructor & Destructor Documentation

vtkActor2DCollection::vtkActor2DCollection ( )
inlineprotected

Definition at line 82 of file vtkActor2DCollection.h.

vtkActor2DCollection::~vtkActor2DCollection ( )
protected

Member Function Documentation

static vtkActor2DCollection* vtkActor2DCollection::New ( )
static

Desctructor for the vtkActor2DCollection class. This removes all objects from the collection.

virtual const char* vtkActor2DCollection::GetClassName ( )
virtual

Reimplemented from vtkPropCollection.

static int vtkActor2DCollection::IsTypeOf ( const char *  type)
static
virtual int vtkActor2DCollection::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 vtkActor2DCollection* vtkActor2DCollection::SafeDownCast ( vtkObject o)
static
void vtkActor2DCollection::Sort ( )

Sorts the vtkActor2DCollection by layer number. Smaller layer numbers are first. Layer numbers can be any integer value.

void vtkActor2DCollection::AddItem ( vtkActor2D a)

Add an actor to the list. The new actor is inserted in the list according to it's layer number.

int vtkActor2DCollection::IsItemPresent ( vtkActor2D a)
inline

Standard Collection methods

Definition at line 98 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetNextActor2D ( )
inline

Standard Collection methods

Definition at line 103 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetLastActor2D ( )
inline

Standard Collection methods

Definition at line 108 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetNextItem ( )
inline

Access routines that are provided for compatibility with previous version of VTK. Please use the GetNextActor2D(), GetLastActor2D() variants where possible.

Definition at line 120 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetLastItem ( )
inline

Access routines that are provided for compatibility with previous version of VTK. Please use the GetNextActor2D(), GetLastActor2D() variants where possible.

Definition at line 125 of file vtkActor2DCollection.h.

void vtkActor2DCollection::RenderOverlay ( vtkViewport viewport)

Sort and then render the collection of 2D actors.

vtkActor2D* vtkActor2DCollection::GetNextActor2D ( vtkCollectionSimpleIterator cookie)
inline

Reentrant safe way to get an object in a collection. Just pass the same cookie back and forth.

Definition at line 76 of file vtkActor2DCollection.h.

virtual void vtkActor2DCollection::DeleteElement ( vtkCollectionElement )
protectedvirtual

Reimplemented from vtkCollection.


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