vtkActor2D Class Reference

#include <vtkActor2D.h>

Inheritance diagram for vtkActor2D:

Inheritance graph
[legend]
Collaboration diagram for vtkActor2D:

Collaboration graph
[legend]

List of all members.


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


Public Types

typedef vtkProp Superclass

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual int HasTranslucentPolygonalGeometry ()
vtkProperty2DGetProperty ()
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 vtkMapper2DGetMapper ()
virtual void SetLayerNumber (int)
virtual int GetLayerNumber ()
virtual vtkCoordinateGetPositionCoordinate ()
virtual void SetPosition (float x[2])
virtual void SetPosition (float x, float y)
virtual float * GetPosition ()
virtual vtkCoordinateGetPosition2Coordinate ()
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 vtkCoordinateGetActualPositionCoordinate (void)
virtual vtkCoordinateGetActualPosition2Coordinate (void)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkActor2DSafeDownCast (vtkObject *o)
static vtkActor2DNew ()

Protected Member Functions

 vtkActor2D ()
 ~vtkActor2D ()

Protected Attributes

vtkMapper2DMapper
int LayerNumber
vtkProperty2DProperty
vtkCoordinatePositionCoordinate
vtkCoordinatePosition2Coordinate

Member Typedef Documentation


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

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

virtual const char* vtkActor2D::GetClassName (  )  [virtual]

static int vtkActor2D::IsTypeOf ( const char *  name  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkProp.

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

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkProp.

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

static vtkActor2D* vtkActor2D::SafeDownCast ( vtkObject o  )  [static]

static vtkActor2D* vtkActor2D::New (  )  [static]

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

Reimplemented from vtkObject.

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

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

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

virtual int vtkActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport viewport  )  [virtual]

virtual int vtkActor2D::HasTranslucentPolygonalGeometry (  )  [virtual]

virtual void vtkActor2D::SetMapper ( vtkMapper2D mapper  )  [virtual]

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

Reimplemented in vtkTextActor.

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 vtkCaptionActor2D, vtkLegendBoxActor, vtkAxisActor2D, vtkLeaderActor2D, vtkScalarBarActor, vtkTextActor, and vtkTexturedActor2D.

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

virtual vtkCoordinate* vtkActor2D::GetActualPositionCoordinate ( void   )  [inline, virtual]

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

virtual vtkCoordinate* vtkActor2D::GetActualPosition2Coordinate ( void   )  [inline, virtual]

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


Member Data Documentation

Definition at line 147 of file vtkActor2D.h.

int vtkActor2D::LayerNumber [protected]

Definition at line 148 of file vtkActor2D.h.

Definition at line 149 of file vtkActor2D.h.

Definition at line 150 of file vtkActor2D.h.

Definition at line 151 of file vtkActor2D.h.


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

Generated on Sat Dec 27 13:16:22 2008 for VTK by  doxygen 1.5.6