VTK  9.1.0
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 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...
 
vtkActor2DCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
vtkActor2DGetNextActor2D (vtkCollectionSimpleIterator &cookie)
 Reentrant safe way to get an object in a collection. More...
 
int IsItemPresent (vtkActor2D *a)
 Standard Collection methods. More...
 
vtkActor2DGetNextActor2D ()
 Standard Collection methods. More...
 
vtkActor2DGetLastActor2D ()
 Standard Collection methods. More...
 
vtkActor2DGetNextItem ()
 Access routines that are provided for compatibility with previous version of VTK. More...
 
vtkActor2DGetLastItem ()
 Access routines that are provided for compatibility with previous version of VTK. More...
 
- Public Member Functions inherited from vtkPropCollection
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPropCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddItem (vtkProp *a)
 Add a Prop to the bottom of the list. More...
 
vtkPropGetNextProp ()
 Get the next Prop in the list. More...
 
vtkPropGetLastProp ()
 Get the last Prop in the list. More...
 
int GetNumberOfPaths ()
 Get the number of paths contained in this list. More...
 
vtkPropGetNextProp (vtkCollectionSimpleIterator &cookie)
 Reentrant safe way to get an object in a collection. More...
 
- Public Member Functions inherited from vtkCollection
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCollectionNewInstance () 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...
 
vtkObjectGetNextItemAsObject ()
 Get the next item in the collection. More...
 
vtkObjectGetItemAsObject (int i)
 Get the i'th item in the collection. More...
 
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to get the next object as a collection. More...
 
vtkCollectionIteratorNewIterator ()
 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...
 
vtkCommandGetCommand (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 vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkActor2DCollectionNew ()
 Destructor for the vtkActor2DCollection class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkActor2DCollectionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPropCollection
static vtkPropCollectionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropCollectionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCollection
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkCollectionNew ()
 Construct with empty list. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkActor2DCollection ()=default
 
 ~vtkActor2DCollection () override
 
void DeleteElement (vtkCollectionElement *) override
 
- Protected Member Functions inherited from vtkPropCollection
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPropCollection ()=default
 
 ~vtkPropCollection () override=default
 
- Protected Member Functions inherited from vtkCollection
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCollection ()
 
 ~vtkCollection () override
 
virtual void RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
 
virtual void DeleteElement (vtkCollectionElement *)
 
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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkCollection
int NumberOfItems
 
vtkCollectionElementTop
 
vtkCollectionElementBottom
 
vtkCollectionElementCurrent
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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

◆ Superclass

Definition at line 47 of file vtkActor2DCollection.h.

Constructor & Destructor Documentation

◆ vtkActor2DCollection()

vtkActor2DCollection::vtkActor2DCollection ( )
protecteddefault

◆ ~vtkActor2DCollection()

vtkActor2DCollection::~vtkActor2DCollection ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkActor2DCollection * vtkActor2DCollection::New ( )
static

Destructor for the vtkActor2DCollection class.

This removes all objects from the collection.

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

static vtkActor2DCollection * vtkActor2DCollection::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkActor2DCollection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPropCollection.

◆ NewInstance()

vtkActor2DCollection * vtkActor2DCollection::NewInstance ( ) const

◆ PrintSelf()

void vtkActor2DCollection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ Sort()

void vtkActor2DCollection::Sort ( )

Sorts the vtkActor2DCollection by layer number.

Smaller layer numbers are first. Layer numbers can be any integer value.

◆ AddItem()

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.

◆ IsItemPresent()

int vtkActor2DCollection::IsItemPresent ( vtkActor2D a)
inline

Standard Collection methods.

Definition at line 112 of file vtkActor2DCollection.h.

◆ GetNextActor2D() [1/2]

vtkActor2D * vtkActor2DCollection::GetNextActor2D ( )
inline

Standard Collection methods.

Definition at line 117 of file vtkActor2DCollection.h.

◆ GetLastActor2D()

vtkActor2D * vtkActor2DCollection::GetLastActor2D ( )
inline

Standard Collection methods.

Definition at line 122 of file vtkActor2DCollection.h.

◆ GetNextItem()

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

◆ GetLastItem()

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

◆ RenderOverlay()

void vtkActor2DCollection::RenderOverlay ( vtkViewport viewport)

Sort and then render the collection of 2D actors.

◆ GetNextActor2D() [2/2]

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.

◆ DeleteElement()

void vtkActor2DCollection::DeleteElement ( vtkCollectionElement )
overrideprotectedvirtual

Reimplemented from vtkCollection.


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