Places and renders non-overlapping labels. More...

#include <vtkLabelPlacementMapper.h>

Inheritance diagram for vtkLabelPlacementMapper:

Collaboration diagram for vtkLabelPlacementMapper:

Public Types
enum	LabelShape { NONE, RECT, ROUNDED_RECT, NUMBER_OF_LABEL_SHAPES }
enum	LabelStyle { FILLED, OUTLINE, NUMBER_OF_LABEL_STYLES }
typedef vtkMapper2D	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkLabelPlacementMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	RenderOverlay (vtkViewport viewport, vtkActor2D actor)

virtual void	SetRenderStrategy (vtkLabelRenderStrategy *s)
virtual vtkLabelRenderStrategy *	GetRenderStrategy ()

virtual void	SetMaximumLabelFraction (double)
virtual double	GetMaximumLabelFraction ()

virtual void	SetIteratorType (int)
virtual int	GetIteratorType ()

virtual void	SetUseUnicodeStrings (bool)
virtual bool	GetUseUnicodeStrings ()
virtual void	UseUnicodeStringsOn ()
virtual void	UseUnicodeStringsOff ()

virtual bool	GetPositionsAsNormals ()
virtual void	SetPositionsAsNormals (bool)
virtual void	PositionsAsNormalsOn ()
virtual void	PositionsAsNormalsOff ()

virtual bool	GetGeneratePerturbedLabelSpokes ()
virtual void	SetGeneratePerturbedLabelSpokes (bool)
virtual void	GeneratePerturbedLabelSpokesOn ()
virtual void	GeneratePerturbedLabelSpokesOff ()

virtual bool	GetUseDepthBuffer ()
virtual void	SetUseDepthBuffer (bool)
virtual void	UseDepthBufferOn ()
virtual void	UseDepthBufferOff ()

virtual void	SetPlaceAllLabels (bool)
virtual bool	GetPlaceAllLabels ()
virtual void	PlaceAllLabelsOn ()
virtual void	PlaceAllLabelsOff ()

virtual void	SetOutputTraversedBounds (bool)
virtual bool	GetOutputTraversedBounds ()
virtual void	OutputTraversedBoundsOn ()
virtual void	OutputTraversedBoundsOff ()

virtual void	SetShape (int)
virtual int	GetShape ()
virtual void	SetShapeToNone ()
virtual void	SetShapeToRect ()
virtual void	SetShapeToRoundedRect ()

virtual void	SetStyle (int)
virtual int	GetStyle ()
virtual void	SetStyleToFilled ()
virtual void	SetStyleToOutline ()

virtual void	SetMargin (double)
virtual double	GetMargin ()

virtual void	SetBackgroundColor (double, double, double)
virtual void	SetBackgroundColor (double[3])
virtual double *	GetBackgroundColor ()
virtual void	GetBackgroundColor (double &, double &, double &)
virtual void	GetBackgroundColor (double[3])

virtual void	SetBackgroundOpacity (double)
virtual double	GetBackgroundOpacity ()

virtual vtkCoordinate *	GetAnchorTransform ()
Static Public Member Functions
static vtkLabelPlacementMapper *	New ()
static int	IsTypeOf (const char *type)
static vtkLabelPlacementMapper *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLabelPlacementMapper ()
	~vtkLabelPlacementMapper ()
virtual void	SetAnchorTransform (vtkCoordinate *)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
Internal *	Buckets
vtkLabelRenderStrategy *	RenderStrategy
vtkCoordinate *	AnchorTransform
vtkSelectVisiblePoints *	VisiblePoints
double	MaximumLabelFraction
bool	PositionsAsNormals
bool	GeneratePerturbedLabelSpokes
bool	UseDepthBuffer
bool	UseUnicodeStrings
bool	PlaceAllLabels
bool	OutputTraversedBounds
int	LastRendererSize [2]
double	LastCameraPosition [3]
double	LastCameraFocalPoint [3]
double	LastCameraViewUp [3]
double	LastCameraParallelScale
int	IteratorType
int	Style
int	Shape
double	Margin
double	BackgroundOpacity
double	BackgroundColor [3]

Detailed Description

Places and renders non-overlapping labels.

To use this mapper, first send your data through vtkPointSetToLabelHierarchy, which takes a set of points, associates special arrays to the points (label, priority, etc.), and produces a prioritized spatial tree of labels.

This mapper then takes that hierarchy (or hierarchies) as input, and every frame will decide which labels and/or icons to place in order of priority, and will render only those labels/icons. A label render strategy is used to render the labels, and can use e.g. FreeType or Qt for rendering.

Examples:: vtkLabelPlacementMapper (Examples)

Tests:: vtkLabelPlacementMapper (Tests)

Definition at line 50 of file vtkLabelPlacementMapper.h.

Member Typedef Documentation

typedef vtkMapper2D vtkLabelPlacementMapper::Superclass

Reimplemented from vtkMapper2D.

Definition at line 54 of file vtkLabelPlacementMapper.h.

Member Enumeration Documentation

enum vtkLabelPlacementMapper::LabelShape

Enumerator:

NONE
RECT
ROUNDED_RECT
NUMBER_OF_LABEL_SHAPES

Definition at line 130 of file vtkLabelPlacementMapper.h.

enum vtkLabelPlacementMapper::LabelStyle

Enumerator:

FILLED
OUTLINE
NUMBER_OF_LABEL_STYLES

