Access to MatPlotLib MathText rendering. More...

#include <vtkMatplotlibMathTextUtilities.h>

Inheritance diagram for vtkMatplotlibMathTextUtilities:

Collaboration diagram for vtkMatplotlibMathTextUtilities:

Public Types
typedef vtkMathTextUtilities	Superclass

Public Types inherited from vtkMathTextUtilities
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...

vtkMatplotlibMathTextUtilities *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

bool	IsAvailable () override
	Returns true if mathtext rendering is available. More...

bool	GetBoundingBox (vtkTextProperty tprop, const char str, int dpi, int bbox[4]) override
	Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels. More...

bool	GetMetrics (vtkTextProperty tprop, const char str, int dpi, vtkTextRenderer::Metrics &metrics) override
	Return the metrics for the rendered str, tprop, and dpi. More...

bool	RenderString (const char str, vtkImageData image, vtkTextProperty *tprop, int dpi, int textDims[2]=nullptr) override
	Render the given string str into the vtkImageData image with a resolution of dpi. More...

bool	StringToPath (const char str, vtkPath path, vtkTextProperty *tprop, int dpi) override
	Parse the MathText expression in str and fill path with a contour of the glyphs. More...


void	SetScaleToPowerOfTwo (bool val) override
	Set to true if the graphics implementation requires texture image dimensions to be a power of two. More...

bool	GetScaleToPowerOfTwo () override
	Set to true if the graphics implementation requires texture image dimensions to be a power of two. More...

Public Member Functions inherited from vtkMathTextUtilities
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkMathTextUtilities *	NewInstance () 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...

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...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). 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	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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkMatplotlibMathTextUtilities *	SafeDownCast (vtkObjectBase *o)

static vtkMatplotlibMathTextUtilities *	New ()

Static Public Member Functions inherited from vtkMathTextUtilities
static vtkTypeBool	IsTypeOf (const char *type)

static vtkMathTextUtilities *	SafeDownCast (vtkObjectBase *o)

static vtkMathTextUtilities *	New ()
	This is a singleton pattern New. More...

static vtkMathTextUtilities *	GetInstance ()
	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 vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMatplotlibMathTextUtilities ()

	~vtkMatplotlibMathTextUtilities () override

bool	InitializeMaskParser ()

bool	InitializePathParser ()

bool	InitializeFontPropertiesClass ()

bool	CheckForError ()

bool	CheckForError (PyObject *object)

void	FindAndReplaceInString (std::string &str, const std::string &strToFind, const std::string &replacementStr)
	Replace each occurence of strToFind in str by replacementStr. More...

void	ComputeTextColors (vtkTextProperty *tprop, TextColors &tcolors)
	Compute rgba values of the foreground, background and frame of the text property. More...

bool	SetMathTextFont (vtkTextProperty *tprop)
	Modify matplotlib.rcParams to customize math text font. More...

PyObject *	GetFontProperties (vtkTextProperty *tprop)
	Returns a matplotlib.font_manager.FontProperties PyObject, initialized from the vtkTextProperty tprop. More...

void	CleanupPythonObjects ()
	Cleanup and destroy any python objects. More...

bool	PrepareImageData (vtkImageData *data, int bbox[4])

Protected Member Functions inherited from vtkMathTextUtilities
virtual vtkObjectBase *	NewInstanceInternal () 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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	GetJustifiedBBox (int rows, int cols, vtkTextProperty *tprop, int bbox[4])

static void	RotateCorners (double angleDeg, double corners[4][2], double bbox[4])

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkPythonInterpreter *	Interpreter

PyObject *	MaskParser

PyObject *	PathParser

PyObject *	FontPropertiesClass

bool	ScaleToPowerOfTwo

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
static constexpr const char *	PipeProtectString = "VTK_PROTECT_PIPE"

Detailed Description

Access to MatPlotLib MathText rendering.

vtkMatplotlibMathTextUtilities provides access to the MatPlotLib MathText implementation.

This class is aware of a number of environment variables that can be used to configure and debug python initialization (all are optional):

VTK_MATPLOTLIB_DEBUG: Enable verbose debugging output during initialization of the python environment.

This class handles rendering multiline and multicolumn strings into image data. Use '
' to define a line, and '|' to define a column.

