uses vtkTextRenderer to render the supplied text to an image. More...

#include <vtkTextRendererStringToImage.h>

Inheritance diagram for vtkTextRendererStringToImage:

Collaboration diagram for vtkTextRendererStringToImage:

Public Types
typedef vtkStringToImage	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkTextRendererStringToImage *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetScaleToPowerOfTwo (bool scale)
void	DeepCopy (vtkTextRendererStringToImage *utility)

virtual vtkVector2i	GetBounds (vtkTextProperty *property, const vtkUnicodeString &string)
virtual vtkVector2i	GetBounds (vtkTextProperty *property, const vtkStdString &string)

virtual int	RenderString (vtkTextProperty property, const vtkUnicodeString &string, vtkImageData data, int textDims[2]=NULL)
virtual int	RenderString (vtkTextProperty property, const vtkStdString &string, vtkImageData data, int textDims[2]=NULL)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTextRendererStringToImage *	SafeDownCast (vtkObjectBase *o)
static vtkTextRendererStringToImage *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTextRendererStringToImage ()
	~vtkTextRendererStringToImage ()
Protected Attributes
Internals *	Implementation

Detailed Description

uses vtkTextRenderer to render the supplied text to an image.

Definition at line 27 of file vtkTextRendererStringToImage.h.

Member Typedef Documentation

typedef vtkStringToImage vtkTextRendererStringToImage::Superclass

Reimplemented from vtkStringToImage.

Definition at line 31 of file vtkTextRendererStringToImage.h.

Constructor & Destructor Documentation

vtkTextRendererStringToImage::vtkTextRendererStringToImage ( ) [protected]

vtkTextRendererStringToImage::~vtkTextRendererStringToImage ( ) [protected]

Member Function Documentation

static int vtkTextRendererStringToImage::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 vtkStringToImage.

virtual int vtkTextRendererStringToImage::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 vtkStringToImage.

static vtkTextRendererStringToImage* vtkTextRendererStringToImage::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkStringToImage.

virtual vtkObjectBase* vtkTextRendererStringToImage::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkStringToImage.

vtkTextRendererStringToImage* vtkTextRendererStringToImage::NewInstance ( ) const

Reimplemented from vtkStringToImage.

virtual void vtkTextRendererStringToImage::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 vtkStringToImage.

static vtkTextRendererStringToImage* vtkTextRendererStringToImage::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual vtkVector2i vtkTextRendererStringToImage::GetBounds	(	vtkTextProperty *	property,
		const vtkUnicodeString &	string
	)		`[virtual]`

Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. Note that this is the bounding box of the area where actual pixels will be written, given a text/pen/baseline location of (0,0). For example, if the string starts with a 'space', or depending on the orientation, you can end up with a [-20, -10] x [5, 10] bbox (the math to get the real bbox is straightforward). Return 1 on success, 0 otherwise. You can use IsBoundingBoxValid() to test if the computed bbox is valid (it may not if GetBoundingBox() failed or if the string was empty).

Implements vtkStringToImage.

virtual vtkVector2i vtkTextRendererStringToImage::GetBounds	(	vtkTextProperty *	property,
		const vtkStdString &	string
	)		`[virtual]`

Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. Note that this is the bounding box of the area where actual pixels will be written, given a text/pen/baseline location of (0,0). For example, if the string starts with a 'space', or depending on the orientation, you can end up with a [-20, -10] x [5, 10] bbox (the math to get the real bbox is straightforward). Return 1 on success, 0 otherwise. You can use IsBoundingBoxValid() to test if the computed bbox is valid (it may not if GetBoundingBox() failed or if the string was empty).

Implements vtkStringToImage.

virtual int vtkTextRendererStringToImage::RenderString	(	vtkTextProperty *	property,
		const vtkUnicodeString &	string,
		vtkImageData *	data,
		int	textDims[2] = `NULL`
	)		`[virtual]`

Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. textDims, if provided, 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.

Implements vtkStringToImage.

virtual int vtkTextRendererStringToImage::RenderString	(	vtkTextProperty *	property,
		const vtkStdString &	string,
		vtkImageData *	data,
		int	textDims[2] = `NULL`
	)		`[virtual]`

Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. textDims, if provided, 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.

Implements vtkStringToImage.

virtual void vtkTextRendererStringToImage::SetScaleToPowerOfTwo ( bool scale ) [virtual]

Should we produce images at powers of 2, makes rendering on old OpenGL hardware easier. Default is false.

Reimplemented from vtkStringToImage.

void vtkTextRendererStringToImage::DeepCopy ( vtkTextRendererStringToImage * utility )

Make a deep copy of the supplied utility class.