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

Renders labels with freetype. More...

#include <vtkFreeTypeLabelRenderStrategy.h>

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

Public Types

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

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkFreeTypeLabelRenderStrategyNewInstance () const
 
virtual bool SupportsRotation ()
 The free type render strategy currently does not support rotation. More...
 
virtual bool SupportsBoundedSize ()
 The free type render strategy currently does not support bounded size labels. More...
 
virtual void ComputeLabelBounds (vtkTextProperty *tprop, vtkStdString label, double bds[4])
 Compute the bounds of a label. More...
 
virtual void ComputeLabelBounds (vtkTextProperty *tprop, vtkUnicodeString label, double bds[4])
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label)
 Render a label at a location in world coordinates. More...
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label, int width)
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkUnicodeString label)
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkUnicodeString label, int width)
 
virtual void ReleaseGraphicsResources (vtkWindow *window)
 Release any graphics resources that are being consumed by this strategy. More...
 
- Public Member Functions inherited from vtkLabelRenderStrategy
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkLabelRenderStrategyNewInstance () const
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkUnicodeString label, int vtkNotUsed(maxWidth))
 
virtual void StartFrame ()
 Start a rendering frame. More...
 
virtual void EndFrame ()
 End a rendering frame. More...
 
virtual void SetRenderer (vtkRenderer *ren)
 Set the renderer associated with this strategy. More...
 
virtual vtkRendererGetRenderer ()
 Set the renderer associated with this strategy. More...
 
virtual void SetDefaultTextProperty (vtkTextProperty *tprop)
 Set the default text property for the strategy. More...
 
virtual vtkTextPropertyGetDefaultTextProperty ()
 Set the default text property for the strategy. More...
 
- 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
void PrintRevisions (ostream &)
 Legacy. 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 int IsTypeOf (const char *type)
 
static vtkFreeTypeLabelRenderStrategySafeDownCast (vtkObjectBase *o)
 
static vtkFreeTypeLabelRenderStrategyNew ()
 
- Static Public Member Functions inherited from vtkLabelRenderStrategy
static int IsTypeOf (const char *type)
 
static vtkLabelRenderStrategySafeDownCast (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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFreeTypeLabelRenderStrategy ()
 
 ~vtkFreeTypeLabelRenderStrategy ()
 
- Protected Member Functions inherited from vtkLabelRenderStrategy
 vtkLabelRenderStrategy ()
 
 ~vtkLabelRenderStrategy ()
 
- 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=NULL)
 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTextRendererTextRenderer
 
vtkTextMapperMapper
 
vtkActor2DActor
 
- Protected Attributes inherited from vtkLabelRenderStrategy
vtkRendererRenderer
 
vtkTextPropertyDefaultTextProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Renders labels with freetype.

Uses the FreeType to render labels and compute label sizes. This strategy may be used with vtkLabelPlacementMapper.

Definition at line 34 of file vtkFreeTypeLabelRenderStrategy.h.

Member Typedef Documentation

Definition at line 38 of file vtkFreeTypeLabelRenderStrategy.h.

Constructor & Destructor Documentation

vtkFreeTypeLabelRenderStrategy::vtkFreeTypeLabelRenderStrategy ( )
protected
vtkFreeTypeLabelRenderStrategy::~vtkFreeTypeLabelRenderStrategy ( )
protected

Member Function Documentation

void vtkFreeTypeLabelRenderStrategy::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.

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

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

Reimplemented from vtkLabelRenderStrategy.

vtkFreeTypeLabelRenderStrategy* vtkFreeTypeLabelRenderStrategy::NewInstance ( ) const
static vtkFreeTypeLabelRenderStrategy* vtkFreeTypeLabelRenderStrategy::New ( )
static
virtual bool vtkFreeTypeLabelRenderStrategy::SupportsRotation ( )
inlinevirtual

The free type render strategy currently does not support rotation.

Reimplemented from vtkLabelRenderStrategy.

Definition at line 44 of file vtkFreeTypeLabelRenderStrategy.h.

virtual bool vtkFreeTypeLabelRenderStrategy::SupportsBoundedSize ( )
inlinevirtual

The free type render strategy currently does not support bounded size labels.

Reimplemented from vtkLabelRenderStrategy.

Definition at line 50 of file vtkFreeTypeLabelRenderStrategy.h.

virtual void vtkFreeTypeLabelRenderStrategy::ComputeLabelBounds ( vtkTextProperty tprop,
vtkStdString  label,
double  bds[4] 
)
inlinevirtual

Compute the bounds of a label.

Must be performed after the renderer is set.

Reimplemented from vtkLabelRenderStrategy.

Definition at line 56 of file vtkFreeTypeLabelRenderStrategy.h.

virtual void vtkFreeTypeLabelRenderStrategy::ComputeLabelBounds ( vtkTextProperty tprop,
vtkUnicodeString  label,
double  bds[4] 
)
virtual
virtual void vtkFreeTypeLabelRenderStrategy::RenderLabel ( int  x[2],
vtkTextProperty tprop,
vtkStdString  label 
)
inlinevirtual

Render a label at a location in world coordinates.

Must be performed between StartFrame() and EndFrame() calls.

Reimplemented from vtkLabelRenderStrategy.

Definition at line 64 of file vtkFreeTypeLabelRenderStrategy.h.

virtual void vtkFreeTypeLabelRenderStrategy::RenderLabel ( int  x[2],
vtkTextProperty tprop,
vtkStdString  label,
int  width 
)
inlinevirtual

Reimplemented from vtkLabelRenderStrategy.

Definition at line 66 of file vtkFreeTypeLabelRenderStrategy.h.

virtual void vtkFreeTypeLabelRenderStrategy::RenderLabel ( int  x[2],
vtkTextProperty tprop,
vtkUnicodeString  label 
)
virtual
virtual void vtkFreeTypeLabelRenderStrategy::RenderLabel ( int  x[2],
vtkTextProperty tprop,
vtkUnicodeString  label,
int  width 
)
inlinevirtual

Definition at line 69 of file vtkFreeTypeLabelRenderStrategy.h.

virtual void vtkFreeTypeLabelRenderStrategy::ReleaseGraphicsResources ( vtkWindow window)
virtual

Release any graphics resources that are being consumed by this strategy.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkLabelRenderStrategy.

Member Data Documentation

vtkTextRenderer* vtkFreeTypeLabelRenderStrategy::TextRenderer
protected

Definition at line 83 of file vtkFreeTypeLabelRenderStrategy.h.

vtkTextMapper* vtkFreeTypeLabelRenderStrategy::Mapper
protected

Definition at line 84 of file vtkFreeTypeLabelRenderStrategy.h.

vtkActor2D* vtkFreeTypeLabelRenderStrategy::Actor
protected

Definition at line 85 of file vtkFreeTypeLabelRenderStrategy.h.


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