---

vtkActor2D Class Reference

a actor that draws 2D data. More...

#include <vtkActor2D.h>

Inheritance diagram for vtkActor2D:

[legend]Collaboration diagram for vtkActor2D:

[legend]List of all members.

Public Methods
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
int	RenderOverlay (vtkViewport *viewport)
int	RenderOpaqueGeometry (vtkViewport *viewport)
int	RenderTranslucentGeometry (vtkViewport *viewport)
void	SetMapper (vtkMapper2D *mapper)
virtual vtkMapper2D *	GetMapper ()
virtual void	SetLayerNumber (int)
virtual int	GetLayerNumber ()
vtkProperty2D *	GetProperty ()
virtual void	SetProperty (vtkProperty2D *)
virtual vtkCoordinate *	GetPositionCoordinate ()
virtual void	SetPosition (float x[2])
virtual void	SetPosition (float x, float y)
virtual float *	GetPosition ()
void	SetDisplayPosition (int, int)
virtual vtkCoordinate *	GetPosition2Coordinate ()
virtual void	SetPosition2 (float x[2])
virtual void	SetPosition2 (float x, float y)
virtual float *	GetPosition2 ()
void	SetWidth (float w)
float	GetWidth ()
void	SetHeight (float h)
float	GetHeight ()
unsigned long	GetMTime ()
virtual void	GetActors2D (vtkPropCollection *pc)
void	ShallowCopy (vtkProp *prop)
virtual void	ReleaseGraphicsResources (vtkWindow *)
Static Public Methods
int	IsTypeOf (const char *type)
vtkActor2D *	SafeDownCast (vtkObject *o)
vtkActor2D *	New ()
Protected Methods
	vtkActor2D ()
	~vtkActor2D ()
	vtkActor2D (const vtkActor2D &)
void	operator= (const vtkActor2D &)
Protected Attributes
vtkMapper2D *	Mapper
int	LayerNumber
vtkProperty2D *	Property
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate

---

Detailed Description

a actor that draws 2D data.

Date:

2000/12/10 20:08:05

Revision:

1.30

Thanks:

Thanks to Matt Turek who developed this class.

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)

Definition at line 67 of file vtkActor2D.h.

---

Constructor & Destructor Documentation

vtkActor2D::vtkActor2D (    )  [protected]

vtkActor2D::~vtkActor2D (    )  [protected]

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

Definition at line 139 of file vtkActor2D.h.

---

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 vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

virtual const char* vtkActor2D::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 vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

int vtkActor2D::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 vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

virtual int vtkActor2D::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 vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

vtkActor2D* vtkActor2D::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 vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor. Referenced by vtkActor2DCollection::GetLastActor2D(), and vtkActor2DCollection::GetNextActor2D().

vtkActor2D* vtkActor2D::New (    )  [static]

Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. Reimplemented from vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

int vtkActor2D::RenderOverlay (  vtkViewport *    viewport )  [virtual]

Support the standard render methods. Reimplemented from vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

int vtkActor2D::RenderOpaqueGeometry (  vtkViewport *    viewport )  [virtual]

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. There are five key render methods in vtk and they correspond to five different points in the rendering cycle. Any given prop may implement one or more of these methods. The first two methods are designed to render 3D geometry such as polygons lines, triangles. We render the opaque first then the transparent. Ray casting is different from the other methods in that the rendering process is driven not by the mapper but by the ray caster. Two methods are required to support ray casting - one for initialization, and the other to cast a ray (in viewing coordinates.) The next three methods are primarily intended for volume rendering and supports any technique that returns an image to be composited. The RenderIntoImage() method causes the rendering to occur, and the GetRGBAImage() and GetZImage() methods are used to gather results. The last method is to render any 2D annotation or overlays. Except for the ray casting methods, these methods return an integer value indicating whether or not this render method was applied to this data. For the ray cast initialization, the integer indicated whether or not the initialization was successful. For ray casting, the integer return value indicates whether or not the ray intersected something. Reimplemented from vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

int vtkActor2D::RenderTranslucentGeometry (  vtkViewport *    viewport )  [virtual]

Reimplemented from vtkProp. Reimplemented in vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

void vtkActor2D::SetMapper (  vtkMapper2D *    mapper )

Set/Get the vtkMapper2D which defines the data to be drawn. Referenced by vtkScaledTextActor::LastOrigin().

virtual vtkMapper2D* vtkActor2D::GetMapper (    )  [virtual]

virtual void vtkActor2D::SetLayerNumber (  int    )  [virtual]

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

virtual int vtkActor2D::GetLayerNumber (    )  [virtual]

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]

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

virtual float* vtkActor2D::GetPosition (    )  [virtual]

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]

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

virtual float* vtkActor2D::GetPosition2 (    )  [virtual]

void vtkActor2D::SetWidth (  float    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.

float vtkActor2D::GetWidth (    )

void vtkActor2D::SetHeight (  float    h )

float vtkActor2D::GetHeight (    )

unsigned long vtkActor2D::GetMTime (    )  [virtual]

Return this objects MTime. Reimplemented from vtkObject. Reimplemented in vtkXYPlotActor.

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.

void vtkActor2D::ShallowCopy (  vtkProp *    prop )  [virtual]

Shallow copy of this vtkActor2D. Overloads the virtual vtkProp method. Reimplemented from vtkProp. Reimplemented in vtkLegendBoxActor, vtkAxisActor2D, vtkScalarBarActor, and vtkScaledTextActor.

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 vtkCubeAxesActor2D, vtkLegendBoxActor, vtkXYPlotActor, vtkAxisActor2D, vtkParallelCoordinatesActor, vtkScalarBarActor, and vtkScaledTextActor.

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

Definition at line 140 of file vtkActor2D.h.

---

Member Data Documentation

vtkMapper2D* vtkActor2D::Mapper [protected]

Definition at line 142 of file vtkActor2D.h.

int vtkActor2D::LayerNumber [protected]

Definition at line 143 of file vtkActor2D.h.

vtkProperty2D* vtkActor2D::Property [protected]

Definition at line 144 of file vtkActor2D.h.

vtkCoordinate* vtkActor2D::PositionCoordinate [protected]

Definition at line 145 of file vtkActor2D.h.

vtkCoordinate* vtkActor2D::Position2Coordinate [protected]

Definition at line 146 of file vtkActor2D.h.

---

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

• common/vtkActor2D.h

---