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

base class for classes that render 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 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...
 
vtkStringToImageNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetScaleToPowerOfTwo (bool scale)
 Should we produce images at powers of 2, makes rendering on old OpenGL hardware easier. More...
 
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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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
 
const vtkUnicodeStringstring
 Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. More...
 
const vtkUnicodeString int dpi = 0
 Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. More...
 
 VTK_DEPRECATED_IN_9_1_0 ("Use vtkVector2i GetBounds(vtkTextProperty* property, const vtkStdString& string, int dpi)") virtual vtkVector2i GetBounds(vtkTextProperty *property
 Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. More...
 
virtual vtkVector2i GetBounds (vtkTextProperty *property, const vtkStdString &string, int dpi)=0
 Given a text property and a string, get the bounding box [xmin, xmax] x [ymin, ymax]. More...
 
const vtkUnicodeString int vtkImageDatadata
 Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. More...
 
const vtkUnicodeString int vtkImageData int textDims [2] = nullptr) = 0
 Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. More...
 
 VTK_DEPRECATED_IN_9_1_0 ("Use int RenderString(vtkTextProperty* property, const vtkStdString& " "string, int dpi, vtkImageData* data, int text_dims[2] = nullptr)") virtual int RenderString(vtkTextProperty *property
 Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. More...
 
virtual int RenderString (vtkTextProperty *property, const vtkStdString &string, int dpi, vtkImageData *data, int text_dims[2]=nullptr)=0
 Given a text property and a string, this function initializes the vtkImageData *data and renders it in a vtkImageData. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

base class for classes that render supplied text to an image.

Definition at line 38 of file vtkStringToImage.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkStringToImage.h.

Constructor & Destructor Documentation

◆ vtkStringToImage()

vtkStringToImage::vtkStringToImage ( )
protected

◆ ~vtkStringToImage()

vtkStringToImage::~vtkStringToImage ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkQtStringToImage, vtkTextRendererStringToImage, and vtkFreeTypeStringToImage.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStringToImage::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkStringToImage* vtkStringToImage::NewInstance ( ) const

◆ PrintSelf()

void vtkStringToImage::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 vtkObject.

Reimplemented in vtkQtStringToImage, vtkTextRendererStringToImage, and vtkFreeTypeStringToImage.

◆ VTK_DEPRECATED_IN_9_1_0() [1/2]

vtkStringToImage::VTK_DEPRECATED_IN_9_1_0 ( "Use vtkVector2i GetBounds(vtkTextProperty* property, const vtkStdString& string, int dpi)"  )

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

◆ GetBounds()

virtual vtkVector2i vtkStringToImage::GetBounds ( vtkTextProperty property,
const vtkStdString string,
int  dpi 
)
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, vtkTextRendererStringToImage, and vtkFreeTypeStringToImage.

◆ VTK_DEPRECATED_IN_9_1_0() [2/2]

vtkStringToImage::VTK_DEPRECATED_IN_9_1_0 ( "Use int RenderString(vtkTextProperty* property, const vtkStdString& " "string, int dpi, vtkImageData* data, int text_dims[2] = nullptr)"  )

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.

◆ RenderString()

virtual int vtkStringToImage::RenderString ( vtkTextProperty property,
const vtkStdString string,
int  dpi,
vtkImageData data,
int  text_dims[2] = nullptr 
)
pure 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.

Implemented in vtkQtStringToImage, vtkTextRendererStringToImage, and vtkFreeTypeStringToImage.

◆ SetScaleToPowerOfTwo()

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

◆ GetScaleToPowerOfTwo()

virtual bool vtkStringToImage::GetScaleToPowerOfTwo ( )
virtual

Member Data Documentation

◆ string

const vtkUnicodeString & vtkStringToImage::string

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

Definition at line 61 of file vtkStringToImage.h.

◆ dpi

const vtkUnicodeString int vtkStringToImage::dpi = 0

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

Definition at line 61 of file vtkStringToImage.h.

◆ data

const vtkUnicodeString int vtkImageData* vtkStringToImage::data

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.

Definition at line 76 of file vtkStringToImage.h.

◆ textDims

const vtkUnicodeString int vtkImageData int vtkStringToImage::textDims[2] = nullptr) = 0

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.

Definition at line 76 of file vtkStringToImage.h.

◆ Antialias

bool vtkStringToImage::Antialias
protected

Definition at line 92 of file vtkStringToImage.h.

◆ ScaleToPowerOfTwo

bool vtkStringToImage::ScaleToPowerOfTwo
protected

Definition at line 93 of file vtkStringToImage.h.


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