Interface for generating images and path data from string data, using multiple backends. More...

#include <vtkTextRenderer.h>

Inheritance diagram for vtkTextRenderer:

Collaboration diagram for vtkTextRenderer:

Classes
struct	Metrics

Public Types
enum	Backend { Default = -1, Detect = 0, FreeType, MathText, UserBackend = 16 }
	Available backends. More...

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

vtkTextRenderer *	NewInstance () const

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

virtual bool	FreeTypeIsSupported ()
	Test for availability of various backends. More...

virtual bool	MathTextIsSupported ()


virtual void	SetDefaultBackend (int)
	The backend to use when none is specified. More...

virtual int	GetDefaultBackend ()
	The backend to use when none is specified. More...


virtual int	DetectBackend (const vtkStdString &str)
	Determine the appropriate back end needed to render the given string. More...

virtual int	DetectBackend (const vtkUnicodeString &str)
	Determine the appropriate back end needed to render the given string. More...

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	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 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 vtkTextRenderer *	SafeDownCast (vtkObjectBase *o)

static vtkTextRenderer *	New ()
	This is a singleton pattern New. More...

static vtkTextRenderer *	GetInstance ()
	Return the singleton instance with no reference counting. 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

	vtkTextRenderer ()

	~vtkTextRenderer () override


virtual void	CleanUpFreeTypeEscapes (vtkStdString &str)
	Replace all instances of "\$" with "$". More...

virtual void	CleanUpFreeTypeEscapes (vtkUnicodeString &str)
	Replace all instances of "\$" with "$". More...

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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	SetInstance (vtkTextRenderer *instance)
	Set the singleton instance. More...

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtksys::RegularExpression *	MathTextRegExp

vtksys::RegularExpression *	MathTextRegExp2

vtksys::RegularExpression *	MathTextRegExpColumn

int	DefaultBackend
	The backend to use when none is specified. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes

static vtkTextRenderer *	Instance
	The singleton instance and the singleton cleanup instance. More...

static vtkTextRendererCleanup	Cleanup
	The singleton instance and the singleton cleanup instance. More...

const vtkUnicodeString &	str
	Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels. More...

const vtkUnicodeString int	bbox [4]
	Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels. More...

const vtkUnicodeString int int	dpi
	Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels. More...

