vtkLabelRenderStrategy Class Reference

#include <vtkLabelRenderStrategy.h>

Inheritance diagram for vtkLabelRenderStrategy:

[legend]

Collaboration diagram for vtkLabelRenderStrategy:

[legend]

List of all members.

Detailed Description

Superclass for label rendering implementations.

These methods should only be called within a mapper.

Definition at line 34 of file vtkLabelRenderStrategy.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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))
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkLabelRenderStrategy *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkLabelRenderStrategy ()
	~vtkLabelRenderStrategy ()
Protected Attributes
vtkRenderer *	Renderer
vtkTextProperty *	DefaultTextProperty

Member Typedef Documentation

typedef vtkObject vtkLabelRenderStrategy::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 38 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 vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

virtual const char* vtkLabelRenderStrategy::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

static int vtkLabelRenderStrategy::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

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

static vtkLabelRenderStrategy* vtkLabelRenderStrategy::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

virtual bool vtkLabelRenderStrategy::SupportsRotation ( ) [inline, virtual]

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

virtual bool vtkLabelRenderStrategy::SupportsBoundedSize ( ) [inline, virtual]

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 54 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]
	)			`[inline, 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.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 74 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
	)			`[inline, 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.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 90 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::RenderLabel	(	int	x[2],
		vtkTextProperty *	tprop,
		vtkStdString	label,
		int	maxWidth
	)			`[inline, 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.

Reimplemented in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 92 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 vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

virtual void vtkLabelRenderStrategy::RenderLabel	(	int	x[2],
		vtkTextProperty *	tprop,
		vtkUnicodeString	label,
		int	vtkNotUsedmaxWidth
	)			`[inline, 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.

Definition at line 97 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::StartFrame ( ) [inline, virtual]

Start a rendering frame. Renderer must be set.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 103 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::EndFrame ( ) [inline, virtual]

End a rendering frame.

Reimplemented in vtkQtLabelRenderStrategy.

Definition at line 106 of file vtkLabelRenderStrategy.h.

virtual void vtkLabelRenderStrategy::ReleaseGraphicsResources ( vtkWindow * ) [inline, 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 in vtkFreeTypeLabelRenderStrategy, and vtkQtLabelRenderStrategy.

Definition at line 111 of file vtkLabelRenderStrategy.h.