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.
|
| |
| vtkTextRenderer * | NewInstance () const |
| |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| virtual bool | FreeTypeIsSupported () |
| | Test for availability of various backends.
|
| |
| virtual bool | MathTextIsSupported () |
| |
| void | SetScaleToPowerOfTwo (bool scale) |
| | Set to true if the graphics implementation requires texture image dimensions to be a power of two.
|
| |
|
| virtual void | SetDefaultBackend (int) |
| | The backend to use when none is specified.
|
| |
| virtual int | GetDefaultBackend () |
| | The backend to use when none is specified.
|
| |
|
| virtual int | DetectBackend (const vtkStdString &str) |
| | Determine the appropriate back end needed to render the given string.
|
| |
|
| 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.
|
| |
|
| 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.
|
| |
|
| 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.
|
| |
|
| 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.
|
| |
|
| 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.
|
| |
| | vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
| |
| virtual void | DebugOn () |
| | Turn debugging output on.
|
| |
| virtual void | DebugOff () |
| | Turn debugging output off.
|
| |
| bool | GetDebug () |
| | Get the value of the debug flag.
|
| |
| void | SetDebug (bool debugFlag) |
| | Set the value of the debug flag.
|
| |
| virtual void | Modified () |
| | Update the modification time for this object.
|
| |
| virtual vtkMTimeType | GetMTime () |
| | Return this object's modified time.
|
| |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| 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) |
| |
| vtkTypeBool | InvokeEvent (unsigned long event) |
| |
| vtkTypeBool | InvokeEvent (const char *event) |
| |
| std::string | GetObjectDescription () const override |
| | The object description printed in messages and PrintSelf output.
|
| |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| vtkCommand * | GetCommand (unsigned long tag) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| void | RemoveObserver (vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| void | RemoveObservers (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| vtkTypeBool | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| virtual void | SetObjectName (const std::string &objectName) |
| | Set/get the name of this object for reporting purposes.
|
| |
| virtual std::string | GetObjectName () const |
| | Set/get the name of this object for reporting purposes.
|
| |
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| |
| virtual std::string | GetObjectDescription () const |
| | The object description printed in messages and PrintSelf output.
|
| |
| virtual vtkTypeBool | IsA (const char *name) |
| | Return 1 if this class is the same type of (or a subclass of) the named class.
|
| |
| 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).
|
| |
| virtual void | Delete () |
| | Delete a VTK object.
|
| |
| virtual void | FastDelete () |
| | Delete a reference to this object.
|
| |
| void | InitializeObjectBase () |
| |
| void | Print (ostream &os) |
| | Print an object to an ostream.
|
| |
| void | Register (vtkObjectBase *o) |
| | Increase the reference count (mark as used by another object).
|
| |
| virtual void | UnRegister (vtkObjectBase *o) |
| | Decrease the reference count (release by another object).
|
| |
| int | GetReferenceCount () |
| | Return the current reference count of this object.
|
| |
| void | SetReferenceCount (int) |
| | Sets the reference count.
|
| |
| bool | GetIsInMemkind () const |
| | A local state flag that remembers whether this object lives in the normal or extended memory space.
|
| |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| virtual bool | UsesGarbageCollector () const |
| | Indicate whether the class uses vtkGarbageCollector or not.
|
| |
|
| static vtkTypeBool | IsTypeOf (const char *type) |
| |
| static vtkTextRenderer * | SafeDownCast (vtkObjectBase *o) |
| |
| static vtkTextRenderer * | New () |
| | This is a singleton pattern New.
|
| |
| static vtkTextRenderer * | GetInstance () |
| | Return the singleton instance with no reference counting.
|
| |
| static vtkObject * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| |
| static void | BreakOnError () |
| | This method is called when vtkErrorMacro executes.
|
| |
| static void | SetGlobalWarningDisplay (vtkTypeBool val) |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static void | GlobalWarningDisplayOn () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static void | GlobalWarningDisplayOff () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static vtkTypeBool | GetGlobalWarningDisplay () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static vtkTypeBool | IsTypeOf (const char *name) |
| | Return 1 if this class type is the same type of (or a subclass of) the named class.
|
| |
| 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).
|
| |
| static vtkObjectBase * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| |
| static void | SetMemkindDirectory (const char *directoryname) |
| | The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
| |
| 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.
|
| |
|
| 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.
|
| |
| virtual bool | GetMetricsInternal (vtkTextProperty *tprop, const vtkStdString &str, Metrics &metrics, int dpi, int backend)=0 |
| | Virtual methods for concrete implementations of the public methods.
|
| |
| 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.
|
| |
| 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.
|
| |
| virtual bool | StringToPathInternal (vtkTextProperty *tprop, const vtkStdString &str, vtkPath *path, int dpi, int backend)=0 |
| | Virtual methods for concrete implementations of the public methods.
|
| |
| virtual void | SetScaleToPowerOfTwoInternal (bool scale)=0 |
| | Virtual methods for concrete implementations of the public methods.
|
| |
|
| virtual void | CleanUpFreeTypeEscapes (vtkStdString &str) |
| | Replace all instances of "\$" with "$".
|
| |
| | 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.
|
| |
| void | InternalReleaseFocus () |
| | These methods allow a command to exclusively grab all events.
|
| |
| | vtkObjectBase () |
| |
| virtual | ~vtkObjectBase () |
| |
| virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
| |
| virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
| |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| |
| virtual void | ObjectFinalize () |
| |
| | 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. Alternatively, the presence of unescaped "|" symbols defines multicolumn lines, which are processed with the MathText backend.
If the string does not meet these 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 70 of file vtkTextRenderer.h.
Public Member Functions inherited from vtkObject
1.9.7