vtkActor2DCollection Class Reference

#include <vtkActor2DCollection.h>

Inheritance diagram for vtkActor2DCollection:

Inheritance graph
[legend]
Collaboration diagram for vtkActor2DCollection:

Collaboration graph
[legend]

List of all members.


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.


Public Types

typedef vtkPropCollection 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)

Static Public Member Functions

static vtkActor2DCollectionNew ()
static int IsTypeOf (const char *type)
static vtkActor2DCollectionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkActor2DCollection ()
 ~vtkActor2DCollection ()
virtual void DeleteElement (vtkCollectionElement *)

Member Typedef Documentation

Reimplemented from vtkPropCollection.

Definition at line 43 of file vtkActor2DCollection.h.


Constructor & Destructor Documentation

vtkActor2DCollection::vtkActor2DCollection (  )  [inline, protected]

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.

Reimplemented from vtkPropCollection.

virtual const char* vtkActor2DCollection::GetClassName (  )  [virtual]

Reimplemented from vtkPropCollection.

static int vtkActor2DCollection::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 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]

Reimplemented from vtkPropCollection.

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  )  [protected, virtual]

Reimplemented from vtkCollection.


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

Generated on Mon Sep 27 18:17:35 2010 for VTK by  doxygen 1.5.6