vtkDynamic2DLabelMapper Class Reference
#include <vtkDynamic2DLabelMapper.h>
Detailed Description
draw text labels at 2D dataset pointsvtkDynamic2DLabelMapper is a mapper that renders text at dataset points such that the labels do not overlap. Various items can be labeled including point ids, scalars, vectors, normals, texture coordinates, tensors, and field data components. This mapper assumes that the points are located on the x-y plane and that the camera remains perpendicular to that plane with a y-up axis (this can be constrained using vtkImageInteractor). On the first render, the mapper computes the visiblility of all labels at all scales, and queries this information on successive renders. This causes the first render to be much slower. The visibility algorithm is a greedy approach based on the point id, so the label for a point will be drawn unless the label for a point with lower id overlaps it.
- Warning:
- Use this filter in combination with vtkSelectVisiblePoints if you want to label only points that are visible. If you want to label cells rather than points, use the filter vtkCellCenters to generate points at the center of the cells. Also, you can use the class vtkIdFilter to generate ids as scalars or field data, which can then be labeled.
- See also:
- vtkLabeledDataMapper
- Thanks:
- This algorithm was developed in the paper Ken Been and Chee Yap. Dynamic Map Labeling. IEEE Transactions on Visualization and Computer Graphics, Vol. 12, No. 5, 2006. pp. 773-780.
- Events:
- vtkCommand::ProgressEvent
Definition at line 63 of file vtkDynamic2DLabelMapper.h.
Member Typedef Documentation
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
Definition at line 70 of file vtkDynamic2DLabelMapper.h.
Constructor & Destructor Documentation
| vtkDynamic2DLabelMapper::vtkDynamic2DLabelMapper | ( | ) | [protected] |
| vtkDynamic2DLabelMapper::~vtkDynamic2DLabelMapper | ( | ) | [protected] |
Member Function Documentation
| static vtkDynamic2DLabelMapper* vtkDynamic2DLabelMapper::New | ( | ) | [static] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
| virtual const char* vtkDynamic2DLabelMapper::GetClassName | ( | ) | [virtual] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
| static int vtkDynamic2DLabelMapper::IsTypeOf | ( | const char * | type | ) | [static] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
| virtual int vtkDynamic2DLabelMapper::IsA | ( | const char * | type | ) | [virtual] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
| static vtkDynamic2DLabelMapper* vtkDynamic2DLabelMapper::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
| void vtkDynamic2DLabelMapper::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkLabeledDataMapper.
| void vtkDynamic2DLabelMapper::SetPriorityArrayName | ( | const char * | name | ) |
Set the points array name to use to give priority to labels. Defaults to "priority".
| virtual void vtkDynamic2DLabelMapper::SetReversePriority | ( | bool | ) | [virtual] |
Whether to reverse the priority order (i.e. low values have high priority). Default is off.
| virtual bool vtkDynamic2DLabelMapper::GetReversePriority | ( | ) | [virtual] |
Whether to reverse the priority order (i.e. low values have high priority). Default is off.
| virtual void vtkDynamic2DLabelMapper::ReversePriorityOn | ( | ) | [virtual] |
Whether to reverse the priority order (i.e. low values have high priority). Default is off.
| virtual void vtkDynamic2DLabelMapper::ReversePriorityOff | ( | ) | [virtual] |
Whether to reverse the priority order (i.e. low values have high priority). Default is off.
| virtual void vtkDynamic2DLabelMapper::SetLabelHeightPadding | ( | float | ) | [virtual] |
Set the label height padding as a percentage. The percentage is a percentage of your label height. Default is 50%.
| virtual float vtkDynamic2DLabelMapper::GetLabelHeightPadding | ( | ) | [virtual] |
Set the label height padding as a percentage. The percentage is a percentage of your label height. Default is 50%.
| virtual void vtkDynamic2DLabelMapper::SetLabelWidthPadding | ( | float | ) | [virtual] |
Set the label width padding as a percentage. The percentage is a percentage of your label ^height^ (yes, not a typo). Default is 50%.
| virtual float vtkDynamic2DLabelMapper::GetLabelWidthPadding | ( | ) | [virtual] |
Set the label width padding as a percentage. The percentage is a percentage of your label ^height^ (yes, not a typo). Default is 50%.
| void vtkDynamic2DLabelMapper::RenderOpaqueGeometry | ( | vtkViewport * | viewport, | |
| vtkActor2D * | actor | |||
| ) | [virtual] |
Draw non-overlapping labels to the screen.
Reimplemented from vtkLabeledDataMapper.
| void vtkDynamic2DLabelMapper::RenderOverlay | ( | vtkViewport * | viewport, | |
| vtkActor2D * | actor | |||
| ) | [virtual] |
Draw non-overlapping labels to the screen.
Reimplemented from vtkLabeledDataMapper.
| double vtkDynamic2DLabelMapper::GetCurrentScale | ( | vtkViewport * | viewport | ) | [protected] |
Calculate the current zoom scale of the viewport.
Member Data Documentation
float* vtkDynamic2DLabelMapper::LabelWidth [protected] |
Definition at line 113 of file vtkDynamic2DLabelMapper.h.
float* vtkDynamic2DLabelMapper::LabelHeight [protected] |
Definition at line 114 of file vtkDynamic2DLabelMapper.h.
float* vtkDynamic2DLabelMapper::Cutoff [protected] |
Definition at line 115 of file vtkDynamic2DLabelMapper.h.
float vtkDynamic2DLabelMapper::ReferenceScale [protected] |
Definition at line 116 of file vtkDynamic2DLabelMapper.h.
float vtkDynamic2DLabelMapper::LabelHeightPadding [protected] |
Definition at line 117 of file vtkDynamic2DLabelMapper.h.
float vtkDynamic2DLabelMapper::LabelWidthPadding [protected] |
Definition at line 118 of file vtkDynamic2DLabelMapper.h.
bool vtkDynamic2DLabelMapper::ReversePriority [protected] |
Definition at line 120 of file vtkDynamic2DLabelMapper.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkDynamic2DLabelMapper.h
