a actor that draws 2D data More...

#include <vtkActor2D.h>

Inheritance diagram for vtkActor2D:

Collaboration diagram for vtkActor2D:

Public Types
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkActor2D *	NewInstance () const

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?

vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D.

virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D.

void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates.

vtkMTimeType	GetMTime () override
	Return this objects MTime.

void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D.

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.

virtual vtkCoordinate *	GetActualPositionCoordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.

virtual vtkCoordinate *	GetActualPosition2Coordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.


int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods.

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods.

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods.


virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn.

virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn.


virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render.

virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render.


virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate.

virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate.

virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate.

virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate.


virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable.

virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable.

virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable.

virtual float *	GetPosition2 ()
	Access the Position2 instance variable.


void	SetWidth (double w)
	Set/Get the height and width of the Actor2D.

double	GetWidth ()
	Set/Get the height and width of the Actor2D.

void	SetHeight (double h)
	Set/Get the height and width of the Actor2D.

double	GetHeight ()
	Set/Get the height and width of the Actor2D.

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.

Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkActor2D ()

	~vtkActor2D () override

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp ()

	~vtkProp () 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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

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 *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a actor that draws 2D data

vtkActor2D is similar to vtkActor, but it is made to be used with two dimensional images and annotation. vtkActor2D has a position but does not use a transformation matrix like vtkActor (see the superclass vtkProp for information on positioning vtkActor2D). vtkActor2D has a reference to a vtkMapper2D object which does the rendering.

See also: vtkProp vtkMapper2D vtkProperty2D

Examples:: vtkActor2D (Examples)

Online Examples:

LinearCellsDemo

ParametricSuperEllipsoidDemo

ReadLegacyUnstructuredGrid

Delaunay3D

CurvaturesDemo

KochanekSplineDemo

ThinPlateSplineTransform

BozoShaderDemo

LabeledMesh

Visualize2DPoints

Tests:: vtkActor2D (Tests)

Definition at line 144 of file vtkActor2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp vtkActor2D::Superclass

Definition at line 148 of file vtkActor2D.h.

Constructor & Destructor Documentation

◆ vtkActor2D()

vtkActor2D::vtkActor2D ( )

protected

◆ ~vtkActor2D()

vtkActor2D::~vtkActor2D ( )

overrideprotected

Member Function Documentation

◆ PrintSelf()

void vtkActor2D::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 vtkObjectBase.

Reimplemented in vtkArcGridActorPrivate, vtkAxisActor2D, vtkAxisGridActorPrivate, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkTextActor, vtkTexturedActor2D, vtkScaledTextActor, and vtkOpenGLTextActor.

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkActor2D::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 vtkProp.

Reimplemented in vtkAxisActor2DMock, vtkArcGridActorPrivate, vtkAxisActor2D, vtkAxisGridActorPrivate, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkTextActor, vtkTexturedActor2D, vtkScaledTextActor, and vtkOpenGLTextActor.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkActor2D::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkActor2D * vtkActor2D::NewInstance ( ) const

◆ New()

static vtkActor2D * vtkActor2D::New ( )

static

Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.

◆ RenderOverlay()

int vtkActor2D::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkArcGridActorPrivate, vtkBarChartActor, vtkCubeAxesActor2D, vtkParallelCoordinatesActor, vtkPieChartActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkAxisActor2D, vtkCaptionActor2D, vtkCornerAnnotation, vtkLeaderActor2D, vtkLegendBoxActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkScalarBarActor, vtkTextActor, vtkTexturedActor2D, and vtkOpenGLTextActor.

◆ RenderOpaqueGeometry()

int vtkActor2D::RenderOpaqueGeometry ( vtkViewport * viewport )

overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkAxisGridActorPrivate, vtkBarChartActor, vtkCubeAxesActor2D, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkSpiderPlotActor, vtkXYPlotActor, vtkAxisActor2D, vtkCaptionActor2D, vtkCornerAnnotation, vtkLeaderActor2D, vtkLegendBoxActor, vtkScalarBarActor, vtkTextActor, and vtkTexturedActor2D.

◆ RenderTranslucentPolygonalGeometry()

int vtkActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor2D, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkTextActor, and vtkTexturedActor2D.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkActor2D::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor2D, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkPolarAxesActor2D, vtkRadialGridActor2D, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, and vtkTextActor.

◆ SetMapper()

virtual void vtkActor2D::SetMapper ( vtkMapper2D * mapper )

virtual

Set/Get the vtkMapper2D which defines the data to be drawn.

◆ GetMapper()

virtual vtkMapper2D * vtkActor2D::GetMapper ( )

virtual

Set/Get the vtkMapper2D which defines the data to be drawn.

◆ SetLayerNumber()

virtual void vtkActor2D::SetLayerNumber ( int )

virtual

Set/Get the layer number in the overlay planes into which to render.

◆ GetLayerNumber()

virtual int vtkActor2D::GetLayerNumber ( )

virtual

Set/Get the layer number in the overlay planes into which to render.

◆ GetProperty()

vtkProperty2D * vtkActor2D::GetProperty ( )

Returns this actor's vtkProperty2D.

Creates a property if one doesn't already exist.

◆ SetProperty()

virtual void vtkActor2D::SetProperty ( vtkProperty2D * )

virtual

Set this vtkProp's vtkProperty2D.

◆ GetPositionCoordinate()