This class does not support rendering multiline and multicolumn strings into a vtkPath.

Example :

str = "$\\sum_{i=0}^\\infty x_i$ | 2 | 3 | 4 \n"

1 | 2 | 3";

The vertical space between two lines can be set with vtkTextProperty::SetLineSpacing and vtkTextProperty::SetLineOffset

The horizontal space between two cells can be set with vtkTextProperty::SetCellOffset

Currently, it is not possible to draw separators between grid cells. Only exterior edges can be drawn with vtkTextProperty::SetFrame

Definition at line 64 of file vtkMatplotlibMathTextUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMathTextUtilities vtkMatplotlibMathTextUtilities::Superclass

Definition at line 67 of file vtkMatplotlibMathTextUtilities.h.

Constructor & Destructor Documentation

◆ vtkMatplotlibMathTextUtilities()

vtkMatplotlibMathTextUtilities::vtkMatplotlibMathTextUtilities ( )

protected

◆ ~vtkMatplotlibMathTextUtilities()

vtkMatplotlibMathTextUtilities::~vtkMatplotlibMathTextUtilities ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMatplotlibMathTextUtilities::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMathTextUtilities.

◆ NewInstance()

vtkMatplotlibMathTextUtilities * vtkMatplotlibMathTextUtilities::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkMatplotlibMathTextUtilities * vtkMatplotlibMathTextUtilities::New ( )

static

◆ IsAvailable()

bool vtkMatplotlibMathTextUtilities::IsAvailable ( )

overridevirtual

Returns true if mathtext rendering is available.

Reimplemented from vtkMathTextUtilities.

◆ GetBoundingBox()

bool vtkMatplotlibMathTextUtilities::GetBoundingBox	(	vtkTextProperty *	tprop,
		const char *	str,
		int	dpi,
		int	bbox[4]
	)

overridevirtual

Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered string in pixels.

The origin of the bounding box is the anchor point described by the horizontal and vertical justification text property variables. Returns true on success, false otherwise.

Implements vtkMathTextUtilities.

◆ GetMetrics()

bool vtkMatplotlibMathTextUtilities::GetMetrics	(	vtkTextProperty *	tprop,
		const char *	str,
		int	dpi,
		vtkTextRenderer::Metrics &	metrics
	)

overridevirtual

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

Implements vtkMathTextUtilities.

◆ RenderString()

bool vtkMatplotlibMathTextUtilities::RenderString	(	const char *	str,
		vtkImageData *	image,
		vtkTextProperty *	tprop,
		int	dpi,
		int	textDims[2] = `nullptr`
	)

overridevirtual

Render the given string str into the vtkImageData image with a resolution of dpi.

The image is resized automatically. textDims will be overwritten by the pixel width and height of the rendered string. This is useful when ScaleToPowerOfTwo is true, and the image dimensions may not match the dimensions of the rendered text. The origin of the image's extents is aligned with the anchor point described by the text property's vertical and horizontal justification options. This function supports multiline and multicolumn strings.

Implements vtkMathTextUtilities.

◆ StringToPath()

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

overridevirtual

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

The origin of the path coordinates is aligned with the anchor point described by the text property's horizontal and vertical justification options. This function does not support multiline and multicolumn strings.

Implements vtkMathTextUtilities.

◆ SetScaleToPowerOfTwo()

void vtkMatplotlibMathTextUtilities::SetScaleToPowerOfTwo ( bool val )

overridevirtual

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.

Implements vtkMathTextUtilities.

◆ GetScaleToPowerOfTwo()

bool vtkMatplotlibMathTextUtilities::GetScaleToPowerOfTwo ( )

overridevirtual

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.

Implements vtkMathTextUtilities.

◆ InitializeMaskParser()

bool vtkMatplotlibMathTextUtilities::InitializeMaskParser ( )

protected

◆ InitializePathParser()

bool vtkMatplotlibMathTextUtilities::InitializePathParser ( )

protected

◆ InitializeFontPropertiesClass()

bool vtkMatplotlibMathTextUtilities::InitializeFontPropertiesClass ( )

protected

◆ CheckForError() [1/2]

bool vtkMatplotlibMathTextUtilities::CheckForError ( )

protected

◆ CheckForError() [2/2]

bool vtkMatplotlibMathTextUtilities::CheckForError ( PyObject * object )

