vtkTextActor Class Reference

#include <vtkTextActor.h>

Inheritance diagram for vtkTextActor:

Inheritance graph
[legend]
Collaboration diagram for vtkTextActor:

Collaboration graph
[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 vtkTextPropertyGetTextProperty ()
virtual vtkTextPropertyGetScaledTextProperty ()
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 vtkTextActorSafeDownCast (vtkObject *o)
static vtkTextActorNew ()
static float GetFontScale (vtkViewport *viewport)

Protected Member Functions

void SetMapper (vtkMapper2D *mapper)
 vtkTextActor ()
 ~vtkTextActor ()
virtual void ComputeRectangle (vtkViewport *viewport)
virtual void SetTexture (vtkTexture *)
virtual vtkTextureGetTexture ()

Protected Attributes

int MinimumSize [2]
float MaximumLineHeight
double FontScaleExponent
int TextScaleMode
float Orientation
int UseBorderAlign
vtkTextPropertyTextProperty
vtkImageDataImageData
vtkPolyDataMapper2DPDMapper
vtkFreeTypeUtilitiesFreeTypeUtilities
vtkTimeStamp BuildTime
vtkTransformTransform
int LastSize [2]
int LastOrigin [2]
char * Input
bool InputRendered
double FormerOrientation
vtkTextPropertyScaledTextProperty
vtkPolyDataRectangle
vtkPointsRectanglePoints
vtkTextureTexture

Member Typedef Documentation

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]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

