Interface for generating images and path data from string data, using multiple backends.
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...
|
|
vtkTextRenderer * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
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) |
|
virtual bool | FreeTypeIsSupported () |
| Test for availability of various backends. More...
|
|
virtual bool | MathTextIsSupported () |
|
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...
|
|
| 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) |
|
vtkCommand * | GetCommand (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) |
|
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...
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkTextRenderer () |
|
| ~vtkTextRenderer () override |
|
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...
|
|
virtual bool | GetBoundingBoxInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, int bbox[4], int dpi, int backend)=0 |
|
virtual bool | GetMetricsInternal (vtkTextProperty *tprop, const vtkStdString &str, Metrics &metrics, int dpi, int backend)=0 |
|
virtual bool | GetMetricsInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, Metrics &metrics, int dpi, int backend)=0 |
|
virtual bool | RenderStringInternal (vtkTextProperty *tprop, const vtkStdString &str, vtkImageData *data, int textDims[2], int dpi, int backend)=0 |
|
virtual bool | RenderStringInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, vtkImageData *data, int textDims[2], int dpi, int backend)=0 |
|
virtual int | GetConstrainedFontSizeInternal (const vtkStdString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend)=0 |
|
virtual int | GetConstrainedFontSizeInternal (const vtkUnicodeString &str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi, int backend)=0 |
|
virtual bool | StringToPathInternal (vtkTextProperty *tprop, const vtkStdString &str, vtkPath *path, int dpi, int backend)=0 |
|
virtual bool | StringToPathInternal (vtkTextProperty *tprop, const vtkUnicodeString &str, vtkPath *path, int dpi, int backend)=0 |
|
virtual void | SetScaleToPowerOfTwoInternal (bool scale)=0 |
|
virtual void | CleanUpFreeTypeEscapes (vtkStdString &str) |
| Replace all instances of "\$" with "$". More...
|
|
virtual void | CleanUpFreeTypeEscapes (vtkUnicodeString &str) |
|
| 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 () |
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | CollectRevisions (ostream &) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
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.
- Tests:
- vtkTextRenderer (Tests)
Definition at line 75 of file vtkTextRenderer.h.