VTK  9.2.6
vtkLabeledDataMapper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLabeledDataMapper.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
48#ifndef vtkLabeledDataMapper_h
49#define vtkLabeledDataMapper_h
50
51#include "vtkMapper2D.h"
52#include "vtkRenderingLabelModule.h" // For export macro
53
54#include <cassert> // For assert macro
55
56class vtkDataObject;
57class vtkDataSet;
58class vtkTextMapper;
59class vtkTextProperty;
60class vtkTransform;
61
62#define VTK_LABEL_IDS 0
63#define VTK_LABEL_SCALARS 1
64#define VTK_LABEL_VECTORS 2
65#define VTK_LABEL_NORMALS 3
66#define VTK_LABEL_TCOORDS 4
67#define VTK_LABEL_TENSORS 5
68#define VTK_LABEL_FIELD_DATA 6
69
70class VTKRENDERINGLABEL_EXPORT vtkLabeledDataMapper : public vtkMapper2D
71{
72public:
78
80 void PrintSelf(ostream& os, vtkIndent indent) override;
81
83
95 vtkSetStringMacro(LabelFormat);
96 vtkGetStringMacro(LabelFormat);
98
100
107 vtkSetMacro(LabeledComponent, int);
108 vtkGetMacro(LabeledComponent, int);
110
112
115 vtkSetMacro(ComponentSeparator, char);
116 vtkGetMacro(ComponentSeparator, char);
118
120
125 void SetFieldDataArray(int arrayIndex);
126 vtkGetMacro(FieldDataArray, int);
128
130
135 void SetFieldDataName(const char* arrayName);
136 vtkGetStringMacro(FieldDataName);
138
143
149
151
157 vtkSetMacro(LabelMode, int);
158 vtkGetMacro(LabelMode, int);
159 void SetLabelModeToLabelIds() { this->SetLabelMode(VTK_LABEL_IDS); }
160 void SetLabelModeToLabelScalars() { this->SetLabelMode(VTK_LABEL_SCALARS); }
161 void SetLabelModeToLabelVectors() { this->SetLabelMode(VTK_LABEL_VECTORS); }
162 void SetLabelModeToLabelNormals() { this->SetLabelMode(VTK_LABEL_NORMALS); }
163 void SetLabelModeToLabelTCoords() { this->SetLabelMode(VTK_LABEL_TCOORDS); }
164 void SetLabelModeToLabelTensors() { this->SetLabelMode(VTK_LABEL_TENSORS); }
167
169
177 virtual void SetLabelTextProperty(vtkTextProperty* p, int type);
180
182
185 void RenderOpaqueGeometry(vtkViewport* viewport, vtkActor2D* actor) override;
186 void RenderOverlay(vtkViewport* viewport, vtkActor2D* actor) override;
188
193
195
198 vtkGetObjectMacro(Transform, vtkTransform);
201
204 {
205 WORLD = 0,
206 DISPLAY = 1
208 };
209
211
215 vtkGetMacro(CoordinateSystem, int);
216 vtkSetClampMacro(CoordinateSystem, int, WORLD, DISPLAY);
217 void CoordinateSystemWorld() { this->SetCoordinateSystem(vtkLabeledDataMapper::WORLD); }
218 void CoordinateSystemDisplay() { this->SetCoordinateSystem(vtkLabeledDataMapper::DISPLAY); }
220
225
227
230 vtkGetMacro(NumberOfLabels, int);
232
234
237 void GetLabelPosition(int label, double pos[3])
238 {
239 assert("label index range" && label >= 0 && label < this->NumberOfLabels);
240 pos[0] = this->LabelPositions[3 * label];
241 pos[1] = this->LabelPositions[3 * label + 1];
242 pos[2] = this->LabelPositions[3 * label + 2];
243 }
245
249 const char* GetLabelText(int label);
250
251protected:
254
256
263
265
267
273
275
276 void AllocateLabels(int numLabels);
279
280 class Internals;
281 Internals* Implementation;
282
283private:
285 void operator=(const vtkLabeledDataMapper&) = delete;
286};
287
288#endif
a actor that draws 2D data
Definition vtkActor2D.h:40
general representation of visualization data
abstract class to specify dataset behavior
Definition vtkDataSet.h:57
a simple class to control print indentation
Definition vtkIndent.h:34
Store vtkAlgorithm input/output information.
draw text labels at dataset points
void SetFieldDataName(const char *arrayName)
Set/Get the name of the field data array to label.
virtual void SetLabelTextProperty(vtkTextProperty *p, int type)
Set/Get the text property.
void RenderOpaqueGeometry(vtkViewport *viewport, vtkActor2D *actor) override
Draw the text to the screen at each input point.
void CoordinateSystemWorld()
Set/get the coordinate system used for output labels.
void SetLabelModeToLabelIds()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
virtual void SetInputData(vtkDataObject *)
Set the input dataset to the mapper.
void SetLabelModeToLabelVectors()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
void SetLabelModeToLabelNormals()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
void SetLabelModeToLabelTensors()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
virtual vtkTextProperty * GetLabelTextProperty()
Set/Get the text property.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
void AllocateLabels(int numLabels)
virtual void SetLabelTextProperty(vtkTextProperty *p)
Set/Get the text property.
vtkDataSet * GetInput()
Use GetInputDataObject() to get the input data object for composite datasets.
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
void SetLabelModeToLabelTCoords()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
static vtkLabeledDataMapper * New()
Instantiate object with %%-#6.3g label format.
void SetLabelModeToLabelScalars()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
void SetFieldDataArray(int arrayIndex)
Set/Get the field data array to label.
const char * GetLabelText(int label)
Return the text for the requested label.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetLabelModeToLabelFieldData()
Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors,...
vtkMTimeType GetMTime() override
Return the modified time for this object.
void RenderOverlay(vtkViewport *viewport, vtkActor2D *actor) override
Draw the text to the screen at each input point.
~vtkLabeledDataMapper() override
void SetTransform(vtkTransform *t)
The transform to apply to the labels before mapping to 2D.
virtual vtkTextProperty * GetLabelTextProperty(int type)
Set/Get the text property.
void BuildLabelsInternal(vtkDataSet *)
void GetLabelPosition(int label, double pos[3])
Return the position of the requested label.
void CoordinateSystemDisplay()
Set/get the coordinate system used for output labels.
Coordinates
Coordinate systems that output dataset may use.
@ DISPLAY
Output 2-D display coordinates for each label anchor (3 components but only 2 are significant).
@ WORLD
Output 3-D world-space coordinates for each label anchor.
abstract class specifies interface for objects which render 2D actors
Definition vtkMapper2D.h:36
2D text annotation
represent text properties.
record modification and/or execution time
describes linear transformations via a 4x4 matrix
abstract specification for Viewports
Definition vtkViewport.h:50
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
#define VTK_LABEL_TENSORS
#define VTK_LABEL_TCOORDS
#define VTK_LABEL_VECTORS
#define VTK_LABEL_SCALARS
#define VTK_LABEL_FIELD_DATA
#define VTK_LABEL_IDS
#define VTK_LABEL_NORMALS
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287