void vtkTextActor::SetMinimumSize ( int  [2]  ) 

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual int* vtkTextActor::GetMinimumSize (  )  [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual void vtkTextActor::GetMinimumSize ( int &  ,
int &   
) [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual void vtkTextActor::GetMinimumSize ( int  [2]  )  [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual void vtkTextActor::SetMaximumLineHeight ( float   )  [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0. Only valid when TextScaleMode is PROP.

virtual float vtkTextActor::GetMaximumLineHeight (  )  [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0. Only valid when TextScaleMode is PROP.

virtual void vtkTextActor::SetTextScaleMode ( int   )  [virtual]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

virtual int vtkTextActor::GetTextScaleMode (  )  [virtual]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

void vtkTextActor::SetTextScaleModeToNone (  )  [inline]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Definition at line 106 of file vtkTextActor.h.

void vtkTextActor::SetTextScaleModeToProp (  )  [inline]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Definition at line 108 of file vtkTextActor.h.

void vtkTextActor::SetTextScaleModeToViewport (  )  [inline]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Definition at line 110 of file vtkTextActor.h.

void vtkTextActor::SetScaledText ( int   ) 

DO NOT CALL. Deprecated in VTK 5.4. Use SetTextScaleMode or GetTextScaleMode instead.

int vtkTextActor::GetScaledText (  ) 

DO NOT CALL. Deprecated in VTK 5.4. Use SetTextScaleMode or GetTextScaleMode instead.

void vtkTextActor::ScaledTextOn (  ) 

DO NOT CALL. Deprecated in VTK 5.4. Use SetTextScaleMode or GetTextScaleMode instead.

void vtkTextActor::ScaledTextOff (  ) 

DO NOT CALL. Deprecated in VTK 5.4. Use SetTextScaleMode or GetTextScaleMode instead.

virtual void vtkTextActor::SetUseBorderAlign ( int   )  [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation

virtual int vtkTextActor::GetUseBorderAlign (  )  [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation

virtual void vtkTextActor::UseBorderAlignOn (  )  [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation

virtual void vtkTextActor::UseBorderAlignOff (  )  [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation

void vtkTextActor::SetAlignmentPoint ( int  point  ) 

This method is being depricated. Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre

6   7	8 3   4   5 0	1   2 
This is the same as setting the TextProperty's justification. Currently TextActor is not oriented around its AlignmentPoint.

int vtkTextActor::GetAlignmentPoint (  ) 

This method is being depricated. Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre

6   7	8 3   4   5 0	1   2 
This is the same as setting the TextProperty's justification. Currently TextActor is not oriented around its AlignmentPoint.

void vtkTextActor::SetOrientation ( float  orientation  ) 

Counterclockwise rotation around the Alignment point. Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.

virtual float vtkTextActor::GetOrientation (  )  [virtual]

Counterclockwise rotation around the Alignment point. Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.

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

Set/Get the text property.

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

Set/Get the text property.

virtual void vtkTextActor::SetNonLinearFontScale ( double  exponent,
int  target 
) [virtual]

Enable non-linear scaling of font sizes. This is useful in combination with scaled text. With small windows you want to use the entire scaled text area. With larger windows you want to reduce the font size some so that the entire area is not used. These values modify the computed font size as follows: newFontSize = pow(FontSize,exponent)*pow(target,1.0 - exponent) typically exponent should be around 0.7 and target should be around 10

void vtkTextActor::SpecifiedToDisplay ( double *  pos,
vtkViewport vport,
int  specified 
)

This is just a simple coordinate conversion method used in the render process.

void vtkTextActor::DisplayToSpecified ( double *  pos,
vtkViewport vport,
int  specified 
)

This is just a simple coordinate conversion method used in the render process.

virtual void vtkTextActor::ComputeScaledFont ( vtkViewport viewport  )  [virtual]

Compute the scale the font should be given the viewport. The result is placed in the ScaledTextProperty ivar.

virtual vtkTextProperty* vtkTextActor::GetScaledTextProperty (  )  [virtual]

Get the scaled font. Use ComputeScaledFont to set the scale for a given viewport.

static float vtkTextActor::GetFontScale ( vtkViewport viewport  )  [static]

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

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

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

virtual int vtkTextActor::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [inline, 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 vtkActor2D.

Definition at line 215 of file vtkTextActor.h.

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

virtual int vtkTextActor::HasTranslucentPolygonalGeometry (  )  [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

void vtkTextActor::SetMapper ( vtkMapper2D mapper  )  [protected, virtual]

Hide access methods that use superclass vtkMapper2D and not vtkImageMapper

Reimplemented from vtkActor2D.

virtual void vtkTextActor::ComputeRectangle ( vtkViewport viewport  )  [protected, virtual]

virtual void vtkTextActor::SetTexture ( vtkTexture  )  [protected, virtual]

virtual vtkTexture* vtkTextActor::GetTexture (  )  [protected, virtual]


Member Data Documentation

int vtkTextActor::MinimumSize[2] [protected]

Definition at line 233 of file vtkTextActor.h.

Definition at line 234 of file vtkTextActor.h.

double vtkTextActor::FontScaleExponent [protected]

Definition at line 235 of file vtkTextActor.h.

int vtkTextActor::TextScaleMode [protected]

Definition at line 236 of file vtkTextActor.h.

float vtkTextActor::Orientation [protected]

Definition at line 237 of file vtkTextActor.h.

Definition at line 238 of file vtkTextActor.h.

Definition at line 240 of file vtkTextActor.h.

Definition at line 241 of file vtkTextActor.h.

Definition at line 244 of file vtkTextActor.h.

Definition at line 245 of file vtkTextActor.h.

Definition at line 246 of file vtkTextActor.h.

Definition at line 247 of file vtkTextActor.h.

int vtkTextActor::LastSize[2] [protected]

Definition at line 248 of file vtkTextActor.h.

int vtkTextActor::LastOrigin[2] [protected]

Definition at line 249 of file vtkTextActor.h.

char* vtkTextActor::Input [protected]

Definition at line 250 of file vtkTextActor.h.

bool vtkTextActor::InputRendered [protected]

Definition at line 251 of file vtkTextActor.h.

double vtkTextActor::FormerOrientation [protected]

Definition at line 252 of file vtkTextActor.h.

Definition at line 254 of file vtkTextActor.h.

Definition at line 257 of file vtkTextActor.h.

Definition at line 258 of file vtkTextActor.h.

Definition at line 259 of file vtkTextActor.h.


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

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