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

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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkFreeTypeStringToImageNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkVector2i GetBounds (vtkTextProperty *property, const vtkUnicodeString &string, int dpi) override
 Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. More...
 
vtkVector2i GetBounds (vtkTextProperty *property, const vtkStdString &string, int dpi) override
 
int RenderString (vtkTextProperty *property, const vtkUnicodeString &string, int dpi, vtkImageData *data, int textDims[2]=nullptr) override
 Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. More...
 
int RenderString (vtkTextProperty *property, const vtkStdString &string, int dpi, vtkImageData *data, int textDims[2]=nullptr) override
 
void SetScaleToPowerOfTwo (bool scale) override
 Should we produce images at powers of 2, makes rendering on old OpenGL hardware easier. More...
 
void DeepCopy (vtkFreeTypeStringToImage *utility)
 Make a deep copy of the supplied utility class. More...
 
- Public Member Functions inherited from vtkStringToImage
vtkStringToImageNewInstance () const
 
virtual bool GetScaleToPowerOfTwo ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFreeTypeStringToImageSafeDownCast (vtkObjectBase *o)
 
static vtkFreeTypeStringToImageNew ()
 
- Static Public Member Functions inherited from vtkStringToImage
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStringToImageSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFreeTypeStringToImage ()
 
 ~vtkFreeTypeStringToImage () override
 
- Protected Member Functions inherited from vtkStringToImage
 vtkStringToImage ()
 
 ~vtkStringToImage () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

render the supplied text to an image.

Definition at line 29 of file vtkFreeTypeStringToImage.h.

Member Typedef Documentation

◆ Superclass

Definition at line 32 of file vtkFreeTypeStringToImage.h.

Constructor & Destructor Documentation

◆ vtkFreeTypeStringToImage()

vtkFreeTypeStringToImage::vtkFreeTypeStringToImage ( )
protected

◆ ~vtkFreeTypeStringToImage()

vtkFreeTypeStringToImage::~vtkFreeTypeStringToImage ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkFreeTypeStringToImage::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkFreeTypeStringToImage* vtkFreeTypeStringToImage::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFreeTypeStringToImage::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStringToImage.

◆ NewInstance()

vtkFreeTypeStringToImage* vtkFreeTypeStringToImage::NewInstance ( ) const

◆ PrintSelf()

void vtkFreeTypeStringToImage::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ New()

static vtkFreeTypeStringToImage* vtkFreeTypeStringToImage::New ( )
static

◆ GetBounds() [1/2]

vtkVector2i vtkFreeTypeStringToImage::GetBounds ( vtkTextProperty property,
const vtkUnicodeString string,
int  dpi 
)
overridevirtual

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.

◆ GetBounds() [2/2]

vtkVector2i vtkFreeTypeStringToImage::GetBounds ( vtkTextProperty property,
const vtkStdString string,
int  dpi 
)
overridevirtual

Implements vtkStringToImage.

◆ RenderString() [1/2]

int vtkFreeTypeStringToImage::RenderString ( vtkTextProperty property,
const vtkUnicodeString string,
int  dpi,
vtkImageData data,
int  textDims[2] = nullptr 
)
overridevirtual

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.

◆ RenderString() [2/2]

int vtkFreeTypeStringToImage::RenderString ( vtkTextProperty property,
const vtkStdString string,
int  dpi,
vtkImageData data,
int  textDims[2] = nullptr 
)
overridevirtual

Implements vtkStringToImage.

◆ SetScaleToPowerOfTwo()

void vtkFreeTypeStringToImage::SetScaleToPowerOfTwo ( bool  scale)
overridevirtual

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

Default is false.

Reimplemented from vtkStringToImage.

◆ DeepCopy()

void vtkFreeTypeStringToImage::DeepCopy ( vtkFreeTypeStringToImage utility)

Make a deep copy of the supplied utility class.

Member Data Documentation

◆ Implementation

Internals* vtkFreeTypeStringToImage::Implementation
protected

Definition at line 85 of file vtkFreeTypeStringToImage.h.


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