---

vtkActor2DCollection Class Reference

#include <vtkActor2DCollection.h>

Inheritance diagram for vtkActor2DCollection:

[legend]Collaboration diagram for vtkActor2DCollection:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	Sort ()
void	AddItem (vtkActor2D *a)
int	IsItemPresent (vtkActor2D *a)
vtkActor2D *	GetNextActor2D ()
vtkActor2D *	GetLastActor2D ()
vtkActor2D *	GetNextItem ()
vtkActor2D *	GetLastItem ()
void	RenderOverlay (vtkViewport *viewport)
Static Public Methods
vtkActor2DCollection *	New ()
int	IsTypeOf (const char *type)
vtkActor2DCollection *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkActor2DCollection ()
	~vtkActor2DCollection ()
	vtkActor2DCollection (const vtkActor2DCollection &)
void	operator= (const vtkActor2DCollection &)
virtual void	DeleteElement (vtkCollectionElement *)

---

Detailed Description

Date:

2000/12/10 20:08:06

Revision:

1.21

Thanks:

Thanks to Matt Turek who developed this class.

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

Examples:

vtkActor2DCollection (examples)

Definition at line 64 of file vtkActor2DCollection.h.

---

Constructor & Destructor Documentation

vtkActor2DCollection::vtkActor2DCollection (    )  [inline, protected]

Definition at line 98 of file vtkActor2DCollection.h.

vtkActor2DCollection::~vtkActor2DCollection (    )  [protected]

vtkActor2DCollection::vtkActor2DCollection (  const vtkActor2DCollection &    )  [inline, protected]

Definition at line 100 of file vtkActor2DCollection.h.

---

Member Function Documentation

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]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkPropCollection.

int vtkActor2DCollection::IsTypeOf (  const char *    type )  [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 *    type )  [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.

vtkActor2DCollection* vtkActor2DCollection::SafeDownCast (  vtkObject *    o )  [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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 113 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetNextActor2D (    )  [inline]

Definition at line 118 of file vtkActor2DCollection.h. Referenced by GetNextItem().

vtkActor2D * vtkActor2DCollection::GetLastActor2D (    )  [inline]

Definition at line 123 of file vtkActor2DCollection.h. Referenced by GetLastItem().

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 135 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetLastItem (    )  [inline]

Definition at line 140 of file vtkActor2DCollection.h.

void vtkActor2DCollection::RenderOverlay (  vtkViewport *    viewport )

Sort and then render the collection of 2D actors.

void vtkActor2DCollection::operator= (  const vtkActor2DCollection &    )  [inline, protected]

Definition at line 101 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:

• common/vtkActor2DCollection.h

---