vtkActor2D Class Reference

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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsA (const char *type)
vtkActor2D *	NewInstance () const
virtual int	HasTranslucentPolygonalGeometry ()
vtkProperty2D *	GetProperty ()
virtual void	SetProperty (vtkProperty2D *)
void	SetDisplayPosition (int, int)
virtual unsigned long	GetMTime ()
virtual void	GetActors2D (vtkPropCollection *pc)
virtual void	ShallowCopy (vtkProp *prop)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOverlay (vtkViewport *viewport)
virtual int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
virtual void	SetMapper (vtkMapper2D *mapper)
virtual vtkMapper2D *	GetMapper ()
virtual void	SetLayerNumber (int)
virtual int	GetLayerNumber ()
virtual vtkCoordinate *	GetPositionCoordinate ()
virtual void	SetPosition (float x[2])
virtual void	SetPosition (float x, float y)
virtual float *	GetPosition ()
virtual vtkCoordinate *	GetPosition2Coordinate ()
virtual void	SetPosition2 (float x[2])
virtual void	SetPosition2 (float x, float y)
virtual float *	GetPosition2 ()
void	SetWidth (double w)
double	GetWidth ()
void	SetHeight (double h)
double	GetHeight ()
virtual vtkCoordinate *	GetActualPositionCoordinate (void)
virtual vtkCoordinate *	GetActualPosition2Coordinate (void)
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Pick ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void	GetActors (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	SetVisibility (int)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetPickable (int)
virtual int	GetPickable ()
virtual void	PickableOn ()
virtual void	PickableOff ()
virtual void	SetDragable (int)
virtual int	GetDragable ()
virtual void	DragableOn ()
virtual void	DragableOff ()
virtual unsigned long	GetRedrawMTime ()
virtual void	SetUseBounds (bool)
virtual bool	GetUseBounds ()
virtual void	UseBoundsOn ()
virtual void	UseBoundsOff ()
virtual double *	GetBounds ()
virtual void	InitPathTraversal ()
virtual vtkAssemblyPath *	GetNextPath ()
virtual int	GetNumberOfPaths ()
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkMatrix4x4 *	GetMatrix ()
virtual vtkInformation *	GetPropertyKeys ()
virtual void	SetPropertyKeys (vtkInformation *keys)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double	GetEstimatedRenderTime (vtkViewport *)
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
virtual void	RestoreEstimatedRenderTime ()
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double	GetAllocatedRenderTime ()
void	SetRenderTimeMultiplier (double t)
virtual double	GetRenderTimeMultiplier ()
virtual bool	GetSupportsSelection ()
virtual int	GetNumberOfConsumers ()
void	AddConsumer (vtkObject *c)
void	RemoveConsumer (vtkObject *c)
vtkObject *	GetConsumer (int i)
int	IsConsumer (vtkObject *c)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkActor2D *	SafeDownCast (vtkObjectBase *o)
static vtkActor2D *	New ()
Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkActor2D ()
	~vtkActor2D ()
Protected Member Functions inherited from vtkProp
	vtkProp ()
	~vtkProp ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkMapper2D *	Mapper
int	LayerNumber
vtkProperty2D *	Property
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate
Protected Attributes inherited from vtkProp
int	Visibility
int	Pickable
int	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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)

Tests:

vtkActor2D (Tests)

Definition at line 44 of file vtkActor2D.h.

Member Typedef Documentation

typedef vtkProp vtkActor2D::Superclass

Definition at line 48 of file vtkActor2D.h.

Constructor & Destructor Documentation

vtkActor2D::vtkActor2D ( )

protected

vtkActor2D::~vtkActor2D ( )

protected

Member Function Documentation

void vtkActor2D::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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

Reimplemented in vtkTextActor, vtkTexturedActor2D, and vtkScaledTextActor.

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

static

virtual int 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 vtkXYPlotActor, vtkParallelCoordinatesActor, vtkScalarBarActor, vtkCaptionActor2D, vtkSpiderPlotActor, vtkAxisActor2D, vtkCubeAxesActor2D, vtkLegendBoxActor, vtkLeaderActor2D, vtkPieChartActor, vtkBarChartActor, vtkTextActor, vtkCornerAnnotation, vtkTexturedActor2D, and vtkScaledTextActor.

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

static

virtual vtkObjectBase* vtkActor2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp.

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

vtkActor2D* vtkActor2D::NewInstance

(

)

const

static vtkActor2D* vtkActor2D::New ( )

static

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

virtual int vtkActor2D::RenderOverlay ( vtkViewport *  viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

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

virtual int vtkActor2D::RenderOpaqueGeometry ( vtkViewport *  viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

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

virtual int vtkActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

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

virtual int vtkActor2D::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

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

virtual void vtkActor2D::SetMapper ( vtkMapper2D *  mapper )

virtual

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

virtual vtkMapper2D* vtkActor2D::GetMapper ( )

virtual

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

virtual void vtkActor2D::SetLayerNumber ( int  )

virtual

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

virtual int vtkActor2D::GetLayerNumber ( )

virtual

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

vtkProperty2D* vtkActor2D::GetProperty

(

)

Returns this actor's vtkProperty2D. Creates a property if one doesn't already exist.

virtual void vtkActor2D::SetProperty ( vtkProperty2D *  )

virtual

Set this vtkProp's vtkProperty2D.

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

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

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

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

void vtkActor2D::SetDisplayPosition	(	int	,
		int
	)

Set the Prop2D's position in display coordinates.

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

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

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

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

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.

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.

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.

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.

virtual unsigned long vtkActor2D::GetMTime ( )

virtual

Return this objects MTime.

Reimplemented from vtkObject.

Reimplemented in vtkXYPlotActor, and vtkTexturedActor2D.

virtual void vtkActor2D::GetActors2D ( vtkPropCollection *  pc )

virtual

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.

virtual void vtkActor2D::ShallowCopy ( vtkProp *  prop )

virtual

Shallow copy of this vtkActor2D. Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

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

virtual void vtkActor2D::ReleaseGraphicsResources ( vtkWindow *  )

virtual

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 vtkXYPlotActor, vtkAxisActor2D, vtkCubeAxesActor2D, vtkTextActor, vtkSpiderPlotActor, vtkCaptionActor2D, vtkLeaderActor2D, vtkLegendBoxActor, vtkParallelCoordinatesActor, vtkBarChartActor, vtkPieChartActor, vtkScalarBarActor, vtkCornerAnnotation, and vtkTexturedActor2D.

virtual vtkCoordinate* vtkActor2D::GetActualPositionCoordinate ( void  )

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 132 of file vtkActor2D.h.

virtual vtkCoordinate* vtkActor2D::GetActualPosition2Coordinate ( void  )

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 140 of file vtkActor2D.h.

Member Data Documentation

vtkMapper2D* vtkActor2D::Mapper

protected

Definition at line 148 of file vtkActor2D.h.

int vtkActor2D::LayerNumber

protected

Definition at line 149 of file vtkActor2D.h.

vtkProperty2D* vtkActor2D::Property

protected

Definition at line 150 of file vtkActor2D.h.

vtkCoordinate* vtkActor2D::PositionCoordinate

protected

Definition at line 151 of file vtkActor2D.h.

vtkCoordinate* vtkActor2D::Position2Coordinate

protected

Definition at line 152 of file vtkActor2D.h.

---

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

• dox/Rendering/Core/vtkActor2D.h