vtkTextActor3D Class Reference

#include <vtkTextActor3D.h>

Inheritance diagram for vtkTextActor3D:

Inheritance graph
[legend]
Collaboration diagram for vtkTextActor3D:

Collaboration graph
[legend]

List of all members.


Detailed Description

An actor that displays text.

The input text is rendered into a buffer, which in turn is used as a texture applied onto a quad (a vtkImageActor is used under the hood).

Warning:
This class is experimental at the moment.
  • The orientation is not optimized, the quad should be oriented, not the text itself when it is rendered in the buffer (we end up with excessively big textures for 45 degrees angles). This will be fixed first.
  • No checking is done at the moment regarding hardware texture size limits.
  • Alignment is not supported (soon).
  • Multiline is not supported.
  • Need to fix angle out of 0<->360
See also:
vtkProp3D
Examples:
vtkTextActor3D (Examples)
Tests:
vtkTextActor3D (Tests)

Definition at line 50 of file vtkTextActor3D.h.


Public Types

typedef vtkProp3D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void ShallowCopy (vtkProp *prop)
virtual double * GetBounds ()
int GetBoundingBox (int bbox[4])
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void SetInput (const char *)
virtual char * GetInput ()
virtual void SetTextProperty (vtkTextProperty *p)
virtual vtkTextPropertyGetTextProperty ()
int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
int RenderOverlay (vtkViewport *viewport)
virtual int HasTranslucentPolygonalGeometry ()

Static Public Member Functions

static vtkTextActor3DNew ()
static int IsTypeOf (const char *type)
static vtkTextActor3DSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTextActor3D ()
 ~vtkTextActor3D ()
virtual int UpdateImageActor ()

Protected Attributes

char * Input
vtkImageActorImageActor
vtkImageDataImageData
vtkTextPropertyTextProperty
vtkTimeStamp BuildTime

Member Typedef Documentation

Reimplemented from vtkProp3D.

Definition at line 54 of file vtkTextActor3D.h.


Constructor & Destructor Documentation

vtkTextActor3D::vtkTextActor3D (  )  [protected]

vtkTextActor3D::~vtkTextActor3D (  )  [protected]


Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

Reimplemented from vtkProp3D.

static int vtkTextActor3D::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

virtual int vtkTextActor3D::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 vtkProp3D.

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

Reimplemented from vtkProp3D.

void vtkTextActor3D::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 vtkProp3D.

virtual void vtkTextActor3D::SetInput ( const char *   )  [virtual]

Set the text string to be displayed.

virtual char* vtkTextActor3D::GetInput (  )  [virtual]

Set the text string to be displayed.

virtual void vtkTextActor3D::SetTextProperty ( vtkTextProperty p  )  [virtual]

Set/Get the text property.

virtual vtkTextProperty* vtkTextActor3D::GetTextProperty (  )  [virtual]

Set/Get the text property.

void vtkTextActor3D::ShallowCopy ( vtkProp prop  )  [virtual]

Shallow copy of this text actor. Overloads the virtual vtkProp method.

Reimplemented from vtkProp3D.

virtual double* vtkTextActor3D::GetBounds (  )  [virtual]

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). These are the padded-to-power-of-two texture bounds.

Implements vtkProp3D.

int vtkTextActor3D::GetBoundingBox ( int  bbox[4]  ) 

Get the Freetype-derived real bounding box for the given vtkTextProperty and text string str. Results are returned in the four element bbox int array. This call can be used for sizing other elements.

virtual void vtkTextActor3D::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. 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.

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

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Draw the text actor to the screen.

Reimplemented from vtkProp.

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

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Draw the text actor to the screen.

Reimplemented from vtkProp.

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

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Draw the text actor to the screen.

Reimplemented from vtkProp.

virtual int vtkTextActor3D::HasTranslucentPolygonalGeometry (  )  [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

virtual int vtkTextActor3D::UpdateImageActor (  )  [protected, virtual]


Member Data Documentation

char* vtkTextActor3D::Input [protected]

Definition at line 109 of file vtkTextActor3D.h.

Definition at line 111 of file vtkTextActor3D.h.

Definition at line 112 of file vtkTextActor3D.h.

Definition at line 113 of file vtkTextActor3D.h.

Definition at line 115 of file vtkTextActor3D.h.


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

Generated on Wed Aug 24 12:12:25 2011 for VTK by  doxygen 1.5.6