protected

◆ FindAndReplaceInString()

void vtkMatplotlibMathTextUtilities::FindAndReplaceInString	(	std::string &	str,
		const std::string &	strToFind,
		const std::string &	replacementStr
	)

protected

Replace each occurence of strToFind in str by replacementStr.

Used to protect escaped pipe before the splitting process, and recover them after.

◆ ComputeTextColors()

void vtkMatplotlibMathTextUtilities::ComputeTextColors	(	vtkTextProperty *	tprop,
		TextColors &	tcolors
	)

protected

Compute rgba values of the foreground, background and frame of the text property.

◆ SetMathTextFont()

bool vtkMatplotlibMathTextUtilities::SetMathTextFont ( vtkTextProperty * tprop )

protected

Modify matplotlib.rcParams to customize math text font.

◆ GetFontProperties()

PyObject * vtkMatplotlibMathTextUtilities::GetFontProperties ( vtkTextProperty * tprop )

protected

Returns a matplotlib.font_manager.FontProperties PyObject, initialized from the vtkTextProperty tprop.

◆ CleanupPythonObjects()

void vtkMatplotlibMathTextUtilities::CleanupPythonObjects ( )

protected

Cleanup and destroy any python objects.

This is called during destructor as well as when the Python interpreter is finalized. Thus this class must handle the case where the internal python objects disappear between calls.

◆ GetJustifiedBBox()

static void vtkMatplotlibMathTextUtilities::GetJustifiedBBox	(	int	rows,
		int	cols,
		vtkTextProperty *	tprop,
		int	bbox[4]
	)

staticprotected

◆ RotateCorners()

static void vtkMatplotlibMathTextUtilities::RotateCorners	(	double	angleDeg,
		double	corners[4][2],
		double	bbox[4]
	)

staticprotected

◆ PrepareImageData()

bool vtkMatplotlibMathTextUtilities::PrepareImageData	(	vtkImageData *	data,
		int	bbox[4]
	)

protected

Member Data Documentation

◆ PipeProtectString

constexpr const char* vtkMatplotlibMathTextUtilities::PipeProtectString = "VTK_PROTECT_PIPE"

staticconstexprprotected

Definition at line 138 of file vtkMatplotlibMathTextUtilities.h.

◆ Interpreter

vtkPythonInterpreter* vtkMatplotlibMathTextUtilities::Interpreter

protected

Definition at line 164 of file vtkMatplotlibMathTextUtilities.h.

◆ MaskParser

PyObject* vtkMatplotlibMathTextUtilities::MaskParser

protected

Definition at line 165 of file vtkMatplotlibMathTextUtilities.h.

◆ PathParser

PyObject* vtkMatplotlibMathTextUtilities::PathParser

protected

Definition at line 166 of file vtkMatplotlibMathTextUtilities.h.

◆ FontPropertiesClass

PyObject* vtkMatplotlibMathTextUtilities::FontPropertiesClass

protected

Definition at line 167 of file vtkMatplotlibMathTextUtilities.h.

◆ ScaleToPowerOfTwo

bool vtkMatplotlibMathTextUtilities::ScaleToPowerOfTwo

protected

Definition at line 175 of file vtkMatplotlibMathTextUtilities.h.

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

Rendering/Matplotlib/vtkMatplotlibMathTextUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMatplotlibMathTextUtilities()

◆ ~vtkMatplotlibMathTextUtilities()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ IsAvailable()

◆ GetBoundingBox()

◆ GetMetrics()

◆ RenderString()

◆ StringToPath()

◆ SetScaleToPowerOfTwo()

◆ GetScaleToPowerOfTwo()

◆ InitializeMaskParser()

◆ InitializePathParser()

◆ InitializeFontPropertiesClass()

◆ CheckForError() [1/2]

◆ CheckForError() [2/2]

◆ FindAndReplaceInString()

◆ ComputeTextColors()

◆ SetMathTextFont()

◆ GetFontProperties()

◆ CleanupPythonObjects()

◆ GetJustifiedBBox()

◆ RotateCorners()

◆ PrepareImageData()

Member Data Documentation

◆ PipeProtectString

◆ Interpreter

◆ MaskParser

◆ PathParser

◆ FontPropertiesClass

◆ ScaleToPowerOfTwo