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

Superclass for label rendering implementations. More...

#include <vtkLabelRenderStrategy.h>

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

Public Types

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...
 
vtkLabelRenderStrategyNewInstance () const
 
virtual bool SupportsRotation ()
 Whether the text rendering strategy supports rotation. More...
 
virtual bool SupportsBoundedSize ()
 Whether the text rendering strategy supports bounded size. More...
 
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 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])=0
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label)
 Render a label at a location in display coordinates. More...
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label, int maxWidth)
 
virtual void RenderLabel (int x[2], vtkTextProperty *tprop, vtkUnicodeString label)=0
 
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 ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this 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...
 
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 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
 
 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

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

Superclass for label rendering implementations.

These methods should only be called within a mapper.

Definition at line 36 of file vtkLabelRenderStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkLabelRenderStrategy.h.

Constructor & Destructor Documentation

◆ vtkLabelRenderStrategy()

vtkLabelRenderStrategy::vtkLabelRenderStrategy ( )
protected

◆ ~vtkLabelRenderStrategy()

vtkLabelRenderStrategy::~vtkLabelRenderStrategy ( )
overrideprotected

Member Function Documentation

◆ PrintSelf()

void vtkLabelRenderStrategy::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 vtkQtLabelRenderStrategy.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLabelRenderStrategy::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 vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLabelRenderStrategy::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkLabelRenderStrategy* vtkLabelRenderStrategy::NewInstance ( ) const

◆ SupportsRotation()

virtual bool vtkLabelRenderStrategy::SupportsRotation ( )
inlinevirtual

Whether the text rendering strategy supports rotation.

The superclass returns true. Subclasses should override this to return the appropriate value.

Reimplemented in vtkFreeTypeLabelRenderStrategy.

Definition at line 47 of file vtkLabelRenderStrategy.h.

◆ SupportsBoundedSize()

virtual bool vtkLabelRenderStrategy::SupportsBoundedSize ( )
inlinevirtual

Whether the text rendering strategy supports bounded size.

The superclass returns true. Subclasses should override this to return the appropriate value. Subclasses that return true from this method should implement the version of RenderLabel() that takes a maximum size (see RenderLabel()).

Reimplemented in vtkFreeTypeLabelRenderStrategy.

Definition at line 56 of file vtkLabelRenderStrategy.h.

◆ SetRenderer()

virtual void vtkLabelRenderStrategy::SetRenderer ( vtkRenderer ren)
virtual

Set the renderer associated with this strategy.

◆ GetRenderer()

virtual vtkRenderer* vtkLabelRenderStrategy::GetRenderer ( )
virtual

◆ SetDefaultTextProperty()

virtual void vtkLabelRenderStrategy::SetDefaultTextProperty ( vtkTextProperty tprop)
virtual

Set the default text property for the strategy.

◆ GetDefaultTextProperty()

virtual vtkTextProperty* vtkLabelRenderStrategy::GetDefaultTextProperty ( )
virtual

◆ ComputeLabelBounds() [1/2]

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

Compute the bounds of a label.

Must be performed after the renderer is set. Only the unicode string version must be implemented in subclasses.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 78 of file vtkLabelRenderStrategy.h.

◆ ComputeLabelBounds() [2/2]

virtual void vtkLabelRenderStrategy::ComputeLabelBounds ( vtkTextProperty tprop,
vtkUnicodeString  label,
double  bds[4] 
)
pure virtual

◆ RenderLabel() [1/4]

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

Render a label at a location in display coordinates.

Must be performed between StartFrame() and EndFrame() calls. Only the unicode string version must be implemented in subclasses. The optional final parameter maxWidth specifies a maximum width for the label. Longer labels can be shorted with an ellipsis (...). Only renderer strategies that return true from SupportsBoundedSize must implement this version of th method.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 94 of file vtkLabelRenderStrategy.h.

◆ RenderLabel() [2/4]

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

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 98 of file vtkLabelRenderStrategy.h.

◆ RenderLabel() [3/4]

virtual void vtkLabelRenderStrategy::RenderLabel ( int  x[2],
vtkTextProperty tprop,
vtkUnicodeString  label 
)
pure virtual

◆ RenderLabel() [4/4]

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

Definition at line 103 of file vtkLabelRenderStrategy.h.

◆ StartFrame()

virtual void vtkLabelRenderStrategy::StartFrame ( )
inlinevirtual

Start a rendering frame.

Renderer must be set.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 112 of file vtkLabelRenderStrategy.h.

◆ EndFrame()

virtual void vtkLabelRenderStrategy::EndFrame ( )
inlinevirtual

End a rendering frame.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 117 of file vtkLabelRenderStrategy.h.

◆ ReleaseGraphicsResources()

virtual void vtkLabelRenderStrategy::ReleaseGraphicsResources ( vtkWindow )
inlinevirtual

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 in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

Definition at line 124 of file vtkLabelRenderStrategy.h.

Member Data Documentation

◆ Renderer

vtkRenderer* vtkLabelRenderStrategy::Renderer
protected

Definition at line 130 of file vtkLabelRenderStrategy.h.

◆ DefaultTextProperty

vtkTextProperty* vtkLabelRenderStrategy::DefaultTextProperty
protected

Definition at line 131 of file vtkLabelRenderStrategy.h.


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