VTK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTextRendererStringToImage Class Reference

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

#include <vtkTextRendererStringToImage.h>

Inherits vtkStringToImage.

Public Types

typedef vtkStringToImage Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTextRendererStringToImageNewInstance () 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

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 *  type)
static
virtual int vtkTextRendererStringToImage::IsA ( const char *  type)
virtual
static vtkTextRendererStringToImage* vtkTextRendererStringToImage::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTextRendererStringToImage::NewInstanceInternal ( ) const
protectedvirtual
vtkTextRendererStringToImage* vtkTextRendererStringToImage::NewInstance ( ) const
virtual void vtkTextRendererStringToImage::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
static vtkTextRendererStringToImage* vtkTextRendererStringToImage::New ( )
static
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).

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

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.

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.

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.

void vtkTextRendererStringToImage::DeepCopy ( vtkTextRendererStringToImage utility)

Make a deep copy of the supplied utility class.

Member Data Documentation

Internals* vtkTextRendererStringToImage::Implementation
protected

Definition at line 80 of file vtkTextRendererStringToImage.h.


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