VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMathTextFreeTypeTextRenderer Class Reference

Default implementation of vtkTextRenderer. More...

#include <vtkMathTextFreeTypeTextRenderer.h>

Inheritance diagram for vtkMathTextFreeTypeTextRenderer:
[legend]
Collaboration diagram for vtkMathTextFreeTypeTextRenderer:
[legend]

Public Types

typedef vtkTextRenderer Superclass
 
- Public Types inherited from vtkTextRenderer
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...
 
vtkMathTextFreeTypeTextRendererNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool FreeTypeIsSupported () override
 Test for availability of various backends. More...
 
bool MathTextIsSupported () override
 
- Public Member Functions inherited from vtkTextRenderer
vtkTextRendererNewInstance () const
 
virtual void SetDefaultBackend (int)
 The backend to use when none is specified. More...
 
virtual int GetDefaultBackend ()
 
virtual int DetectBackend (const vtkStdString &str)
 Determine the appropriate back end needed to render the given string. More...
 
virtual int DetectBackend (const vtkUnicodeString &str)
 
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...
 
bool GetBoundingBox (vtkTextProperty *tprop, const vtkUnicodeString &str, int bbox[4], int dpi, int backend=Default)
 
bool GetMetrics (vtkTextProperty *tprop, const vtkStdString &str, Metrics &metrics, int dpi, int backend=Default)
 Given a text property and a string, get some metrics for the rendered string. More...
 
bool GetMetrics (vtkTextProperty *tprop, const vtkUnicodeString &str, Metrics &metrics, int dpi, int backend=Default)
 
bool RenderString (vtkTextProperty *tprop, const vtkStdString &str, vtkImageData *data, int textDims[2], int dpi, int backend=Default)
 Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. More...
 
bool RenderString (vtkTextProperty *tprop, const vtkUnicodeString &str, vtkImageData *data, int textDims[2], int dpi, int backend=Default)
 
int GetConstrainedFontSize (const vtkStdString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend=Default)
 This function returns the font size (in points) and sets the size in tprop that is required to fit the string in the target rectangle. More...
 
int GetConstrainedFontSize (const vtkUnicodeString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend=Default)
 
bool StringToPath (vtkTextProperty *tprop, const vtkStdString &str, vtkPath *path, int dpi, int backend=Default)
 Given a text property and a string, this function populates the vtkPath path with the outline of the rendered string. More...
 
bool StringToPath (vtkTextProperty *tprop, const vtkUnicodeString &str, vtkPath *path, int dpi, int backend=Default)
 
void SetScaleToPowerOfTwo (bool scale)
 Set to true if the graphics implementation requires texture image dimensions to be a power of two. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMathTextFreeTypeTextRendererSafeDownCast (vtkObjectBase *o)
 
static vtkMathTextFreeTypeTextRendererNew ()
 
- Static Public Member Functions inherited from vtkTextRenderer
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTextRendererSafeDownCast (vtkObjectBase *o)
 
static vtkTextRendererNew ()
 This is a singleton pattern New. More...
 
static vtkTextRendererGetInstance ()
 Return the singleton instance with no reference counting. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMathTextFreeTypeTextRenderer ()
 
 ~vtkMathTextFreeTypeTextRenderer () override
 
bool GetBoundingBoxInternal (vtkTextProperty *tprop, const vtkStdString &str, int bbox[4], int dpi, int backend) override
 Reimplemented from vtkTextRenderer. More...
 
bool GetBoundingBoxInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, int bbox[4], int dpi, int backend) override
 
bool GetMetricsInternal (vtkTextProperty *tprop, const vtkStdString &str, Metrics &metrics, int dpi, int backend) override
 
bool GetMetricsInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, Metrics &metrics, int dpi, int backend) override
 
bool RenderStringInternal (vtkTextProperty *tprop, const vtkStdString &str, vtkImageData *data, int textDims[2], int dpi, int backend) override
 
bool RenderStringInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, vtkImageData *data, int textDims[2], int dpi, int backend) override
 
int GetConstrainedFontSizeInternal (const vtkStdString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend) override
 
int GetConstrainedFontSizeInternal (const vtkUnicodeString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend) override
 
bool StringToPathInternal (vtkTextProperty *tprop, const vtkStdString &str, vtkPath *path, int dpi, int backend) override
 
bool StringToPathInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, vtkPath *path, int dpi, int backend) override
 
void SetScaleToPowerOfTwoInternal (bool scale) override
 
- Protected Member Functions inherited from vtkTextRenderer
 vtkTextRenderer ()
 
 ~vtkTextRenderer () override
 
virtual void CleanUpFreeTypeEscapes (vtkStdString &str)
 Replace all instances of "\$" with "$". More...
 