bool	GetBoundingBox (vtkTextProperty *tprop, const vtkStdString &str, int bbox[4], int dpi, int backend=Default)
	Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels. More...

	VTK_DEPRECATED_IN_9_1_0 ("Use bool GetBoundingBox(vtkTextProperty* tprop, const vtkStdString& " "str, int bbox[4], int dpi, int backend)") bool GetBoundingBox(vtkTextProperty *tprop
	Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels. More...

const vtkUnicodeString int int int	backend
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString Metrics &	metrics
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString Metrics int	dpi
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString Metrics int int	backend = 0
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkImageData *	data
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkImageData int	textDims [2]
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkImageData int int	dpi
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkImageData int int int	backend = 0
	Virtual methods for concrete implementations of the public methods. More...

vtkTextProperty *	tprop
	Virtual methods for concrete implementations of the public methods. More...

vtkTextProperty int	targetWidth
	Virtual methods for concrete implementations of the public methods. More...

vtkTextProperty int int	targetHeight
	Virtual methods for concrete implementations of the public methods. More...

vtkTextProperty int int int	dpi
	Virtual methods for concrete implementations of the public methods. More...

vtkTextProperty int int int int	backend = 0
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkPath *	path
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkPath int	dpi
	Virtual methods for concrete implementations of the public methods. More...

const vtkUnicodeString vtkPath int int	backend = 0
	Virtual methods for concrete implementations of the public methods. More...

virtual bool	GetBoundingBoxInternal (vtkTextProperty *tprop, const vtkStdString &str, int bbox[4], int dpi, int backend)=0
	Virtual methods for concrete implementations of the public methods. More...

	VTK_DEPRECATED_IN_9_1_0 ("Use bool GetBoundingBoxInternal(vtkTextProperty* tprop, const " "vtkStdString& str, int bbox[4], int dpi, int backend)") virtual bool GetBoundingBoxInternal(vtkTextProperty *tprop
	Virtual methods for concrete implementations of the public methods. More...

virtual bool	GetMetricsInternal (vtkTextProperty *tprop, const vtkStdString &str, Metrics &metrics, int dpi, int backend)=0
	Virtual methods for concrete implementations of the public methods. More...

	VTK_DEPRECATED_IN_9_1_0 ("Use bool GetMetricsInternal(vtkTextProperty* tprop, const vtkStdString& " "str, Metrics& metrics, int dpi, int backend)") virtual bool GetMetricsInternal(vtkTextProperty *tprop
	Virtual methods for concrete implementations of the public methods. More...

virtual bool	RenderStringInternal (vtkTextProperty tprop, const vtkStdString &str, vtkImageData data, int textDims[2], int dpi, int backend)=0
	Virtual methods for concrete implementations of the public methods. More...

	VTK_DEPRECATED_IN_9_1_0 ("Use bool RenderStringInternal(vtkTextProperty* tprop, const vtkStdString& str, vtkImageData* " "data, int textDims[2], int dpi, int backend)") virtual bool RenderStringInternal(vtkTextProperty *tprop
	Virtual methods for concrete implementations of the public methods. More...

virtual int	GetConstrainedFontSizeInternal (const vtkStdString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend)=0
	Virtual methods for concrete implementations of the public methods. More...

	VTK_DEPRECATED_IN_9_1_0 ("Use int GetConstrainedFontSizeInternal(const vtkStdString& str, vtkTextProperty* tprop, int " "targetWidth, int targetHeight, int dpi, int backend)") virtual int GetConstrainedFontSizeInternal(const vtkUnicodeString &str
	Virtual methods for concrete implementations of the public methods. More...

virtual bool	StringToPathInternal (vtkTextProperty tprop, const vtkStdString &str, vtkPath path, int dpi, int backend)=0
	Virtual methods for concrete implementations of the public methods. More...

	VTK_DEPRECATED_IN_9_1_0 ("Use bool StringToPathInternal(vtkTextProperty* tprop, const " "vtkStdString& str, vtkPath* path, int dpi, int backend)") virtual bool StringToPathInternal(vtkTextProperty *tprop
	Virtual methods for concrete implementations of the public methods. More...

virtual void	SetScaleToPowerOfTwoInternal (bool scale)=0
	Virtual methods for concrete implementations of the public methods. More...

Detailed Description

Interface for generating images and path data from string data, using multiple backends.

vtkTextRenderer produces images, bounding boxes, and vtkPath objects that represent text. The advantage of using this class is to easily integrate mathematical expressions into renderings by automatically switching between FreeType and MathText backends. If the input string contains at least two "$" symbols separated by text, the MathText backend will be used. If the string does not meet this criteria, or if no MathText implementation is available, the faster FreeType rendering facilities are used. Literal $ symbols can be used by escaping them with backslashes, "\$" (or "\\$" if the string is set programmatically).

For example, "Acceleration ($\\frac{m}{s^2}$)" will use MathText, but "\\$500, \\$100" will use FreeType.

By default, the backend is set to Detect, which determines the backend based on the contents of the string. This can be changed by setting the DefaultBackend ivar.

Note that this class is abstract – link to the vtkRenderingFreetype module to get the default implementation.

Definition at line 74 of file vtkTextRenderer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTextRenderer::Superclass

Definition at line 122 of file vtkTextRenderer.h.

Member Enumeration Documentation

◆ Backend

enum vtkTextRenderer::Backend

Available backends.

FreeType and MathText are provided in the default implementation of this interface. Enum values less than 16 are reserved. Custom overrides should define other backends starting at 16.

Enumerator
Default
Detect
FreeType
MathText
UserBackend

Definition at line 147 of file vtkTextRenderer.h.

Constructor & Destructor Documentation

◆ vtkTextRenderer()

vtkTextRenderer::vtkTextRenderer ( )

protected

◆ ~vtkTextRenderer()

vtkTextRenderer::~vtkTextRenderer ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkTextRenderer::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 vtkObjectBase.

Reimplemented in vtkMathTextFreeTypeTextRenderer.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTextRenderer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkMathTextFreeTypeTextRenderer.

◆ NewInstance()

vtkTextRenderer* vtkTextRenderer::NewInstance ( ) const

◆ PrintSelf()

void vtkTextRenderer::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 vtkObject.

Reimplemented in vtkMathTextFreeTypeTextRenderer.

◆ New()

static vtkTextRenderer* vtkTextRenderer::New ( )

static

This is a singleton pattern New.

There will be only ONE reference to a vtkTextRenderer subclass object per process. Clients that call this method must use Delete() on the object so that reference counting will work. The single instance will be unreferenced when the program exits. You should just use the static GetInstance() method anyway to get the singleton. This method may return NULL if the object factory cannot find an override.

◆ GetInstance()

static vtkTextRenderer* vtkTextRenderer::GetInstance ( )

static

Return the singleton instance with no reference counting.

May return NULL if the object factory cannot find an override.

◆ SetDefaultBackend()

virtual void vtkTextRenderer::SetDefaultBackend ( int )

virtual

The backend to use when none is specified.

Default: Detect

◆ GetDefaultBackend()

virtual int vtkTextRenderer::GetDefaultBackend ( )

virtual

The backend to use when none is specified.

Default: Detect

◆ DetectBackend() [1/2]

virtual int vtkTextRenderer::DetectBackend ( const vtkStdString & str )

virtual

Determine the appropriate back end needed to render the given string.

◆ DetectBackend() [2/2]

virtual int vtkTextRenderer::DetectBackend ( const vtkUnicodeString & str )

virtual

Determine the appropriate back end needed to render the given string.

◆ FreeTypeIsSupported()

virtual bool vtkTextRenderer::FreeTypeIsSupported ( )

inlinevirtual

Test for availability of various backends.

Reimplemented in vtkMathTextFreeTypeTextRenderer.

Definition at line 176 of file vtkTextRenderer.h.

◆ MathTextIsSupported()

virtual bool vtkTextRenderer::MathTextIsSupported ( )

inlinevirtual

Reimplemented in vtkMathTextFreeTypeTextRenderer.

Definition at line 177 of file vtkTextRenderer.h.

◆ GetBoundingBox()

bool vtkTextRenderer::GetBoundingBox	(	vtkTextProperty *	tprop,
		const vtkStdString &	str,
		int	bbox[4],
		int	dpi,
		int	backend = `Default`
	)

inline

Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels.

The origin of the bounding box is the anchor point described by the horizontal and vertical justification text property variables. Return true on success, false otherwise.

Definition at line 187 of file vtkTextRenderer.h.

◆ VTK_DEPRECATED_IN_9_1_0() [1/6]

vtkTextRenderer::VTK_DEPRECATED_IN_9_1_0 ( "Use bool GetBoundingBox(vtkTextProperty* tprop, const vtkStdString& " "str, int bbox[4], int dpi, int backend)" )

Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels.

The origin of the bounding box is the anchor point described by the horizontal and vertical justification text property variables. Return true on success, false otherwise.

◆ GetBoundingBoxInternal()

virtual bool vtkTextRenderer::GetBoundingBoxInternal	(	vtkTextProperty *	tprop,
		const vtkStdString &	str,
		int	bbox[4],
		int	dpi,
		int	backend
	)

protectedpure virtual

Virtual methods for concrete implementations of the public methods.

Implemented in vtkMathTextFreeTypeTextRenderer.

◆ VTK_DEPRECATED_IN_9_1_0() [2/6]

vtkTextRenderer::VTK_DEPRECATED_IN_9_1_0 ( "Use bool GetBoundingBoxInternal(vtkTextProperty* tprop, const " "vtkStdString& str, int bbox[4], int dpi, int backend)" )

protected

Virtual methods for concrete implementations of the public methods.

◆ GetMetricsInternal()

virtual bool vtkTextRenderer::GetMetricsInternal	(	vtkTextProperty *	tprop,
		const vtkStdString &	str,
		Metrics &	metrics,
		int	dpi,
		int	backend
	)

protectedpure virtual

Virtual methods for concrete implementations of the public methods.

Implemented in vtkMathTextFreeTypeTextRenderer.

◆ VTK_DEPRECATED_IN_9_1_0() [3/6]

vtkTextRenderer::VTK_DEPRECATED_IN_9_1_0 ( "Use bool GetMetricsInternal(vtkTextProperty* tprop, const vtkStdString& " "str, Metrics& metrics, int dpi, int backend)" )

protected

Virtual methods for concrete implementations of the public methods.

◆ RenderStringInternal()

virtual bool vtkTextRenderer::RenderStringInternal	(	vtkTextProperty *	tprop,
		const vtkStdString &	str,
		vtkImageData *	data,
		int	textDims[2],
		int	dpi,
		int	backend
	)

protectedpure virtual

Virtual methods for concrete implementations of the public methods.

Implemented in vtkMathTextFreeTypeTextRenderer.

◆ VTK_DEPRECATED_IN_9_1_0() [4/6]

vtkTextRenderer::VTK_DEPRECATED_IN_9_1_0 ( "Use bool RenderStringInternal(vtkTextProperty* tprop, const vtkStdString& str, vtkImageData* " "data, int textDims[2], int dpi, int backend)" )

protected

Virtual methods for concrete implementations of the public methods.

◆ GetConstrainedFontSizeInternal()

virtual int vtkTextRenderer::GetConstrainedFontSizeInternal	(	const vtkStdString &	str,
		vtkTextProperty *	tprop,
		int	targetWidth,
		int	targetHeight,
		int	dpi,
		int	backend
	)

protectedpure virtual

Virtual methods for concrete implementations of the public methods.

Implemented in vtkMathTextFreeTypeTextRenderer.

◆ VTK_DEPRECATED_IN_9_1_0() [5/6]

vtkTextRenderer::VTK_DEPRECATED_IN_9_1_0 ( "Use int GetConstrainedFontSizeInternal(const vtkStdString& str, vtkTextProperty* tprop, int " "targetWidth, int targetHeight, int dpi, int backend)" ) const &

protected

Virtual methods for concrete implementations of the public methods.

◆ StringToPathInternal()

virtual bool vtkTextRenderer::StringToPathInternal	(	vtkTextProperty *	tprop,
		const vtkStdString &	str,
		vtkPath *	path,
		int	dpi,
		int	backend
	)

protectedpure virtual

Virtual methods for concrete implementations of the public methods.

Implemented in vtkMathTextFreeTypeTextRenderer.

◆ VTK_DEPRECATED_IN_9_1_0() [6/6]

vtkTextRenderer::VTK_DEPRECATED_IN_9_1_0 ( "Use bool StringToPathInternal(vtkTextProperty* tprop, const " "vtkStdString& str, vtkPath* path, int dpi, int backend)" )

protected

Virtual methods for concrete implementations of the public methods.

◆ SetScaleToPowerOfTwoInternal()

virtual void vtkTextRenderer::SetScaleToPowerOfTwoInternal ( bool scale )

protectedpure virtual

Virtual methods for concrete implementations of the public methods.

Implemented in vtkMathTextFreeTypeTextRenderer.

◆ SetInstance()

static void vtkTextRenderer::SetInstance ( vtkTextRenderer * instance )

staticprotected

Set the singleton instance.

Call Delete() on the supplied instance after setting it to fix the reference count.

◆ CleanUpFreeTypeEscapes() [1/2]

virtual void vtkTextRenderer::CleanUpFreeTypeEscapes ( vtkStdString & str )

protectedvirtual

Replace all instances of "\$" with "$".

◆ CleanUpFreeTypeEscapes() [2/2]

virtual void vtkTextRenderer::CleanUpFreeTypeEscapes ( vtkUnicodeString & str )

protectedvirtual

Replace all instances of "\$" with "$".

Member Data Documentation

◆ str

const vtkUnicodeString & vtkTextRenderer::str

Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels.

The origin of the bounding box is the anchor point described by the horizontal and vertical justification text property variables. Return true on success, false otherwise.

Definition at line 194 of file vtkTextRenderer.h.

◆ bbox

const vtkUnicodeString int vtkTextRenderer::bbox

Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels.

The origin of the bounding box is the anchor point described by the horizontal and vertical justification text property variables. Return true on success, false otherwise.

Definition at line 194 of file vtkTextRenderer.h.

◆ dpi [1/5]

const vtkUnicodeString int int vtkTextRenderer::dpi

Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels.

The origin of the bounding box is the anchor point described by the horizontal and vertical justification text property variables. Return true on success, false otherwise.

Definition at line 194 of file vtkTextRenderer.h.

◆ backend [1/5]

const vtkUnicodeString int int int vtkTextRenderer::backend

Virtual methods for concrete implementations of the public methods.

Definition at line 195 of file vtkTextRenderer.h.

◆ metrics

const vtkUnicodeString Metrics& vtkTextRenderer::metrics

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 325 of file vtkTextRenderer.h.

◆ dpi [2/5]

const vtkUnicodeString Metrics int vtkTextRenderer::dpi

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 325 of file vtkTextRenderer.h.

◆ backend [2/5]

const vtkUnicodeString Metrics int int vtkTextRenderer::backend = 0

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 325 of file vtkTextRenderer.h.

◆ data

const vtkUnicodeString vtkImageData* vtkTextRenderer::data

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 332 of file vtkTextRenderer.h.

◆ textDims

const vtkUnicodeString vtkImageData int vtkTextRenderer::textDims[2]

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 332 of file vtkTextRenderer.h.

◆ dpi [3/5]

const vtkUnicodeString vtkImageData int int vtkTextRenderer::dpi

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 332 of file vtkTextRenderer.h.

◆ backend [3/5]

const vtkUnicodeString vtkImageData int int int vtkTextRenderer::backend = 0

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 332 of file vtkTextRenderer.h.

◆ tprop

vtkTextProperty* vtkTextRenderer::tprop

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 338 of file vtkTextRenderer.h.

◆ targetWidth

vtkTextProperty int vtkTextRenderer::targetWidth

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 339 of file vtkTextRenderer.h.

◆ targetHeight

vtkTextProperty int int vtkTextRenderer::targetHeight

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 339 of file vtkTextRenderer.h.

◆ dpi [4/5]

vtkTextProperty int int int vtkTextRenderer::dpi

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 339 of file vtkTextRenderer.h.

◆ backend [4/5]

vtkTextProperty int int int int vtkTextRenderer::backend = 0

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 339 of file vtkTextRenderer.h.

◆ path

const vtkUnicodeString vtkPath* vtkTextRenderer::path

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 345 of file vtkTextRenderer.h.

◆ dpi [5/5]

const vtkUnicodeString vtkPath int vtkTextRenderer::dpi

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 345 of file vtkTextRenderer.h.

◆ backend [5/5]

const vtkUnicodeString vtkPath int int vtkTextRenderer::backend = 0

protected

Virtual methods for concrete implementations of the public methods.

Definition at line 345 of file vtkTextRenderer.h.

◆ Instance

vtkTextRenderer* vtkTextRenderer::Instance

staticprotected

The singleton instance and the singleton cleanup instance.

Definition at line 359 of file vtkTextRenderer.h.

◆ Cleanup

vtkTextRendererCleanup vtkTextRenderer::Cleanup

staticprotected

The singleton instance and the singleton cleanup instance.

Definition at line 360 of file vtkTextRenderer.h.

◆ MathTextRegExp

vtksys::RegularExpression* vtkTextRenderer::MathTextRegExp

protected

Definition at line 363 of file vtkTextRenderer.h.

◆ MathTextRegExp2

vtksys::RegularExpression* vtkTextRenderer::MathTextRegExp2

protected

Definition at line 364 of file vtkTextRenderer.h.

◆ MathTextRegExpColumn

vtksys::RegularExpression* vtkTextRenderer::MathTextRegExpColumn

protected

Definition at line 365 of file vtkTextRenderer.h.

◆ DefaultBackend

int vtkTextRenderer::DefaultBackend

protected

The backend to use when none is specified.

Default: Detect

Definition at line 379 of file vtkTextRenderer.h.

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

Rendering/Core/vtkTextRenderer.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ Backend

Constructor & Destructor Documentation

◆ vtkTextRenderer()

◆ ~vtkTextRenderer()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetInstance()

◆ SetDefaultBackend()

◆ GetDefaultBackend()

◆ DetectBackend() [1/2]

◆ DetectBackend() [2/2]

◆ FreeTypeIsSupported()

◆ MathTextIsSupported()

◆ GetBoundingBox()

◆ VTK_DEPRECATED_IN_9_1_0() [1/6]

◆ GetBoundingBoxInternal()

◆ VTK_DEPRECATED_IN_9_1_0() [2/6]

◆ GetMetricsInternal()

◆ VTK_DEPRECATED_IN_9_1_0() [3/6]

◆ RenderStringInternal()

◆ VTK_DEPRECATED_IN_9_1_0() [4/6]

◆ GetConstrainedFontSizeInternal()

◆ VTK_DEPRECATED_IN_9_1_0() [5/6]

◆ StringToPathInternal()

◆ VTK_DEPRECATED_IN_9_1_0() [6/6]

◆ SetScaleToPowerOfTwoInternal()

◆ SetInstance()

◆ CleanUpFreeTypeEscapes() [1/2]

◆ CleanUpFreeTypeEscapes() [2/2]

Member Data Documentation

◆ str

◆ bbox

◆ dpi [1/5]

◆ backend [1/5]

◆ metrics

◆ dpi [2/5]

◆ backend [2/5]

◆ data

◆ textDims

◆ dpi [3/5]

◆ backend [3/5]

◆ tprop

◆ targetWidth

◆ targetHeight

◆ dpi [4/5]

◆ backend [4/5]

◆ path

◆ dpi [5/5]

◆ backend [5/5]

◆ Instance

◆ Cleanup

◆ MathTextRegExp

◆ MathTextRegExp2

◆ MathTextRegExpColumn

◆ DefaultBackend