VTK  9.1.20211230
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 =========================================================================*/
117 #ifndef vtkLabeledDataMapper_h
118 #define vtkLabeledDataMapper_h
119 
120 #include "vtkMapper2D.h"
121 #include "vtkRenderingLabelModule.h" // For export macro
122 
123 #include <cassert> // For assert macro
124 
125 class vtkDataObject;
126 class vtkDataSet;
127 class vtkTextMapper;
128 class vtkTextProperty;
129 class vtkTransform;
130 
131 #define VTK_LABEL_IDS 0
132 #define VTK_LABEL_SCALARS 1
133 #define VTK_LABEL_VECTORS 2
134 #define VTK_LABEL_NORMALS 3
135 #define VTK_LABEL_TCOORDS 4
136 #define VTK_LABEL_TENSORS 5
137 #define VTK_LABEL_FIELD_DATA 6
138 
139 class VTKRENDERINGLABEL_EXPORT vtkLabeledDataMapper : public vtkMapper2D
140 {
141 public:
147 
149  void PrintSelf(ostream& os, vtkIndent indent) override;
150 
152 
164  vtkSetStringMacro(LabelFormat);
165  vtkGetStringMacro(LabelFormat);
167 
169 
176  vtkSetMacro(LabeledComponent, int);
177  vtkGetMacro(LabeledComponent, int);
179 
181 
184  vtkSetMacro(ComponentSeparator, char);
185  vtkGetMacro(ComponentSeparator, char);
187 
189 
194  void SetFieldDataArray(int arrayIndex);
195  vtkGetMacro(FieldDataArray, int);
197 
199 
204  void SetFieldDataName(const char* arrayName);
205  vtkGetStringMacro(FieldDataName);
207 
211  virtual void SetInputData(vtkDataObject*);
212 
218 
220 
226  vtkSetMacro(LabelMode, int);
227  vtkGetMacro(LabelMode, int);
228  void SetLabelModeToLabelIds() { this->SetLabelMode(VTK_LABEL_IDS); }
229  void SetLabelModeToLabelScalars() { this->SetLabelMode(VTK_LABEL_SCALARS); }
230  void SetLabelModeToLabelVectors() { this->SetLabelMode(VTK_LABEL_VECTORS); }
231  void SetLabelModeToLabelNormals() { this->SetLabelMode(VTK_LABEL_NORMALS); }
232  void SetLabelModeToLabelTCoords() { this->SetLabelMode(VTK_LABEL_TCOORDS); }
233  void SetLabelModeToLabelTensors() { this->SetLabelMode(VTK_LABEL_TENSORS); }
234  void SetLabelModeToLabelFieldData() { this->SetLabelMode(VTK_LABEL_FIELD_DATA); }
236 
238 
249 
251 
254  void RenderOpaqueGeometry(vtkViewport* viewport, vtkActor2D* actor) override;
255  void RenderOverlay(vtkViewport* viewport, vtkActor2D* actor) override;
257 
262 
264 
267  vtkGetObjectMacro(Transform, vtkTransform);
270 
273  {
274  WORLD = 0,
275  DISPLAY = 1
277  };
278 
280 
284  vtkGetMacro(CoordinateSystem, int);
285  vtkSetClampMacro(CoordinateSystem, int, WORLD, DISPLAY);
286  void CoordinateSystemWorld() { this->SetCoordinateSystem(vtkLabeledDataMapper::WORLD); }
287  void CoordinateSystemDisplay() { this->SetCoordinateSystem(vtkLabeledDataMapper::DISPLAY); }
289 
293  vtkMTimeType GetMTime() override;
294 
296 
299  vtkGetMacro(NumberOfLabels, int);
301 
303 
306  void GetLabelPosition(int label, double pos[3])
307  {
308  assert("label index range" && label >= 0 && label < this->NumberOfLabels);
309  pos[0] = this->LabelPositions[3 * label];
310  pos[1] = this->LabelPositions[3 * label + 1];
311  pos[2] = this->LabelPositions[3 * label + 2];
312  }
314 
318  const char* GetLabelText(int label);
319 
320 protected:
323 
325 
326  char* LabelFormat;
332 
334 
336 
340  double* LabelPositions;
342 
344 
345  void AllocateLabels(int numLabels);
346  void BuildLabels();
348 
349  class Internals;
350  Internals* Implementation;
351 
352 private:
354  void operator=(const vtkLabeledDataMapper&) = delete;
355 };
356 
357 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:149
general representation of visualization data
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
a simple class to control print indentation
Definition: vtkIndent.h:113
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:36
2D text annotation
represent text properties.
record modification and/or execution time
Definition: vtkTimeStamp.h:52
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:164
abstract specification for Viewports
Definition: vtkViewport.h:47
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ Transform
Definition: vtkX3D.h:47
@ type
Definition: vtkX3D.h:522
#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