Definition at line 152 of file vtkLabelPlacementMapper.h.

Constructor & Destructor Documentation

vtkLabelPlacementMapper::vtkLabelPlacementMapper ( ) [protected]

vtkLabelPlacementMapper::~vtkLabelPlacementMapper ( ) [protected]

Member Function Documentation

static vtkLabelPlacementMapper* vtkLabelPlacementMapper::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

static int vtkLabelPlacementMapper::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 vtkMapper2D.

virtual int vtkLabelPlacementMapper::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 vtkMapper2D.

static vtkLabelPlacementMapper* vtkLabelPlacementMapper::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkMapper2D.

virtual vtkObjectBase* vtkLabelPlacementMapper::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkMapper2D.

vtkLabelPlacementMapper* vtkLabelPlacementMapper::NewInstance ( ) const

Reimplemented from vtkMapper2D.

void vtkLabelPlacementMapper::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 vtkMapper2D.

void vtkLabelPlacementMapper::RenderOverlay	(	vtkViewport *	viewport,
		vtkActor2D *	actor
	)		`[virtual]`

Draw non-overlapping labels to the screen.

Reimplemented from vtkMapper2D.

virtual void vtkLabelPlacementMapper::SetRenderStrategy ( vtkLabelRenderStrategy * s ) [virtual]

Set the label rendering strategy.

virtual vtkLabelRenderStrategy* vtkLabelPlacementMapper::GetRenderStrategy ( ) [virtual]

Set the label rendering strategy.

virtual void vtkLabelPlacementMapper::SetMaximumLabelFraction ( double ) [virtual]

The maximum fraction of the screen that the labels may cover. Label placement stops when this fraction is reached.

virtual double vtkLabelPlacementMapper::GetMaximumLabelFraction ( ) [virtual]

The maximum fraction of the screen that the labels may cover. Label placement stops when this fraction is reached.

virtual void vtkLabelPlacementMapper::SetIteratorType ( int ) [virtual]

The type of iterator used when traversing the labels. May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT

virtual int vtkLabelPlacementMapper::GetIteratorType ( ) [virtual]

The type of iterator used when traversing the labels. May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT

virtual void vtkLabelPlacementMapper::SetUseUnicodeStrings ( bool ) [virtual]

Set whether, or not, to use unicode strings.

virtual bool vtkLabelPlacementMapper::GetUseUnicodeStrings ( ) [virtual]

Set whether, or not, to use unicode strings.

virtual void vtkLabelPlacementMapper::UseUnicodeStringsOn ( ) [virtual]

Set whether, or not, to use unicode strings.

virtual void vtkLabelPlacementMapper::UseUnicodeStringsOff ( ) [virtual]

Set whether, or not, to use unicode strings.

virtual bool vtkLabelPlacementMapper::GetPositionsAsNormals ( ) [virtual]

Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default.

virtual void vtkLabelPlacementMapper::SetPositionsAsNormals ( bool ) [virtual]

Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default.

virtual void vtkLabelPlacementMapper::PositionsAsNormalsOn ( ) [virtual]

Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default.

virtual void vtkLabelPlacementMapper::PositionsAsNormalsOff ( ) [virtual]

Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default.

virtual bool vtkLabelPlacementMapper::GetGeneratePerturbedLabelSpokes ( ) [virtual]

Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates.

virtual void vtkLabelPlacementMapper::SetGeneratePerturbedLabelSpokes ( bool ) [virtual]

Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates.

virtual void vtkLabelPlacementMapper::GeneratePerturbedLabelSpokesOn ( ) [virtual]

Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates.

virtual void vtkLabelPlacementMapper::GeneratePerturbedLabelSpokesOff ( ) [virtual]

Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates.

virtual bool vtkLabelPlacementMapper::GetUseDepthBuffer ( ) [virtual]

Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default.

virtual void vtkLabelPlacementMapper::SetUseDepthBuffer ( bool ) [virtual]

Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default.

virtual void vtkLabelPlacementMapper::UseDepthBufferOn ( ) [virtual]

Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default.

virtual void vtkLabelPlacementMapper::UseDepthBufferOff ( ) [virtual]

Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default.

virtual void vtkLabelPlacementMapper::SetPlaceAllLabels ( bool ) [virtual]

Tells the placer to place every label regardless of overlap. Off by default.

virtual bool vtkLabelPlacementMapper::GetPlaceAllLabels ( ) [virtual]

Tells the placer to place every label regardless of overlap. Off by default.

virtual void vtkLabelPlacementMapper::PlaceAllLabelsOn ( ) [virtual]

Tells the placer to place every label regardless of overlap. Off by default.

virtual void vtkLabelPlacementMapper::PlaceAllLabelsOff ( ) [virtual]

Tells the placer to place every label regardless of overlap. Off by default.

virtual void vtkLabelPlacementMapper::SetOutputTraversedBounds ( bool ) [virtual]

Whether to render traversed bounds. Off by default.

virtual bool vtkLabelPlacementMapper::GetOutputTraversedBounds ( ) [virtual]

Whether to render traversed bounds. Off by default.

virtual void vtkLabelPlacementMapper::OutputTraversedBoundsOn ( ) [virtual]

Whether to render traversed bounds. Off by default.

virtual void vtkLabelPlacementMapper::OutputTraversedBoundsOff ( ) [virtual]

Whether to render traversed bounds. Off by default.

virtual void vtkLabelPlacementMapper::SetShape ( int ) [virtual]