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

#include <vtkStringToImage.h>

Inheritance diagram for vtkStringToImage:

Collaboration diagram for vtkStringToImage:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkStringToImage *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)

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

virtual int	RenderString (vtkTextProperty property, const vtkUnicodeString &string, vtkImageData data, int textDims[2]=NULL)=0
virtual int	RenderString (vtkTextProperty property, const vtkStdString &string, vtkImageData data, int text_dims[2]=NULL)=0

virtual void	SetScaleToPowerOfTwo (bool scale)
virtual bool	GetScaleToPowerOfTwo ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkStringToImage *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkStringToImage ()
	~vtkStringToImage ()
Protected Attributes
bool	Antialias
bool	ScaleToPowerOfTwo

Detailed Description

uses Qt to render the supplied text to an image.

Definition at line 35 of file vtkStringToImage.h.

Member Typedef Documentation

typedef vtkObject vtkStringToImage::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

Definition at line 38 of file vtkStringToImage.h.

Constructor & Destructor Documentation

vtkStringToImage::vtkStringToImage ( ) [protected]

vtkStringToImage::~vtkStringToImage ( ) [protected]

Member Function Documentation

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

Reimplemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

virtual int vtkStringToImage::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 vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

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

Reimplemented from vtkObject.

Reimplemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

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

Reimplemented from vtkObject.

Reimplemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

vtkStringToImage* vtkStringToImage::NewInstance ( ) const

Reimplemented from vtkObject.

Reimplemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

virtual void vtkStringToImage::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 vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

virtual vtkVector2i vtkStringToImage::GetBounds	(	vtkTextProperty *	property,
		const vtkUnicodeString &	string
	)		`[pure 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).

Implemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

virtual vtkVector2i vtkStringToImage::GetBounds	(	vtkTextProperty *	property,
		const vtkStdString &	string
	)		`[pure 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).

Implemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

virtual int vtkStringToImage::RenderString	(	vtkTextProperty *	property,
		const vtkUnicodeString &	string,
		vtkImageData *	data,
		int	textDims[2] = `NULL`
	)		`[pure 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.

Implemented in vtkFreeTypeStringToImage, vtkQtStringToImage, and vtkTextRendererStringToImage.

virtual int vtkStringToImage::RenderString	(	vtkTextProperty *	property,
		const vtkStdString &	string,
		vtkImageData *	data,
		int	text_dims[2] = `NULL`
	)		`[pure 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.

Implemented in vtkFreeTypeStringToImage, vtkQtStringToImage, and vtkTextRendererStringToImage.

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

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

Reimplemented in vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.

virtual bool vtkStringToImage::GetScaleToPowerOfTwo ( ) [virtual]

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