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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkMatplotlibMathTextUtilities *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual bool	IsAvailable ()

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


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


bool	RenderString (const char str, vtkImageData data, vtkTextProperty *tprop, int dpi, int textDims[2]=NULL)


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


virtual void	SetScaleToPowerOfTwo (bool)

virtual bool	GetScaleToPowerOfTwo ()

Public Member Functions inherited from vtkMathTextUtilities
vtkMathTextUtilities *	NewInstance () const

virtual int	GetConstrainedFontSize (const char str, vtkTextProperty tprop, int targetWidth, int targetHeight, int dpi)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

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 )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkMatplotlibMathTextUtilities *	SafeDownCast (vtkObjectBase *o)

static vtkMatplotlibMathTextUtilities *	New ()

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

static vtkMathTextUtilities *	SafeDownCast (vtkObjectBase *o)

static vtkMathTextUtilities *	New ()

static vtkMathTextUtilities *	GetInstance ()

static void	SetInstance (vtkMathTextUtilities *instance)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMatplotlibMathTextUtilities ()

virtual	~vtkMatplotlibMathTextUtilities ()

bool	InitializeMaskParser ()

bool	InitializePathParser ()

bool	InitializeFontPropertiesClass ()

bool	CheckForError ()

bool	CheckForError (PyObject *object)

PyObject *	GetFontProperties (vtkTextProperty *tprop)

void	CleanupPythonObjects ()

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

Protected Member Functions inherited from vtkMathTextUtilities
	vtkMathTextUtilities ()

virtual	~vtkMathTextUtilities ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

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

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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.

Tests:
vtkMatplotlibMathTextUtilities (Tests)

Definition at line 43 of file vtkMatplotlibMathTextUtilities.h.

Member Typedef Documentation

typedef vtkMathTextUtilities vtkMatplotlibMathTextUtilities::Superclass

Definition at line 47 of file vtkMatplotlibMathTextUtilities.h.

Constructor & Destructor Documentation

vtkMatplotlibMathTextUtilities::vtkMatplotlibMathTextUtilities ( )

protected

virtual vtkMatplotlibMathTextUtilities::~vtkMatplotlibMathTextUtilities ( )

protectedvirtual

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkMatplotlibMathTextUtilities::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMathTextUtilities.

vtkMatplotlibMathTextUtilities* vtkMatplotlibMathTextUtilities::NewInstance ( ) const

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

static vtkMatplotlibMathTextUtilities* vtkMatplotlibMathTextUtilities::New ( )

static

virtual bool vtkMatplotlibMathTextUtilities::IsAvailable ( )

virtual

Returns true if mathtext rendering is available.

Reimplemented from vtkMathTextUtilities.

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

virtual

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.

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

virtual

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

Implements vtkMathTextUtilities.

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

virtual

Render the given string str into the vtkImageData data 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.

Implements vtkMathTextUtilities.

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

virtual

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.

Implements vtkMathTextUtilities.

virtual void vtkMatplotlibMathTextUtilities::SetScaleToPowerOfTwo ( bool )

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.

Implements vtkMathTextUtilities.

virtual bool vtkMatplotlibMathTextUtilities::GetScaleToPowerOfTwo ( )

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.

Implements vtkMathTextUtilities.

bool vtkMatplotlibMathTextUtilities::InitializeMaskParser ( )

protected

bool vtkMatplotlibMathTextUtilities::InitializePathParser ( )

protected

bool vtkMatplotlibMathTextUtilities::InitializeFontPropertiesClass ( )

protected

bool vtkMatplotlibMathTextUtilities::CheckForError ( )

protected

bool vtkMatplotlibMathTextUtilities::CheckForError ( PyObject * object )

protected

PyObject* vtkMatplotlibMathTextUtilities::GetFontProperties ( vtkTextProperty * tprop )

protected

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

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.