virtual vtkCoordinate * vtkActor2D::GetPositionCoordinate ( )

virtual

Get the PositionCoordinate instance of vtkCoordinate.

This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D

◆ SetPosition() [1/2]

virtual void vtkActor2D::SetPosition ( float x[2] )

virtual

Get the PositionCoordinate instance of vtkCoordinate.

This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D

◆ SetPosition() [2/2]

virtual void vtkActor2D::SetPosition	(	float	x,
		float	y
	)

virtual

Get the PositionCoordinate instance of vtkCoordinate.

This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D

◆ GetPosition()

virtual float * vtkActor2D::GetPosition ( )

virtual

Get the PositionCoordinate instance of vtkCoordinate.

This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D

◆ SetDisplayPosition()

void vtkActor2D::SetDisplayPosition	(	int	,
		int
	)

Set the Prop2D's position in display coordinates.

◆ GetPosition2Coordinate()

virtual vtkCoordinate * vtkActor2D::GetPosition2Coordinate ( )

virtual

Access the Position2 instance variable.

This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable

◆ SetPosition2() [1/2]

virtual void vtkActor2D::SetPosition2 ( float x[2] )

virtual

Access the Position2 instance variable.

This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable

◆ SetPosition2() [2/2]

virtual void vtkActor2D::SetPosition2	(	float	x,
		float	y
	)

virtual

Access the Position2 instance variable.

This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable

◆ GetPosition2()

virtual float * vtkActor2D::GetPosition2 ( )

virtual

Access the Position2 instance variable.

This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable

◆ SetWidth()

void vtkActor2D::SetWidth ( double w )

Set/Get the height and width of the Actor2D.

The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.

◆ GetWidth()

double vtkActor2D::GetWidth ( )

Set/Get the height and width of the Actor2D.

The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.

◆ SetHeight()

void vtkActor2D::SetHeight ( double h )

Set/Get the height and width of the Actor2D.

The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.

◆ GetHeight()

double vtkActor2D::GetHeight ( )

Set/Get the height and width of the Actor2D.

The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.

◆ GetMTime()

vtkMTimeType vtkActor2D::GetMTime ( )

overridevirtual

Return this objects MTime.

Reimplemented from vtkObject.

Reimplemented in vtkXYPlotActor, and vtkTexturedActor2D.

◆ GetActors2D()

void vtkActor2D::GetActors2D ( vtkPropCollection * pc )

overridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Reimplemented from vtkProp.

Reimplemented in vtkPolarAxesActor2D, and vtkRadialGridActor2D.

◆ ShallowCopy()

void vtkActor2D::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy of this vtkActor2D.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor2D, vtkCaptionActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkScalarBarActor, vtkTextActor, and vtkTexturedActor2D.

◆ ReleaseGraphicsResources()

void vtkActor2D::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor2D, vtkBarChartActor, vtkCaptionActor2D, vtkCornerAnnotation, vtkCubeAxesActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkPieChartActor, vtkScalarBarActor, vtkSpiderPlotActor, vtkXYPlotActor, vtkTextActor, and vtkTexturedActor2D.

◆ GetActualPositionCoordinate()

virtual vtkCoordinate * vtkActor2D::GetActualPositionCoordinate ( )

inlinevirtual

Return the actual vtkCoordinate reference that the mapper should use to position the actor.

This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored.

Definition at line 263 of file vtkActor2D.h.

◆ GetActualPosition2Coordinate()

virtual vtkCoordinate * vtkActor2D::GetActualPosition2Coordinate ( )

inlinevirtual

Return the actual vtkCoordinate reference that the mapper should use to position the actor.

This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored.

Definition at line 270 of file vtkActor2D.h.

Member Data Documentation

◆ Mapper

vtkMapper2D* vtkActor2D::Mapper

protected

Definition at line 276 of file vtkActor2D.h.

◆ LayerNumber

int vtkActor2D::LayerNumber

protected

Definition at line 277 of file vtkActor2D.h.

◆ Property

vtkProperty2D* vtkActor2D::Property

protected

Definition at line 278 of file vtkActor2D.h.

◆ PositionCoordinate

vtkCoordinate* vtkActor2D::PositionCoordinate

protected

Definition at line 279 of file vtkActor2D.h.

◆ Position2Coordinate

vtkCoordinate* vtkActor2D::Position2Coordinate

protected

Definition at line 280 of file vtkActor2D.h.

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

Rendering/Core/vtkActor2D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkActor2D()

◆ ~vtkActor2D()

Member Function Documentation

◆ PrintSelf()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ New()

◆ RenderOverlay()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ HasTranslucentPolygonalGeometry()

◆ SetMapper()

◆ GetMapper()

◆ SetLayerNumber()

◆ GetLayerNumber()

◆ GetProperty()

◆ SetProperty()

◆ GetPositionCoordinate()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ GetPosition()

◆ SetDisplayPosition()

◆ GetPosition2Coordinate()

◆ SetPosition2() [1/2]

◆ SetPosition2() [2/2]

◆ GetPosition2()

◆ SetWidth()

◆ GetWidth()

◆ SetHeight()

◆ GetHeight()

◆ GetMTime()

◆ GetActors2D()

◆ ShallowCopy()

◆ ReleaseGraphicsResources()

◆ GetActualPositionCoordinate()

◆ GetActualPosition2Coordinate()

Member Data Documentation

◆ Mapper

◆ LayerNumber

◆ Property

◆ PositionCoordinate

◆ Position2Coordinate