virtual void CleanUpFreeTypeEscapes (vtkUnicodeString &str)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkTextRenderer
static void SetInstance (vtkTextRenderer *instance)
 Set the singleton instance. More...
 
- Protected Attributes inherited from vtkTextRenderer
vtksys::RegularExpression * MathTextRegExp
 
vtksys::RegularExpression * MathTextRegExp2
 
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 inherited from vtkTextRenderer
static vtkTextRendererInstance
 The singleton instance and the singleton cleanup instance. More...
 
static vtkTextRendererCleanup Cleanup
 

Detailed Description

Default implementation of vtkTextRenderer.

Default implementation of vtkTextRenderer using vtkFreeTypeTools and vtkMathTextUtilities.

Warning
The MathText backend does not currently support UTF16 strings, thus UTF16 strings passed to the MathText renderer will be converted to UTF8.

Definition at line 40 of file vtkMathTextFreeTypeTextRenderer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkMathTextFreeTypeTextRenderer.h.

Constructor & Destructor Documentation

◆ vtkMathTextFreeTypeTextRenderer()

vtkMathTextFreeTypeTextRenderer::vtkMathTextFreeTypeTextRenderer ( )
protected

◆ ~vtkMathTextFreeTypeTextRenderer()

vtkMathTextFreeTypeTextRenderer::~vtkMathTextFreeTypeTextRenderer ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMathTextFreeTypeTextRenderer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTextRenderer.

◆ NewInstance()

vtkMathTextFreeTypeTextRenderer* vtkMathTextFreeTypeTextRenderer::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkMathTextFreeTypeTextRenderer* vtkMathTextFreeTypeTextRenderer::New ( )
static

◆ FreeTypeIsSupported()

bool vtkMathTextFreeTypeTextRenderer::FreeTypeIsSupported ( )
overridevirtual

Test for availability of various backends.

Reimplemented from vtkTextRenderer.

◆ MathTextIsSupported()

bool vtkMathTextFreeTypeTextRenderer::MathTextIsSupported ( )
overridevirtual

Reimplemented from vtkTextRenderer.

◆ GetBoundingBoxInternal() [1/2]

bool vtkMathTextFreeTypeTextRenderer::GetBoundingBoxInternal ( vtkTextProperty tprop,
const vtkStdString str,
int  bbox[4],
int  dpi,
int  backend 
)
overrideprotectedvirtual

Reimplemented from vtkTextRenderer.

Implements vtkTextRenderer.

◆ GetBoundingBoxInternal() [2/2]

bool vtkMathTextFreeTypeTextRenderer::GetBoundingBoxInternal ( vtkTextProperty tprop,
const vtkUnicodeString str,
int  bbox[4],
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ GetMetricsInternal() [1/2]

bool vtkMathTextFreeTypeTextRenderer::GetMetricsInternal ( vtkTextProperty tprop,
const vtkStdString str,
Metrics metrics,
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ GetMetricsInternal() [2/2]

bool vtkMathTextFreeTypeTextRenderer::GetMetricsInternal ( vtkTextProperty tprop,
const vtkUnicodeString str,
Metrics metrics,
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ RenderStringInternal() [1/2]

bool vtkMathTextFreeTypeTextRenderer::RenderStringInternal ( vtkTextProperty tprop,
const vtkStdString str,
vtkImageData data,
int  textDims[2],
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ RenderStringInternal() [2/2]

bool vtkMathTextFreeTypeTextRenderer::RenderStringInternal ( vtkTextProperty tprop,
const vtkUnicodeString str,
vtkImageData data,
int  textDims[2],
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ GetConstrainedFontSizeInternal() [1/2]

int vtkMathTextFreeTypeTextRenderer::GetConstrainedFontSizeInternal ( const vtkStdString str,
vtkTextProperty tprop,
int  targetWidth,
int  targetHeight,
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ GetConstrainedFontSizeInternal() [2/2]

int vtkMathTextFreeTypeTextRenderer::GetConstrainedFontSizeInternal ( const vtkUnicodeString str,
vtkTextProperty tprop,
int  targetWidth,
int  targetHeight,
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ StringToPathInternal() [1/2]

bool vtkMathTextFreeTypeTextRenderer::StringToPathInternal ( vtkTextProperty tprop,
const vtkStdString str,
vtkPath path,
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ StringToPathInternal() [2/2]

bool vtkMathTextFreeTypeTextRenderer::StringToPathInternal ( vtkTextProperty tprop,
const vtkUnicodeString str,
vtkPath path,
int  dpi,
int  backend 
)
overrideprotectedvirtual

Implements vtkTextRenderer.

◆ SetScaleToPowerOfTwoInternal()

void vtkMathTextFreeTypeTextRenderer::SetScaleToPowerOfTwoInternal ( bool  scale)
overrideprotectedvirtual

Implements vtkTextRenderer.


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