Abstract interface to equation rendering. More...
#include <vtkMathTextUtilities.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkMathTextUtilities * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual bool | GetBoundingBox (vtkTextProperty *tprop, const char *str, unsigned int dpi, int bbox[4])=0 |
| virtual bool | RenderString (const char *str, vtkImageData *data, vtkTextProperty *tprop, unsigned int dpi, int textDims[2]=NULL)=0 |
| virtual bool | StringToPath (const char *str, vtkPath *path, vtkTextProperty *tprop)=0 |
| virtual int | GetConstrainedFontSize (const char *str, vtkTextProperty *tprop, int targetWidth, int targetHeight, unsigned int dpi) |
| virtual bool | GetScaleToPowerOfTwo ()=0 |
| virtual void | SetScaleToPowerOfTwo (bool scale)=0 |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkMathTextUtilities * | SafeDownCast (vtkObjectBase *o) |
| static vtkMathTextUtilities * | New () |
| static vtkMathTextUtilities * | GetInstance () |
| static void | SetInstance (vtkMathTextUtilities *instance) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkMathTextUtilities () | |
| virtual | ~vtkMathTextUtilities () |
Detailed Description
Abstract interface to equation rendering.
vtkMathTextUtilities defines an interface for equation rendering. Intended for use with the python matplotlib.mathtext module (implemented in the vtkMatplotlib module).
Definition at line 52 of file vtkMathTextUtilities.h.
Member Typedef Documentation
Reimplemented from vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
Definition at line 55 of file vtkMathTextUtilities.h.
Constructor & Destructor Documentation
| vtkMathTextUtilities::vtkMathTextUtilities | ( | ) | [protected] |
| virtual vtkMathTextUtilities::~vtkMathTextUtilities | ( | ) | [protected, virtual] |
Member Function Documentation
| static int vtkMathTextUtilities::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
| virtual int vtkMathTextUtilities::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 vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
| static vtkMathTextUtilities* vtkMathTextUtilities::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
| virtual vtkObjectBase* vtkMathTextUtilities::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
Reimplemented from vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
| void vtkMathTextUtilities::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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 vtkMatplotlibMathTextUtilities.
| static vtkMathTextUtilities* vtkMathTextUtilities::New | ( | ) | [static] |
This is a singleton pattern New. There will be only ONE reference to a vtkMathTextUtilities 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.
Reimplemented from vtkObject.
Reimplemented in vtkMatplotlibMathTextUtilities.
| static vtkMathTextUtilities* vtkMathTextUtilities::GetInstance | ( | ) | [static] |
Return the singleton instance with no reference counting.
| static void vtkMathTextUtilities::SetInstance | ( | vtkMathTextUtilities * | instance | ) | [static] |
Supply a user defined instance. Call Delete() on the supplied instance after setting it to fix the reference count.
| virtual bool vtkMathTextUtilities::GetBoundingBox | ( | vtkTextProperty * | tprop, |
| const char * | str, | ||
| unsigned int | dpi, | ||
| int | bbox[4] | ||
| ) | [pure virtual] |
Determine the dimensions of the image that RenderString will produce for a given str, tprop, and dpi
Implemented in vtkMatplotlibMathTextUtilities.
| virtual bool vtkMathTextUtilities::RenderString | ( | const char * | str, |
| vtkImageData * | data, | ||
| vtkTextProperty * | tprop, | ||
| unsigned int | dpi, | ||
| int | textDims[2] = NULL |
||
| ) | [pure virtual] |
Render the given string str into the vtkImageData data with a resolution of dpi. textDims, will be overwritten by the pixel width and height of the rendered string. This is useful when ScaleToPowerOfTwo is set to true, and the image dimensions may not match the dimensions of the rendered text.
Implemented in vtkMatplotlibMathTextUtilities.
| virtual bool vtkMathTextUtilities::StringToPath | ( | const char * | str, |
| vtkPath * | path, | ||
| vtkTextProperty * | tprop | ||
| ) | [pure virtual] |
Parse the MathText expression in str and fill path with a contour of the glyphs.
Implemented in vtkMatplotlibMathTextUtilities.
| virtual int vtkMathTextUtilities::GetConstrainedFontSize | ( | const char * | str, |
| vtkTextProperty * | tprop, | ||
| int | targetWidth, | ||
| int | targetHeight, | ||
| unsigned int | dpi | ||
| ) | [virtual] |
This function returns the font size (in points) required to fit the string in the target rectangle. The font size of tprop is updated to the computed value as well. If an error occurs (e.g. an improperly formatted MathText string), -1 is returned.
| virtual bool vtkMathTextUtilities::GetScaleToPowerOfTwo | ( | ) | [pure virtual] |
Set to true if the graphics implmentation requires texture image dimensions to be a power of two. Default is true, but this member will be set appropriately when GL is inited.
Implemented in vtkMatplotlibMathTextUtilities.
| virtual void vtkMathTextUtilities::SetScaleToPowerOfTwo | ( | bool | scale | ) | [pure virtual] |
Set to true if the graphics implmentation requires texture image dimensions to be a power of two. Default is true, but this member will be set appropriately when GL is inited.
Implemented in vtkMatplotlibMathTextUtilities.
The documentation for this class was generated from the following file:
- dox/Rendering/FreeType/vtkMathTextUtilities.h
