Superclass for label rendering implementations. More...

#include <vtkLabelRenderStrategy.h>

Inheritance diagram for vtkLabelRenderStrategy:

Collaboration diagram for vtkLabelRenderStrategy:

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

vtkLabelRenderStrategy *	NewInstance () 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	ComputeLabelBounds (vtkTextProperty *tprop, vtkStdString label, double bds[4])=0
	Compute the bounds of a label. More...

virtual void	RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString label)=0
	Render a label at a location in display coordinates. More...

virtual void	RenderLabel (int x[2], vtkTextProperty *tprop, vtkStdString 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...


virtual void	SetRenderer (vtkRenderer *ren)
	Set the renderer associated with this strategy. More...

virtual vtkRenderer *	GetRenderer ()
	Set the renderer associated with this strategy. More...


virtual void	SetDefaultTextProperty (vtkTextProperty *tprop)
	Set the default text property for the strategy. More...

virtual vtkTextProperty *	GetDefaultTextProperty ()
	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 ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (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...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. 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...

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkLabelRenderStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 (vtkTypeBool 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 vtkTypeBool	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () 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 ()
	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
vtkRenderer *	Renderer

vtkTextProperty *	DefaultTextProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Superclass for label rendering implementations.

These methods should only be called within a mapper.

Definition at line 24 of file vtkLabelRenderStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkLabelRenderStrategy::Superclass

Definition at line 28 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

Reimplemented in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

◆ 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 35 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 44 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

Set the renderer associated with this strategy.

◆ SetDefaultTextProperty()

virtual void vtkLabelRenderStrategy::SetDefaultTextProperty ( vtkTextProperty * tprop )

virtual

Set the default text property for the strategy.

◆ GetDefaultTextProperty()

virtual vtkTextProperty* vtkLabelRenderStrategy::GetDefaultTextProperty ( )

virtual

Set the default text property for the strategy.

◆ ComputeLabelBounds()

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

pure virtual

Compute the bounds of a label.

Must be performed after the renderer is set.

Implemented in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

◆ RenderLabel() [1/2]

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

pure virtual

Render a label at a location in display coordinates.

Must be performed between StartFrame() and EndFrame() calls. 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.

Implemented in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

◆ RenderLabel() [2/2]

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

inlinevirtual

Definition at line 76 of file vtkLabelRenderStrategy.h.

◆ StartFrame()

virtual void vtkLabelRenderStrategy::StartFrame ( )

inlinevirtual

Start a rendering frame.

Renderer must be set.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 85 of file vtkLabelRenderStrategy.h.

◆ EndFrame()

virtual void vtkLabelRenderStrategy::EndFrame ( )

inlinevirtual

End a rendering frame.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 90 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 97 of file vtkLabelRenderStrategy.h.

Member Data Documentation

◆ Renderer

vtkRenderer* vtkLabelRenderStrategy::Renderer

protected

Definition at line 103 of file vtkLabelRenderStrategy.h.

◆ DefaultTextProperty

vtkTextProperty* vtkLabelRenderStrategy::DefaultTextProperty

protected

Definition at line 104 of file vtkLabelRenderStrategy.h.

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

Rendering/Label/vtkLabelRenderStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkLabelRenderStrategy()

◆ ~vtkLabelRenderStrategy()

Member Function Documentation

◆ PrintSelf()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ SupportsRotation()

◆ SupportsBoundedSize()

◆ SetRenderer()

◆ GetRenderer()

◆ SetDefaultTextProperty()

◆ GetDefaultTextProperty()

◆ ComputeLabelBounds()

◆ RenderLabel() [1/2]

◆ RenderLabel() [2/2]

◆ StartFrame()

◆ EndFrame()

◆ ReleaseGraphicsResources()

Member Data Documentation

◆ Renderer

◆ DefaultTextProperty