An actor that displays text. 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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkTextActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this text actor. More...

virtual void	GetBoundingBox (vtkViewport *vport, double bbox[4])
	Return the bounding box coordinates of the text in pixels. More...

virtual void	GetSize (vtkViewport *vport, double size[2])
	Syntactic sugar to get the size of text instead of the entire bounding box. More...

virtual void	SetNonLinearFontScale (double exponent, int target)
	Enable non-linear scaling of font sizes. More...

void	SpecifiedToDisplay (double pos, vtkViewport vport, int specified)
	This is just a simple coordinate conversion method used in the render process. More...

void	DisplayToSpecified (double pos, vtkViewport vport, int specified)
	This is just a simple coordinate conversion method used in the render process. More...

virtual void	ComputeScaledFont (vtkViewport *viewport)
	Compute the scale the font should be given the viewport. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry? More...


void	SetInput (const char *inputString)
	Set the text string to be displayed. More...

char *	GetInput ()
	Set the text string to be displayed. More...


virtual void	SetMinimumSize (int, int)
	Set/Get the minimum size in pixels for this actor. More...

void	SetMinimumSize (int[2])
	Set/Get the minimum size in pixels for this actor. More...

virtual int *	GetMinimumSize ()
	Set/Get the minimum size in pixels for this actor. More...

virtual void	GetMinimumSize (int &, int &)
	Set/Get the minimum size in pixels for this actor. More...

virtual void	GetMinimumSize (int[2])
	Set/Get the minimum size in pixels for this actor. More...


virtual void	SetMaximumLineHeight (float)
	Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. More...

virtual float	GetMaximumLineHeight ()
	Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. More...


virtual void	SetTextScaleMode (int)
	Set how text should be scaled. More...

virtual int	GetTextScaleMode ()
	Set how text should be scaled. More...

void	SetTextScaleModeToNone ()
	Set how text should be scaled. More...

void	SetTextScaleModeToProp ()
	Set how text should be scaled. More...

void	SetTextScaleModeToViewport ()
	Set how text should be scaled. More...


virtual void	SetUseBorderAlign (vtkTypeBool)
	Turn on or off the UseBorderAlign option. More...

virtual vtkTypeBool	GetUseBorderAlign ()
	Turn on or off the UseBorderAlign option. More...

virtual void	UseBorderAlignOn ()
	Turn on or off the UseBorderAlign option. More...

virtual void	UseBorderAlignOff ()
	Turn on or off the UseBorderAlign option. More...


void	SetAlignmentPoint (int point)
	This method is being deprecated. More...

int	GetAlignmentPoint ()
	This method is being deprecated. More...


void	SetOrientation (float orientation)
	Counterclockwise rotation around the Alignment point. More...

virtual float	GetOrientation ()
	Counterclockwise rotation around the Alignment point. More...


virtual void	SetTextProperty (vtkTextProperty *p)
	Set/Get the text property. More...

virtual vtkTextProperty *	GetTextProperty ()
	Set/Get the text property. More...


virtual vtkTextProperty *	GetScaledTextProperty ()
	Get the scaled font. More...


int	RenderOpaqueGeometry (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

int	RenderOverlay (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

Public Member Functions inherited from vtkTexturedActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkTexturedActor2D *	NewInstance () const

void	ReleaseGraphicsResources (vtkWindow *win) override
	Release any graphics resources that are being consumed by this actor. More...

vtkMTimeType	GetMTime () override
	Return this object's modified time. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkTexturedActor2D. More...

virtual void	SetTexture (vtkTexture *texture)
	Set/Get the texture object to control rendering texture maps. More...

virtual vtkTexture *	GetTexture ()
	Set/Get the texture object to control rendering texture maps. More...

int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods. More...

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods. More...

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkActor2D *	NewInstance () const

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry? More...

vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D. More...

virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D. More...

void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates. More...

vtkMTimeType	GetMTime () override
	Return this objects MTime. More...

void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor. More...

virtual vtkCoordinate *	GetActualPositionCoordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...

virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn. More...

virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn. More...

virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render. More...

virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render. More...

virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable. More...

virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable. More...

virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable. More...

virtual float *	GetPosition2 ()
	Access the Position2 instance variable. More...

void	SetWidth (double w)
	Set/Get the height and width of the Actor2D. More...

double	GetWidth ()
	Set/Get the height and width of the Actor2D. More...

void	SetHeight (double h)
	Set/Get the height and width of the Actor2D. More...

double	GetHeight ()
	Set/Get the height and width of the Actor2D. More...

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp. More...

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers More...

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp. More...

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp. More...

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable. More...

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOn ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOff ()
	Set/Get the pickable instance variable. More...

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable. More...

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,. More...

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property. More...

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property. More...

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkTextActor *	SafeDownCast (vtkObjectBase *o)

static vtkTextActor *	New ()
	Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95). More...

static int	SetMultipleConstrainedFontSize (vtkViewport , int targetWidth, int targetHeight, vtkTextActor actors, int nbOfActors, int maxResultingSize)
	Set and return the font size required to make each element of an array of mappers fit in a given rectangle (width x height, in pixels). More...

static float	GetFontScale (vtkViewport *viewport)
	Provide a font scaling based on a viewport. More...

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTexturedActor2D *	SafeDownCast (vtkObjectBase *o)

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

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. More...

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

virtual bool	RenderImage (vtkTextProperty tprop, vtkViewport viewport)
	Render Input to Image using the supplied font property. More...

virtual bool	GetImageBoundingBox (vtkTextProperty tprop, vtkViewport viewport, int bbox[4])
	Get the bounding box for Input using the supplied font property. More...

	vtkTextActor ()

	~vtkTextActor () override

virtual void	ComputeRectangle (vtkViewport *viewport)

virtual int	UpdateRectangle (vtkViewport *viewport)
	Ensure that Rectangle and RectanglePoints are valid and up-to-date. More...

Protected Member Functions inherited from vtkTexturedActor2D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTexturedActor2D ()

	~vtkTexturedActor2D () override

Protected Member Functions inherited from vtkActor2D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkActor2D ()

	~vtkActor2D () override

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	MinimumSize [2]

float	MaximumLineHeight

double	FontScaleExponent

int	TextScaleMode

float	Orientation

vtkTypeBool	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
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

static int	SetConstrainedFontSize (vtkTextActor , vtkViewport , int targetWidth, int targetHeight)
	Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels). More...

virtual int	SetConstrainedFontSize (vtkViewport *, int targetWidth, int targetHeight)
	Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels). More...

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Online Examples:

Definition at line 159 of file vtkTextActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkTexturedActor2D vtkTextActor::Superclass

Definition at line 162 of file vtkTextActor.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
TEXT_SCALE_MODE_NONE
TEXT_SCALE_MODE_PROP
TEXT_SCALE_MODE_VIEWPORT

Definition at line 226 of file vtkTextActor.h.

Constructor & Destructor Documentation

◆ vtkTextActor()

vtkTextActor::vtkTextActor ( )

protected

◆ ~vtkTextActor()

vtkTextActor::~vtkTextActor ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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, and vtkOpenGLTextActor.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTextActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTexturedActor2D.

Reimplemented in vtkScaledTextActor, and vtkOpenGLTextActor.

◆ NewInstance()

vtkTextActor * vtkTextActor::NewInstance ( ) const

◆ PrintSelf()

void vtkTextActor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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, and vtkOpenGLTextActor.

◆ New()

static vtkTextActor * vtkTextActor::New ( )

static

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

◆ ShallowCopy()

void vtkTextActor::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy of this text actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkActor2D.

◆ SetInput()

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

◆ GetInput()

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