vtkActor2DCollection Class Reference

a list of 2D actors More...

#include <vtkActor2DCollection.h>

Inheritance diagram for vtkActor2DCollection:

Collaboration diagram for vtkActor2DCollection:

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

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkActor2DCollection *	NewInstance () const
void	Sort ()
	Sorts the vtkActor2DCollection by layer number. More...
void	AddItem (vtkActor2D *a)
	Add an actor to the list. More...
void	RenderOverlay (vtkViewport *viewport)
	Sort and then render the collection of 2D actors. More...
vtkActor2D *	GetNextActor2D (vtkCollectionSimpleIterator &cookie)
	Reentrant safe way to get an object in a collection. More...
int	IsItemPresent (vtkActor2D *a)
	Standard Collection methods. More...
vtkActor2D *	GetNextActor2D ()
	Standard Collection methods. More...
vtkActor2D *	GetLastActor2D ()
	Standard Collection methods. More...
vtkActor2D *	GetNextItem ()
	Access routines that are provided for compatibility with previous version of VTK. More...
vtkActor2D *	GetLastItem ()
	Access routines that are provided for compatibility with previous version of VTK. More...
Public Member Functions inherited from vtkPropCollection
vtkPropCollection *	NewInstance () const
void	AddItem (vtkProp *a)
	Add a Prop to the bottom of the list. More...
vtkProp *	GetNextProp ()
	Get the next Prop in the list. More...
vtkProp *	GetLastProp ()
	Get the last Prop in the list. More...
int	GetNumberOfPaths ()
	Get the number of paths contained in this list. More...
vtkProp *	GetNextProp (vtkCollectionSimpleIterator &cookie)
	Reentrant safe way to get an object in a collection. More...
Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	AddItem (vtkObject *)
	Add an object to the bottom of the list. More...
void	InsertItem (int i, vtkObject *)
	Insert item into the list after the i'th item. More...
void	ReplaceItem (int i, vtkObject *)
	Replace the i'th item in the collection with another item. More...
void	RemoveItem (int i)
	Remove the i'th item in the list. More...
void	RemoveItem (vtkObject *)
	Remove an object from the list. More...
void	RemoveAllItems ()
	Remove all objects from the list. More...
int	IsItemPresent (vtkObject *a)
	Search for an object and return location in list. More...
int	GetNumberOfItems ()
	Return the number of objects in the list. More...
void	InitTraversal ()
	Initialize the traversal of the collection. More...
void	InitTraversal (vtkCollectionSimpleIterator &cookie)
	A reentrant safe way to iterate through a collection. More...
vtkObject *	GetNextItemAsObject ()
	Get the next item in the collection. More...
vtkObject *	GetItemAsObject (int i)
	Get the i'th item in the collection. More...
vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
	A reentrant safe way to get the next object as a collection. More...
vtkCollectionIterator *	NewIterator ()
	Get an iterator to traverse the objects in this collection. More...
void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkActor2DCollection *	New ()
	Destructor for the vtkActor2DCollection class. More...
static vtkTypeBool	IsTypeOf (const char *type)
static vtkActor2DCollection *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPropCollection
static vtkPropCollection *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPropCollection *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCollection
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCollection *	SafeDownCast (vtkObjectBase *o)
static vtkCollection *	New ()
	Construct with empty list. More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkActor2DCollection ()
	~vtkActor2DCollection () override
void	DeleteElement (vtkCollectionElement *) override
Protected Member Functions inherited from vtkPropCollection
	vtkPropCollection ()
	~vtkPropCollection () override
Protected Member Functions inherited from vtkCollection
	vtkCollection ()
	~vtkCollection () override
virtual void	RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
void	ReportReferences (vtkGarbageCollector *collector) override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
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 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 38 of file vtkActor2DCollection.h.

Member Typedef Documentation

typedef vtkPropCollection vtkActor2DCollection::Superclass

Definition at line 47 of file vtkActor2DCollection.h.

Constructor & Destructor Documentation

vtkActor2DCollection::vtkActor2DCollection ( )

inlineprotected

Definition at line 94 of file vtkActor2DCollection.h.

vtkActor2DCollection::~vtkActor2DCollection ( )

overrideprotected

Member Function Documentation

static vtkActor2DCollection* vtkActor2DCollection::New ( )

static

Destructor for the vtkActor2DCollection class.

This removes all objects from the collection.

static vtkTypeBool vtkActor2DCollection::IsTypeOf ( const char *  type )

static

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

static

virtual vtkObjectBase* vtkActor2DCollection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPropCollection.

vtkActor2DCollection* vtkActor2DCollection::NewInstance

(

)

const

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

vtkActor2D * vtkActor2DCollection::GetNextActor2D ( )

inline

Standard Collection methods.

Definition at line 115 of file vtkActor2DCollection.h.

vtkActor2D * vtkActor2DCollection::GetLastActor2D ( )

inline

Standard Collection methods.

Definition at line 120 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 132 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 137 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 90 of file vtkActor2DCollection.h.

void vtkActor2DCollection::DeleteElement ( vtkCollectionElement *  )

overrideprotectedvirtual

Reimplemented from vtkCollection.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/Core/vtkActor2DCollection.h