VTK  9.3.0
vtkLabeledDataMapper.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
51 #ifndef vtkLabeledDataMapper_h
52 #define vtkLabeledDataMapper_h
53 
54 #include "vtkMapper2D.h"
55 #include "vtkRenderingLabelModule.h" // For export macro
56 
57 #include <cassert> // For assert macro
58 
59 VTK_ABI_NAMESPACE_BEGIN
60 class vtkDataObject;
61 class vtkDataSet;
62 class vtkTextMapper;
63 class vtkTextProperty;
64 class vtkTransform;
65 
66 #define VTK_LABEL_IDS 0
67 #define VTK_LABEL_SCALARS 1
68 #define VTK_LABEL_VECTORS 2
69 #define VTK_LABEL_NORMALS 3
70 #define VTK_LABEL_TCOORDS 4
71 #define VTK_LABEL_TENSORS 5
72 #define VTK_LABEL_FIELD_DATA 6
73 
74 class VTKRENDERINGLABEL_EXPORT vtkLabeledDataMapper : public vtkMapper2D
75 {
76 public:
82 
84  void PrintSelf(ostream& os, vtkIndent indent) override;
85 
87 
99  vtkSetStringMacro(LabelFormat);
100  vtkGetStringMacro(LabelFormat);
102 
104 
111  vtkSetMacro(LabeledComponent, int);
112  vtkGetMacro(LabeledComponent, int);
114 
116 
119  vtkSetMacro(ComponentSeparator, char);
120  vtkGetMacro(ComponentSeparator, char);
122 
124 
129  void SetFieldDataArray(int arrayIndex);
130  vtkGetMacro(FieldDataArray, int);
132 
134 
139  void SetFieldDataName(const char* arrayName);
140  vtkGetStringMacro(FieldDataName);
142 
146  virtual void SetInputData(vtkDataObject*);
147 
153 
155 
161  vtkSetMacro(LabelMode, int);
162  vtkGetMacro(LabelMode, int);
163  void SetLabelModeToLabelIds() { this->SetLabelMode(VTK_LABEL_IDS); }
164  void SetLabelModeToLabelScalars() { this->SetLabelMode(VTK_LABEL_SCALARS); }
165  void SetLabelModeToLabelVectors() { this->SetLabelMode(VTK_LABEL_VECTORS); }
166  void SetLabelModeToLabelNormals() { this->SetLabelMode(VTK_LABEL_NORMALS); }
167  void SetLabelModeToLabelTCoords() { this->SetLabelMode(VTK_LABEL_TCOORDS); }
168  void SetLabelModeToLabelTensors() { this->SetLabelMode(VTK_LABEL_TENSORS); }
169  void SetLabelModeToLabelFieldData() { this->SetLabelMode(VTK_LABEL_FIELD_DATA); }
171 
173 
184 
186 
189  void RenderOpaqueGeometry(vtkViewport* viewport, vtkActor2D* actor) override;
190  void RenderOverlay(vtkViewport* viewport, vtkActor2D* actor) override;
192 
197 
199 
202  vtkGetObjectMacro(Transform, vtkTransform);
205 
208  {
209  WORLD = 0,
210  DISPLAY = 1
212  };
213 
215 
219  vtkGetMacro(CoordinateSystem, int);
220  vtkSetClampMacro(CoordinateSystem, int, WORLD, DISPLAY);
221  void CoordinateSystemWorld() { this->SetCoordinateSystem(vtkLabeledDataMapper::WORLD); }
222  void CoordinateSystemDisplay() { this->SetCoordinateSystem(vtkLabeledDataMapper::DISPLAY); }
224 
228  vtkMTimeType GetMTime() override;
229 
231 
234  vtkGetMacro(NumberOfLabels, int);
236 
238 
241  void GetLabelPosition(int label, double pos[3])
242  {
243  assert("label index range" && label >= 0 && label < this->NumberOfLabels);
244  pos[0] = this->LabelPositions[3 * label];
245  pos[1] = this->LabelPositions[3 * label + 1];
246  pos[2] = this->LabelPositions[3 * label + 2];
247  }
249 
253  const char* GetLabelText(int label);
254 
255 protected:
258 
260 
261  char* LabelFormat;
267 
269 
271 
275  double* LabelPositions;
277 
279 
280  void AllocateLabels(int numLabels);
281  void BuildLabels();
283 
284  class Internals;
285  Internals* Implementation;
286 
287 private:
289  void operator=(const vtkLabeledDataMapper&) = delete;
290 };
291 
292 VTK_ABI_NAMESPACE_END
293 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:44
general representation of visualization data
Definition: vtkDataObject.h:64
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
a simple class to control print indentation
Definition: vtkIndent.h:38
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,...
vtkDataSet * GetInput()
Use GetInputDataObject() to get the input data object for composite datasets.
vtkTextMapper ** TextMappers
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.
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,...
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.
virtual vtkTextProperty * GetLabelTextProperty()
Set/Get the text property.
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
virtual vtkTextProperty * GetLabelTextProperty(int type)
Set/Get the text property.
static vtkLabeledDataMapper * New()
Instantiate object with %%-#6.3g label format.
void SetTransform(vtkTransform *t)
The transform to apply to the labels before mapping to 2D.
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.
const char * GetLabelText(int label)
Return the text for the requested label.
abstract class specifies interface for objects which render 2D actors
Definition: vtkMapper2D.h:25
2D text annotation
Definition: vtkTextMapper.h:49
represent text properties.
record modification and/or execution time
Definition: vtkTimeStamp.h:34
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:59
abstract specification for Viewports
Definition: vtkViewport.h:54
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
@ Transform
Definition: vtkX3D.h:41
@ type
Definition: vtkX3D.h:516
#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:270