Superclass for label rendering implementations. More...

#include <vtkLabelRenderStrategy.h>

Inheritance diagram for vtkLabelRenderStrategy:

Collaboration diagram for vtkLabelRenderStrategy:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	IsA (const char *type)

vtkLabelRenderStrategy *	NewInstance () const

virtual void	StartFrame ()

virtual void	EndFrame ()

virtual void	ReleaseGraphicsResources (vtkWindow *)


virtual bool	SupportsRotation ()


virtual bool	SupportsBoundedSize ()


virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderer *	GetRenderer ()


virtual void	SetDefaultTextProperty (vtkTextProperty *tprop)

virtual vtkTextProperty *	GetDefaultTextProperty ()


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

virtual void	ComputeLabelBounds (vtkTextProperty *tprop, vtkUnicodeString label, double bds[4])=0


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

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

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 vtkLabelRenderStrategy *	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

	vtkLabelRenderStrategy ()

	~vtkLabelRenderStrategy ()

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
vtkRenderer *	Renderer

vtkTextProperty *	DefaultTextProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Superclass for label rendering implementations.

These methods should only be called within a mapper.

Definition at line 35 of file vtkLabelRenderStrategy.h.

Member Typedef Documentation

typedef vtkObject vtkLabelRenderStrategy::Superclass

Definition at line 39 of file vtkLabelRenderStrategy.h.

Constructor & Destructor Documentation

vtkLabelRenderStrategy::vtkLabelRenderStrategy ( )

protected

vtkLabelRenderStrategy::~vtkLabelRenderStrategy ( )

protected

Member Function Documentation

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

Reimplemented in vtkQtLabelRenderStrategy.

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

static

virtual int 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 vtkObject.

Reimplemented in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

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

static

virtual vtkObjectBase* vtkLabelRenderStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

vtkLabelRenderStrategy* vtkLabelRenderStrategy::NewInstance ( ) const

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 45 of file vtkLabelRenderStrategy.h.

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 55 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::SetRenderer ( vtkRenderer * ren )

virtual

Set the renderer associated with this strategy.

virtual vtkRenderer* vtkLabelRenderStrategy::GetRenderer ( )

virtual

Set the renderer associated with this strategy.

virtual void vtkLabelRenderStrategy::SetDefaultTextProperty ( vtkTextProperty * tprop )

virtual

Set the default text property for the strategy.

virtual vtkTextProperty* vtkLabelRenderStrategy::GetDefaultTextProperty ( )

virtual

Set the default text property for the strategy.

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 75 of file vtkLabelRenderStrategy.h.

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

pure virtual

Compute the bounds of a label. Must be performed after the renderer is set. Only the unicode string version must be implemented in subclasses.

Implemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

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

Definition at line 91 of file vtkLabelRenderStrategy.h.

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

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

Definition at line 93 of file vtkLabelRenderStrategy.h.

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

pure virtual

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.

Implemented in vtkQtLabelRenderStrategy, and vtkFreeTypeLabelRenderStrategy.

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

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.

Definition at line 98 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::StartFrame ( )

inlinevirtual

Start a rendering frame. Renderer must be set.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 104 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::EndFrame ( )

inlinevirtual

End a rendering frame.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 107 of file vtkLabelRenderStrategy.h.

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 112 of file vtkLabelRenderStrategy.h.

Member Data Documentation

vtkRenderer* vtkLabelRenderStrategy::Renderer

protected

Definition at line 118 of file vtkLabelRenderStrategy.h.

vtkTextProperty* vtkLabelRenderStrategy::DefaultTextProperty

protected

Definition at line 119 of file vtkLabelRenderStrategy.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Label/vtkLabelRenderStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation