Abstract interface to equation rendering. More...

#include <vtkMathTextUtilities.h>

Inheritance diagram for vtkMathTextUtilities:

Collaboration diagram for vtkMathTextUtilities:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkMathTextUtilities *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual bool	IsAvailable ()


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


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


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


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


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


virtual bool	GetScaleToPowerOfTwo ()=0

virtual void	SetScaleToPowerOfTwo (bool scale)=0

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

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

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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).

Tests:: vtkMathTextUtilities (Tests)

Definition at line 53 of file vtkMathTextUtilities.h.

Member Typedef Documentation

typedef vtkObject vtkMathTextUtilities::Superclass

Definition at line 56 of file vtkMathTextUtilities.h.

Constructor & Destructor Documentation

vtkMathTextUtilities::vtkMathTextUtilities ( )

protected

virtual vtkMathTextUtilities::~vtkMathTextUtilities ( )

protectedvirtual

Member Function Documentation

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

static

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

virtual vtkObjectBase* vtkMathTextUtilities::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkMatplotlibMathTextUtilities.

vtkMathTextUtilities* vtkMathTextUtilities::NewInstance ( ) const

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.

virtual bool vtkMathTextUtilities::IsAvailable ( )

inlinevirtual

Returns true if mathtext rendering is available.

Reimplemented in vtkMatplotlibMathTextUtilities.

Definition at line 60 of file vtkMathTextUtilities.h.

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.

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

virtual bool vtkMathTextUtilities::RenderString	(	const char *	str,
		vtkImageData *	data,
		vtkTextProperty *	tprop,
		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,
		int	dpi
	)

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,
		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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/FreeType/vtkMathTextUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation