base class for classes that render supplied text to an image. More...
#include <vtkStringToImage.h>
Public Types | |
| typedef vtkObject | Superclass |
 Public Types inherited from vtkObject | |
| typedef vtkObjectBase | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkStringToImage * | NewInstance () const |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual vtkVector2i | GetBounds (vtkTextProperty *property, const vtkUnicodeString &string, int dpi)=0 |
| virtual vtkVector2i | GetBounds (vtkTextProperty *property, const vtkStdString &string, int dpi)=0 |
| virtual int | RenderString (vtkTextProperty *property, const vtkUnicodeString &string, int dpi, vtkImageData *data, int textDims[2]=NULL)=0 |
| virtual int | RenderString (vtkTextProperty *property, const vtkStdString &string, int dpi, vtkImageData *data, int text_dims[2]=NULL)=0 |
| virtual void | SetScaleToPowerOfTwo (bool scale) |
| virtual bool | GetScaleToPowerOfTwo () |
| Public Member Functions inherited from vtkObject | |
| vtkObject * | NewInstance () 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) |
| vtkCommand * | GetCommand (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 vtkStringToImage * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkObject | |
| static int | IsTypeOf (const char *type) |
| static vtkObject * | SafeDownCast (vtkObjectBase *o) |
| static vtkObject * | New () |
| 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 vtkObjectBase * | New () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| 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 | |
| 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
base class for classes that render supplied text to an image.
Definition at line 36 of file vtkStringToImage.h.
Member Typedef Documentation
Definition at line 39 of file vtkStringToImage.h.
Constructor & Destructor Documentation
|
protected |
|
protected |
Member Function Documentation
|
static |
|
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, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.
|
static |
|
protectedvirtual |
Reimplemented from vtkObject.
Reimplemented in vtkQtStringToImage, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.
| vtkStringToImage* vtkStringToImage::NewInstance | ( | ) | const |
|
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, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.
|
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, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.
|
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, vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.
|
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 vtkFreeTypeStringToImage, vtkQtStringToImage, and vtkTextRendererStringToImage.
|
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 vtkFreeTypeStringToImage, vtkQtStringToImage, and vtkTextRendererStringToImage.
|
virtual |
Should we produce images at powers of 2, makes rendering on old OpenGL hardware easier. Default is false.
Reimplemented in vtkFreeTypeStringToImage, and vtkTextRendererStringToImage.
|
virtual |
Should we produce images at powers of 2, makes rendering on old OpenGL hardware easier. Default is false.
Member Data Documentation
|
protected |
Definition at line 86 of file vtkStringToImage.h.
|
protected |
Definition at line 87 of file vtkStringToImage.h.
The documentation for this class was generated from the following file:
- dox/Rendering/Core/vtkStringToImage.h
