VTK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTextActor3D Class Reference

An actor that displays text. More...

#include <vtkTextActor3D.h>

Inherits vtkProp3D.

Public Types

typedef vtkProp3D Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTextActor3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ShallowCopy (vtkProp *prop)
 
virtual double * GetBounds ()
 
virtual int GetBoundingBox (int bbox[4])
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual void SetInput (const char *)
 
virtual char * GetInput ()
 
virtual void SetTextProperty (vtkTextProperty *p)
 
virtual vtkTextProperty * GetTextProperty ()
 
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 (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTextActor3D ()
 
 ~vtkTextActor3D ()
 
virtual int UpdateImageActor ()
 

Protected Attributes

char * Input
 
vtkImageActor * ImageActor
 
vtkImageData * ImageData
 
vtkTextProperty * TextProperty
 
vtkTimeStamp BuildTime
 

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 51 of file vtkTextActor3D.h.

Member Typedef Documentation

typedef vtkProp3D vtkTextActor3D::Superclass

Definition at line 55 of file vtkTextActor3D.h.

Constructor & Destructor Documentation

vtkTextActor3D::vtkTextActor3D ( )
protected
vtkTextActor3D::~vtkTextActor3D ( )
protected

Member Function Documentation

static vtkTextActor3D* vtkTextActor3D::New ( )
static
static int vtkTextActor3D::IsTypeOf ( const char *  type)
static
virtual int vtkTextActor3D::IsA ( const char *  type)
virtual
static vtkTextActor3D* vtkTextActor3D::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTextActor3D::NewInstanceInternal ( ) const
protectedvirtual
vtkTextActor3D* vtkTextActor3D::NewInstance ( ) const
void vtkTextActor3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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)

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

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.

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

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.

int vtkTextActor3D::RenderOpaqueGeometry ( vtkViewport *  viewport)

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.

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.

int vtkTextActor3D::RenderOverlay ( vtkViewport *  viewport)

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.

virtual int vtkTextActor3D::HasTranslucentPolygonalGeometry ( )
virtual

Does this prop have some translucent polygonal geometry?

virtual int vtkTextActor3D::UpdateImageActor ( )
protectedvirtual

Member Data Documentation

char* vtkTextActor3D::Input
protected

Definition at line 110 of file vtkTextActor3D.h.

vtkImageActor* vtkTextActor3D::ImageActor
protected

Definition at line 112 of file vtkTextActor3D.h.

vtkImageData* vtkTextActor3D::ImageData
protected

Definition at line 113 of file vtkTextActor3D.h.

vtkTextProperty* vtkTextActor3D::TextProperty
protected

Definition at line 114 of file vtkTextActor3D.h.

vtkTimeStamp vtkTextActor3D::BuildTime
protected

Definition at line 116 of file vtkTextActor3D.h.


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