VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkFreeTypeStringToImage Class Reference

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

#include <vtkFreeTypeStringToImage.h>

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

Public Types

typedef vtkStringToImage Superclass
 
- Public Types inherited from vtkStringToImage
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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, int dpi)
 
virtual vtkVector2i GetBounds (vtkTextProperty *property, const vtkStdString &string, int dpi)
 
virtual int RenderString (vtkTextProperty *property, const vtkUnicodeString &string, int dpi, vtkImageData *data, int textDims[2]=NULL)
 
virtual int RenderString (vtkTextProperty *property, const vtkStdString &string, int dpi, vtkImageData *data, int textDims[2]=NULL)
 
- Public Member Functions inherited from vtkStringToImage
vtkStringToImageNewInstance () const
 
virtual bool GetScaleToPowerOfTwo ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 vtkFreeTypeStringToImageSafeDownCast (vtkObjectBase *o)
 
static vtkFreeTypeStringToImageNew ()
 
- Static Public Member Functions inherited from vtkStringToImage
static int IsTypeOf (const char *type)
 
static vtkStringToImageSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFreeTypeStringToImage ()
 
 ~vtkFreeTypeStringToImage ()
 
- Protected Member Functions inherited from vtkStringToImage
 vtkStringToImage ()
 
 ~vtkStringToImage ()
 
- 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 &)
 

Protected Attributes

Internals * Implementation
 
- Protected Attributes inherited from vtkStringToImage
bool Antialias
 
bool ScaleToPowerOfTwo
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Definition at line 36 of file vtkFreeTypeStringToImage.h.

Constructor & Destructor Documentation

vtkFreeTypeStringToImage::vtkFreeTypeStringToImage ( )
protected
vtkFreeTypeStringToImage::~vtkFreeTypeStringToImage ( )
protected

Member Function Documentation

static int vtkFreeTypeStringToImage::IsTypeOf ( const char *  type)
static
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.

static vtkFreeTypeStringToImage* vtkFreeTypeStringToImage::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkFreeTypeStringToImage::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStringToImage.

vtkFreeTypeStringToImage* vtkFreeTypeStringToImage::NewInstance ( ) const
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.

static vtkFreeTypeStringToImage* vtkFreeTypeStringToImage::New ( )
static
virtual vtkVector2i vtkFreeTypeStringToImage::GetBounds ( vtkTextProperty property,
const vtkUnicodeString string,
int  dpi 
)
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,
int  dpi 
)
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,
int  dpi,
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,
int  dpi,
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.

void vtkFreeTypeStringToImage::DeepCopy ( vtkFreeTypeStringToImage utility)

Make a deep copy of the supplied utility class.

Member Data Documentation

Internals* vtkFreeTypeStringToImage::Implementation
protected

Definition at line 85 of file vtkFreeTypeStringToImage.h.


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