An actor that displays text. Scaled or unscaled. More...

#include <vtkTextActor.h>

Inheritance diagram for vtkTextActor:

Collaboration diagram for vtkTextActor:

Public Types
enum	{ TEXT_SCALE_MODE_NONE = 0, TEXT_SCALE_MODE_PROP, TEXT_SCALE_MODE_VIEWPORT }

typedef vtkTexturedActor2D	Superclass

Public Types inherited from vtkTexturedActor2D
typedef vtkActor2D	Superclass

Public Types inherited from vtkActor2D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkTextActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	ShallowCopy (vtkProp *prop)

virtual void	GetBoundingBox (vtkViewport *vport, double bbox[4])

virtual void	GetSize (vtkViewport *vport, double size[2])

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 ()


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 ()

Public Member Functions inherited from vtkTexturedActor2D
void	PrintSelf (ostream &os, vtkIndent indent)

vtkTexturedActor2D *	NewInstance () const

virtual unsigned long int	GetMTime ()

virtual void	SetTexture (vtkTexture *texture)

virtual vtkTexture *	GetTexture ()

Public Member Functions inherited from vtkActor2D
vtkActor2D *	NewInstance () const

vtkProperty2D *	GetProperty ()

virtual void	SetProperty (vtkProperty2D *)

void	SetDisplayPosition (int, int)

virtual void	GetActors2D (vtkPropCollection *pc)

virtual void	SetMapper (vtkMapper2D *mapper)

virtual vtkMapper2D *	GetMapper ()

virtual void	SetLayerNumber (int)

virtual int	GetLayerNumber ()

virtual vtkCoordinate *	GetPositionCoordinate ()

virtual void	SetPosition (float x[2])

virtual void	SetPosition (float x, float y)

virtual float *	GetPosition ()

virtual vtkCoordinate *	GetPosition2Coordinate ()

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 vtkCoordinate *	GetActualPositionCoordinate (void)

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkTextActor *	SafeDownCast (vtkObjectBase *o)

static vtkTextActor *	New ()

static float	GetFontScale (vtkViewport *viewport)


static int	SetMultipleConstrainedFontSize (vtkViewport , int targetWidth, int targetHeight, vtkTextActor actors, int nbOfActors, int maxResultingSize)

Static Public Member Functions inherited from vtkTexturedActor2D
static vtkTexturedActor2D *	New ()

static int	IsTypeOf (const char *type)

static vtkTexturedActor2D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkActor2D
static int	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

virtual bool	RenderImage (vtkTextProperty tprop, vtkViewport viewport)

	vtkTextActor ()

	~vtkTextActor ()

virtual void	ComputeRectangle (vtkViewport *viewport)

virtual int	UpdateRectangle (vtkViewport *viewport)


virtual bool	GetImageBoundingBox (vtkTextProperty tprop, vtkViewport viewport, int bbox[4])

Protected Member Functions inherited from vtkTexturedActor2D
	vtkTexturedActor2D ()

	~vtkTexturedActor2D ()

Protected Member Functions inherited from vtkActor2D
	vtkActor2D ()

	~vtkActor2D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	MinimumSize [2]

float	MaximumLineHeight

double	FontScaleExponent

int	TextScaleMode

float	Orientation

int	UseBorderAlign

vtkTextProperty *	TextProperty

vtkImageData *	ImageData

vtkTextRenderer *	TextRenderer

vtkTimeStamp	BuildTime

vtkTransform *	Transform

int	LastSize [2]

int	LastOrigin [2]

char *	Input

bool	InputRendered

double	FormerOrientation

int	RenderedDPI

vtkTextProperty *	ScaledTextProperty

vtkPolyData *	Rectangle

vtkPoints *	RectanglePoints

Protected Attributes inherited from vtkTexturedActor2D
vtkTexture *	Texture

Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

static int	SetConstrainedFontSize (vtkTextActor , vtkViewport , int targetWidth, int targetHeight)

virtual int	SetConstrainedFontSize (vtkViewport *, int targetWidth, int targetHeight)

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 vtkTextRenderer

Examples:: vtkTextActor (Examples)

Tests:: vtkTextActor (Tests)

Definition at line 54 of file vtkTextActor.h.

Member Typedef Documentation

typedef vtkTexturedActor2D vtkTextActor::Superclass

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 111 of file vtkTextActor.h.

Constructor & Destructor Documentation

vtkTextActor::vtkTextActor ( )

protected

vtkTextActor::~vtkTextActor ( )

protected

Member Function Documentation

static int vtkTextActor::IsTypeOf ( const char * type )

static

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

Reimplemented in vtkScaledTextActor.

static vtkTextActor* vtkTextActor::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkTextActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTexturedActor2D.

Reimplemented in vtkScaledTextActor.

vtkTextActor* vtkTextActor::NewInstance ( ) const

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

void vtkTextActor::ShallowCopy ( vtkProp * prop )

virtual

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

Reimplemented from vtkTexturedActor2D.

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 UTF-8 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 UTF-8 encoding. Convenience method to the underlying mapper

virtual void vtkTextActor::SetMinimumSize	(	int	,
		int
	)

virtual