VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMathTextUtilities Class Referenceabstract

Abstract interface to equation rendering. More...

#include <vtkMathTextUtilities.h>

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

Public Types

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...
 
vtkMathTextUtilitiesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool IsAvailable ()
 Returns true if mathtext rendering is available. More...
 
virtual bool GetBoundingBox (vtkTextProperty *tprop, const char *str, int dpi, int bbox[4])=0
 Determine the dimensions of the image that RenderString will produce for a given str, tprop, and dpi. More...
 
virtual bool GetMetrics (vtkTextProperty *tprop, const char *str, int dpi, vtkTextRenderer::Metrics &metrics)=0
 Return the metrics for the rendered str, tprop, and dpi. More...
 
virtual bool RenderString (const char *str, vtkImageData *data, vtkTextProperty *tprop, int dpi, int textDims[2]=nullptr)=0
 Render the given string str into the vtkImageData data with a resolution of dpi. More...
 
virtual bool StringToPath (const char *str, vtkPath *path, vtkTextProperty *tprop, int dpi)=0
 Parse the MathText expression in str and fill path with a contour of the glyphs. More...
 
virtual int GetConstrainedFontSize (const char *str, vtkTextProperty *tprop, int targetWidth, int targetHeight, int dpi)
 This function returns the font size (in points) required to fit the string in the target rectangle. More...
 
virtual bool GetScaleToPowerOfTwo ()=0
 Set to true if the graphics implementation requires texture image dimensions to be a power of two. More...
 
virtual void SetScaleToPowerOfTwo (bool scale)=0
 
- 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 vtkMathTextUtilitiesSafeDownCast (vtkObjectBase *o)
 
static vtkMathTextUtilitiesNew ()
 This is a singleton pattern New. More...
 
static vtkMathTextUtilitiesGetInstance ()
 Return the singleton instance with no reference counting. More...
 
static void SetInstance (vtkMathTextUtilities *instance)
 Supply a user defined instance. 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
 
 vtkMathTextUtilities ()
 
 ~vtkMathTextUtilities () override
 
- 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

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 51 of file vtkMathTextUtilities.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkMathTextUtilities.h.

Constructor & Destructor Documentation

◆ vtkMathTextUtilities()

vtkMathTextUtilities::vtkMathTextUtilities ( )
protected

◆ ~vtkMathTextUtilities()

vtkMathTextUtilities::~vtkMathTextUtilities ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkMatplotlibMathTextUtilities.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMathTextUtilities::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkMatplotlibMathTextUtilities.

◆ NewInstance()

vtkMathTextUtilities* vtkMathTextUtilities::NewInstance ( ) const

◆ PrintSelf()

void vtkMathTextUtilities::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 vtkMatplotlibMathTextUtilities.

◆ IsAvailable()

virtual bool vtkMathTextUtilities::IsAvailable ( )
inlinevirtual

Returns true if mathtext rendering is available.

Reimplemented in vtkMatplotlibMathTextUtilities.

Definition at line 60 of file vtkMathTextUtilities.h.

◆ New()

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.

◆ GetInstance()

static vtkMathTextUtilities* vtkMathTextUtilities::GetInstance ( )
static

Return the singleton instance with no reference counting.

◆ SetInstance()

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.

◆ GetBoundingBox()

virtual bool vtkMathTextUtilities::GetBoundingBox ( vtkTextProperty tprop,
const char *  str,
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.

◆ GetMetrics()

virtual bool vtkMathTextUtilities::GetMetrics ( vtkTextProperty tprop,
const char *  str,
int  dpi,
vtkTextRenderer::Metrics metrics 
)
pure virtual

Return the metrics for the rendered str, tprop, and dpi.

Implemented in vtkMatplotlibMathTextUtilities.

◆ RenderString()

virtual bool vtkMathTextUtilities::RenderString ( const char *  str,
vtkImageData data,
vtkTextProperty tprop,
int  dpi,
int  textDims[2] = nullptr 
)
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.

◆ StringToPath()

virtual bool vtkMathTextUtilities::StringToPath ( const char *  str,
vtkPath path,
vtkTextProperty tprop,
int  dpi 
)
pure virtual

Parse the MathText expression in str and fill path with a contour of the glyphs.

Implemented in vtkMatplotlibMathTextUtilities.

◆ GetConstrainedFontSize()

virtual int vtkMathTextUtilities::GetConstrainedFontSize ( const char *  str,
vtkTextProperty tprop,
int  targetWidth,
int  targetHeight,
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.

◆ GetScaleToPowerOfTwo()

virtual bool vtkMathTextUtilities::GetScaleToPowerOfTwo ( )
pure virtual

Set to true if the graphics implementation 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.

◆ SetScaleToPowerOfTwo()

virtual void vtkMathTextUtilities::SetScaleToPowerOfTwo ( bool  scale)
pure virtual

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