VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkFreeTypeStringToImage Class Reference

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

#include <vtkFreeTypeStringToImage.h>

Inheritance diagram for vtkFreeTypeStringToImage:
Inheritance graph
[legend]
Collaboration diagram for vtkFreeTypeStringToImage:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkStringToImage Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkFreeTypeStringToImageNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetScaleToPowerOfTwo (bool scale)
void DeepCopy (vtkFreeTypeStringToImage *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 vtkFreeTypeStringToImageSafeDownCast (vtkObjectBase *o)
static vtkFreeTypeStringToImageNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkFreeTypeStringToImage ()
 ~vtkFreeTypeStringToImage ()

Protected Attributes

Internals * Implementation

Detailed Description

uses Qt to render the supplied text to an image.

Tests:
vtkFreeTypeStringToImage (Tests)

Definition at line 33 of file vtkFreeTypeStringToImage.h.


Member Typedef Documentation

Reimplemented from vtkStringToImage.

Definition at line 36 of file vtkFreeTypeStringToImage.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkStringToImage.

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

Reimplemented from vtkStringToImage.

Reimplemented from vtkStringToImage.

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

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

Reimplemented from vtkObject.

virtual vtkVector2i vtkFreeTypeStringToImage::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 vtkFreeTypeStringToImage::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 vtkFreeTypeStringToImage::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 vtkFreeTypeStringToImage::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 vtkFreeTypeStringToImage::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.

Make a deep copy of the supplied utility class.


Member Data Documentation

Definition at line 85 of file vtkFreeTypeStringToImage.h.


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