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) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkFreeTypeLabelRenderStrategyNewInstance () const
 
bool SupportsRotation () override
 The free type render strategy currently does not support rotation. More...
 
bool SupportsBoundedSize () override
 The free type render strategy currently does not support bounded size labels. More...
 
void ComputeLabelBounds (vtkTextProperty *tprop, vtkStdString label, double bds[4]) override
 Compute the bounds of a label. More...
 
void ComputeLabelBounds (vtkTextProperty *tprop, vtkUnicodeString label, double bds[4]) override
 
void RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label) override
 Render a label at a location in world coordinates. More...
 
void RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label, int width) override
 
void RenderLabel (int x[2], vtkTextProperty *tprop, vtkUnicodeString label) override
 
void RenderLabel (int x[2], vtkTextProperty *tprop, vtkUnicodeString label, int width) override
 
void ReleaseGraphicsResources (vtkWindow *window) override
 Release any graphics resources that are being consumed by this strategy. More...
 
- Public Member Functions inherited from vtkLabelRenderStrategy
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkLabelRenderStrategyNewInstance () const
 
virtual void SetRenderer (vtkRenderer *ren)
 Set the renderer associated with this strategy. More...
 
virtual vtkRendererGetRenderer ()
 
virtual void SetDefaultTextProperty (vtkTextProperty *tprop)
 Set the default text property for the strategy. More...
 
virtual vtkTextPropertyGetDefaultTextProperty ()
 
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...
 
- 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 vtkFreeTypeLabelRenderStrategySafeDownCast (vtkObjectBase *o)
 
static vtkFreeTypeLabelRenderStrategyNew ()
 
- Static Public Member Functions inherited from vtkLabelRenderStrategy
static vtkTypeBool 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 ()
 
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
 
 vtkFreeTypeLabelRenderStrategy ()
 
 ~vtkFreeTypeLabelRenderStrategy () override
 
- Protected Member Functions inherited from vtkLabelRenderStrategy
 vtkLabelRenderStrategy ()
 
 ~vtkLabelRenderStrategy () 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

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
std::atomic< int32_t > 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

◆ Superclass

Definition at line 38 of file vtkFreeTypeLabelRenderStrategy.h.

Constructor & Destructor Documentation

◆ vtkFreeTypeLabelRenderStrategy()

vtkFreeTypeLabelRenderStrategy::vtkFreeTypeLabelRenderStrategy ( )
protected

◆ ~vtkFreeTypeLabelRenderStrategy()

vtkFreeTypeLabelRenderStrategy::~vtkFreeTypeLabelRenderStrategy ( )
overrideprotected

Member Function Documentation

◆ PrintSelf()

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

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFreeTypeLabelRenderStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLabelRenderStrategy.

◆ NewInstance()

vtkFreeTypeLabelRenderStrategy* vtkFreeTypeLabelRenderStrategy::NewInstance ( ) const

◆ New()

static vtkFreeTypeLabelRenderStrategy* vtkFreeTypeLabelRenderStrategy::New ( )
static

◆ SupportsRotation()

bool vtkFreeTypeLabelRenderStrategy::SupportsRotation ( )
inlineoverridevirtual

The free type render strategy currently does not support rotation.

Reimplemented from vtkLabelRenderStrategy.

Definition at line 44 of file vtkFreeTypeLabelRenderStrategy.h.

◆ SupportsBoundedSize()

bool vtkFreeTypeLabelRenderStrategy::SupportsBoundedSize ( )
inlineoverridevirtual

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

Reimplemented from vtkLabelRenderStrategy.

Definition at line 49 of file vtkFreeTypeLabelRenderStrategy.h.

◆ ComputeLabelBounds() [1/2]

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

Compute the bounds of a label.

Must be performed after the renderer is set.

Reimplemented from vtkLabelRenderStrategy.

Definition at line 54 of file vtkFreeTypeLabelRenderStrategy.h.

◆ ComputeLabelBounds() [2/2]

void vtkFreeTypeLabelRenderStrategy::ComputeLabelBounds ( vtkTextProperty tprop,
vtkUnicodeString  label,
double  bds[4] 
)
overridevirtual

◆ RenderLabel() [1/4]

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

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.

◆ RenderLabel() [2/4]

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

Reimplemented from vtkLabelRenderStrategy.

Definition at line 68 of file vtkFreeTypeLabelRenderStrategy.h.

◆ RenderLabel() [3/4]

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

◆ RenderLabel() [4/4]

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

Definition at line 73 of file vtkFreeTypeLabelRenderStrategy.h.

◆ ReleaseGraphicsResources()

void vtkFreeTypeLabelRenderStrategy::ReleaseGraphicsResources ( vtkWindow window)
overridevirtual

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

◆ TextRenderer

vtkTextRenderer* vtkFreeTypeLabelRenderStrategy::TextRenderer
protected

Definition at line 89 of file vtkFreeTypeLabelRenderStrategy.h.

◆ Mapper

vtkTextMapper* vtkFreeTypeLabelRenderStrategy::Mapper
protected

Definition at line 90 of file vtkFreeTypeLabelRenderStrategy.h.

◆ Actor

vtkActor2D* vtkFreeTypeLabelRenderStrategy::Actor
protected

Definition at line 91 of file vtkFreeTypeLabelRenderStrategy.h.


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