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

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

#include <vtkStringToImage.h>

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

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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)=0
virtual int RenderString (vtkTextProperty *property, const vtkStdString &string, vtkImageData *data)=0
virtual void SetScaleToPowerOfTwo (bool scale)
virtual bool GetScaleToPowerOfTwo ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
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 &os)
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 vtkStringToImageSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

bool Antialias
bool ScaleToPowerOfTwo
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

uses Qt to render the supplied text to an image.

Definition at line 34 of file vtkStringToImage.h.

Member Typedef Documentation

Definition at line 37 of file vtkStringToImage.h.

Constructor & Destructor Documentation

vtkStringToImage::vtkStringToImage ( )
protected
vtkStringToImage::~vtkStringToImage ( )
protected

Member Function Documentation

virtual const char* vtkStringToImage::GetClassName ( )
virtual

Reimplemented from vtkObject.

Reimplemented in vtkQtStringToImage, and vtkFreeTypeStringToImage.

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, and vtkFreeTypeStringToImage.

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, and vtkFreeTypeStringToImage.

static vtkStringToImage* vtkStringToImage::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkObject.

Reimplemented in vtkQtStringToImage, and vtkFreeTypeStringToImage.

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, and vtkFreeTypeStringToImage.

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, and vtkFreeTypeStringToImage.

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, and vtkFreeTypeStringToImage.

virtual int vtkStringToImage::RenderString ( vtkTextProperty property,
const vtkUnicodeString string,
vtkImageData data 
)
pure virtual

Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData.

Implemented in vtkQtStringToImage, and vtkFreeTypeStringToImage.

virtual int vtkStringToImage::RenderString ( vtkTextProperty property,
const vtkStdString string,
vtkImageData data 
)
pure virtual

Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData.

Implemented in vtkQtStringToImage, and vtkFreeTypeStringToImage.

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.

virtual bool vtkStringToImage::GetScaleToPowerOfTwo ( )
virtual

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

Member Data Documentation

bool vtkStringToImage::Antialias
protected

Definition at line 78 of file vtkStringToImage.h.

bool vtkStringToImage::ScaleToPowerOfTwo
protected

Definition at line 79 of file vtkStringToImage.h.


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