vtkTextActor Class Reference

#include <vtkTextActor.h>

Inheritance diagram for vtkTextActor:

[legend]

Collaboration diagram for vtkTextActor:

[legend]

List of all members.

Detailed Description

An actor that displays text. Scaled or unscaled.

vtkTextActor can be used to place text annotation into a window. When TextScaleMode is NONE, the text is fixed font and operation is the same as a vtkPolyDataMapper2D/vtkActor2D pair. When TextScaleMode is VIEWPORT, the font resizes such that it maintains a consistent size relative to the viewport in which it is rendered. When TextScaleMode is PROP, the font resizes such that the text fits inside the box defined by the position 1 & 2 coordinates. This class replaces the deprecated vtkScaledTextActor and acts as a convenient wrapper for a vtkTextMapper/vtkActor2D pair. Set the text property/attributes through the vtkTextProperty associated to this actor.

See also:: vtkActor2D vtkPolyDataMapper vtkTextProperty vtkFreeTypeUtilities

Examples:: vtkTextActor (Examples)

Tests:: vtkTextActor (Tests)

Definition at line 54 of file vtkTextActor.h.


Public Types
enum	{ TEXT_SCALE_MODE_NONE = 0, TEXT_SCALE_MODE_PROP, TEXT_SCALE_MODE_VIEWPORT }
typedef vtkActor2D	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ShallowCopy (vtkProp *prop)
void	SetMapper (vtkPolyDataMapper2D *mapper)
virtual void	SetNonLinearFontScale (double exponent, int target)
void	SpecifiedToDisplay (double pos, vtkViewport vport, int specified)
void	DisplayToSpecified (double pos, vtkViewport vport, int specified)
virtual void	ComputeScaledFont (vtkViewport *viewport)
virtual void	ReleaseGraphicsResources (vtkWindow *)

void	SetInput (const char *inputString)
char *	GetInput ()

virtual void	SetMinimumSize (int, int)
void	SetMinimumSize (int[2])
virtual int *	GetMinimumSize ()
virtual void	GetMinimumSize (int &, int &)
virtual void	GetMinimumSize (int[2])

virtual void	SetMaximumLineHeight (float)
virtual float	GetMaximumLineHeight ()

virtual void	SetTextScaleMode (int)
virtual int	GetTextScaleMode ()
void	SetTextScaleModeToNone ()
void	SetTextScaleModeToProp ()
void	SetTextScaleModeToViewport ()

void	SetScaledText (int)
int	GetScaledText ()
void	ScaledTextOn ()
void	ScaledTextOff ()

virtual void	SetUseBorderAlign (int)
virtual int	GetUseBorderAlign ()
virtual void	UseBorderAlignOn ()
virtual void	UseBorderAlignOff ()

void	SetAlignmentPoint (int point)
int	GetAlignmentPoint ()

void	SetOrientation (float orientation)
virtual float	GetOrientation ()

virtual void	SetTextProperty (vtkTextProperty *p)
virtual vtkTextProperty *	GetTextProperty ()

virtual vtkTextProperty *	GetScaledTextProperty ()

virtual int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *viewport)

virtual int	HasTranslucentPolygonalGeometry ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTextActor *	SafeDownCast (vtkObject *o)
static vtkTextActor *	New ()
static float	GetFontScale (vtkViewport *viewport)
Protected Member Functions
void	SetMapper (vtkMapper2D *mapper)
	vtkTextActor ()
	~vtkTextActor ()
virtual void	ComputeRectangle (vtkViewport *viewport)
virtual void	SetTexture (vtkTexture *)
virtual vtkTexture *	GetTexture ()
Protected Attributes
int	MinimumSize [2]
float	MaximumLineHeight
double	FontScaleExponent
int	TextScaleMode
float	Orientation
int	UseBorderAlign
vtkTextProperty *	TextProperty
vtkImageData *	ImageData
vtkPolyDataMapper2D *	PDMapper
vtkFreeTypeUtilities *	FreeTypeUtilities
vtkTimeStamp	BuildTime
vtkTransform *	Transform
int	LastSize [2]
int	LastOrigin [2]
char *	Input
bool	InputRendered
double	FormerOrientation
vtkTextProperty *	ScaledTextProperty
vtkPolyData *	Rectangle
vtkPoints *	RectanglePoints
vtkTexture *	Texture

Member Typedef Documentation

typedef vtkActor2D vtkTextActor::Superclass

Reimplemented from vtkActor2D.

Reimplemented in vtkScaledTextActor.

Definition at line 57 of file vtkTextActor.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

TEXT_SCALE_MODE_NONE
TEXT_SCALE_MODE_PROP
TEXT_SCALE_MODE_VIEWPORT

Definition at line 115 of file vtkTextActor.h.

Constructor & Destructor Documentation

vtkTextActor::vtkTextActor ( ) [protected]

vtkTextActor::~vtkTextActor ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkActor2D.

Reimplemented in vtkScaledTextActor.

static int vtkTextActor::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 vtkActor2D.

Reimplemented in vtkScaledTextActor.

virtual int vtkTextActor::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 vtkActor2D.

Reimplemented in vtkScaledTextActor.

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

Reimplemented from vtkActor2D.

Reimplemented in vtkScaledTextActor.

void vtkTextActor::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 vtkActor2D.

Reimplemented in vtkScaledTextActor.

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

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).

Reimplemented from vtkActor2D.

Reimplemented in vtkScaledTextActor.

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

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

Reimplemented from vtkActor2D.

void vtkTextActor::SetMapper ( vtkPolyDataMapper2D * mapper )

Override the vtkPolyDataMapper2D that defines the text to be drawn. One will be created by default if none is supplied

void vtkTextActor::SetInput ( const char * inputString )

Set the text string to be displayed. "\n" is recognized as a carriage return/linefeed (line separator). The characters must be in the ISO-8859-1 encoding. Convenience method to the underlying mapper

char* vtkTextActor::GetInput ( )

Set the text string to be displayed. "\n" is recognized as a carriage return/linefeed (line separator). The characters must be in the ISO-8859-1 encoding. Convenience method to the underlying mapper

virtual void vtkTextActor::SetMinimumSize	(	int	,
		int
	)			`[virtual]`