vtkLabelPlacementMapper Class Reference

#include <vtkLabelPlacementMapper.h>

Inheritance diagram for vtkLabelPlacementMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkLabelPlacementMapper:

Collaboration graph
[legend]

List of all members.


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 49 of file vtkLabelPlacementMapper.h.


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 const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void RenderOverlay (vtkViewport *viewport, vtkActor2D *actor)
virtual void SetRenderStrategy (vtkLabelRenderStrategy *s)
virtual vtkLabelRenderStrategyGetRenderStrategy ()
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 vtkCoordinateGetAnchorTransform ()

Static Public Member Functions

static vtkLabelPlacementMapperNew ()
static int IsTypeOf (const char *type)
static vtkLabelPlacementMapperSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkLabelPlacementMapper ()
 ~vtkLabelPlacementMapper ()
virtual void SetAnchorTransform (vtkCoordinate *)
virtual int FillInputPortInformation (int port, vtkInformation *info)

Protected Attributes

Internal * Buckets
vtkLabelRenderStrategyRenderStrategy
vtkCoordinateAnchorTransform
vtkSelectVisiblePointsVisiblePoints
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]

Member Typedef Documentation

Reimplemented from vtkMapper2D.

Definition at line 53 of file vtkLabelPlacementMapper.h.


Member Enumeration Documentation

Enumerator:
NONE 
RECT 
ROUNDED_RECT 
NUMBER_OF_LABEL_SHAPES 

Definition at line 129 of file vtkLabelPlacementMapper.h.

Enumerator:
FILLED 
OUTLINE 
NUMBER_OF_LABEL_STYLES 

Definition at line 151 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.

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

Reimplemented from vtkMapper2D.

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 ( vtkObject o  )  [static]

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]

The shape of the label background, should be one of the values in the LabelShape enumeration.

virtual int vtkLabelPlacementMapper::GetShape (  )  [virtual]

The shape of the label background, should be one of the values in the LabelShape enumeration.

virtual void vtkLabelPlacementMapper::SetShapeToNone (  )  [inline, virtual]

The shape of the label background, should be one of the values in the LabelShape enumeration.

Definition at line 142 of file vtkLabelPlacementMapper.h.

virtual void vtkLabelPlacementMapper::SetShapeToRect (  )  [inline, virtual]

The shape of the label background, should be one of the values in the LabelShape enumeration.

Definition at line 144 of file vtkLabelPlacementMapper.h.

virtual void vtkLabelPlacementMapper::SetShapeToRoundedRect (  )  [inline, virtual]

The shape of the label background, should be one of the values in the LabelShape enumeration.

Definition at line 146 of file vtkLabelPlacementMapper.h.

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

The style of the label background shape, should be one of the values in the LabelStyle enumeration.

virtual int vtkLabelPlacementMapper::GetStyle (  )  [virtual]

The style of the label background shape, should be one of the values in the LabelStyle enumeration.

virtual void vtkLabelPlacementMapper::SetStyleToFilled (  )  [inline, virtual]

The style of the label background shape, should be one of the values in the LabelStyle enumeration.

Definition at line 163 of file vtkLabelPlacementMapper.h.

virtual void vtkLabelPlacementMapper::SetStyleToOutline (  )  [inline, virtual]

The style of the label background shape, should be one of the values in the LabelStyle enumeration.

Definition at line 165 of file vtkLabelPlacementMapper.h.

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

The size of the margin on the label background shape. Default is 5.

virtual double vtkLabelPlacementMapper::GetMargin (  )  [virtual]

The size of the margin on the label background shape. Default is 5.

virtual void vtkLabelPlacementMapper::SetBackgroundColor ( double  ,
double  ,
double   
) [virtual]

The color of the background shape.

virtual void vtkLabelPlacementMapper::SetBackgroundColor ( double  [3]  )  [virtual]

The color of the background shape.

virtual double* vtkLabelPlacementMapper::GetBackgroundColor (  )  [virtual]

The color of the background shape.

virtual void vtkLabelPlacementMapper::GetBackgroundColor ( double &  ,
double &  ,
double &   
) [virtual]

The color of the background shape.

virtual void vtkLabelPlacementMapper::GetBackgroundColor ( double  [3]  )  [virtual]

The color of the background shape.

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

The opacity of the background shape.

virtual double vtkLabelPlacementMapper::GetBackgroundOpacity (  )  [virtual]

The opacity of the background shape.

virtual vtkCoordinate* vtkLabelPlacementMapper::GetAnchorTransform (  )  [virtual]

Get the transform for the anchor points.

virtual void vtkLabelPlacementMapper::SetAnchorTransform ( vtkCoordinate  )  [protected, virtual]

virtual int vtkLabelPlacementMapper::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.


Member Data Documentation

Internal* vtkLabelPlacementMapper::Buckets [protected]

Definition at line 201 of file vtkLabelPlacementMapper.h.

Definition at line 205 of file vtkLabelPlacementMapper.h.

Definition at line 206 of file vtkLabelPlacementMapper.h.

Definition at line 207 of file vtkLabelPlacementMapper.h.

Definition at line 208 of file vtkLabelPlacementMapper.h.

Definition at line 209 of file vtkLabelPlacementMapper.h.

Definition at line 210 of file vtkLabelPlacementMapper.h.

Definition at line 211 of file vtkLabelPlacementMapper.h.

Definition at line 212 of file vtkLabelPlacementMapper.h.

Definition at line 213 of file vtkLabelPlacementMapper.h.

Definition at line 214 of file vtkLabelPlacementMapper.h.

Definition at line 216 of file vtkLabelPlacementMapper.h.

Definition at line 217 of file vtkLabelPlacementMapper.h.

Definition at line 218 of file vtkLabelPlacementMapper.h.

Definition at line 219 of file vtkLabelPlacementMapper.h.

Definition at line 220 of file vtkLabelPlacementMapper.h.

Definition at line 221 of file vtkLabelPlacementMapper.h.

Definition at line 223 of file vtkLabelPlacementMapper.h.

Definition at line 224 of file vtkLabelPlacementMapper.h.

double vtkLabelPlacementMapper::Margin [protected]

Definition at line 225 of file vtkLabelPlacementMapper.h.

Definition at line 226 of file vtkLabelPlacementMapper.h.

Definition at line 227 of file vtkLabelPlacementMapper.h.


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

Generated on Wed Aug 24 11:45:14 2011 for VTK by  doxygen 1.5.6