VTK  9.1.20220516
vtkPolyDataMapper2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPolyDataMapper2D.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 =========================================================================*/
148 #ifndef vtkPolyDataMapper2D_h
149 #define vtkPolyDataMapper2D_h
150 
151 #include "vtkMapper2D.h"
152 #include "vtkRenderingCoreModule.h" // For export macro
153 
154 class vtkCoordinate;
155 class vtkPolyData;
156 class vtkScalarsToColors;
158 
159 class VTKRENDERINGCORE_EXPORT vtkPolyDataMapper2D : public vtkMapper2D
160 {
161 public:
164  void PrintSelf(ostream& os, vtkIndent indent) override;
165 
167 
173 
175 
181 
186  virtual void CreateDefaultLookupTable();
187 
189 
192  vtkSetMacro(ScalarVisibility, vtkTypeBool);
193  vtkGetMacro(ScalarVisibility, vtkTypeBool);
194  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
196 
198 
211  vtkSetMacro(ColorMode, int);
212  vtkGetMacro(ColorMode, int);
217 
221  const char* GetColorModeAsString();
222 
224 
232  vtkSetMacro(UseLookupTableScalarRange, vtkTypeBool);
233  vtkGetMacro(UseLookupTableScalarRange, vtkTypeBool);
234  vtkBooleanMacro(UseLookupTableScalarRange, vtkTypeBool);
236 
238 
243  vtkSetVector2Macro(ScalarRange, double);
244  vtkGetVectorMacro(ScalarRange, double, 2);
246 
248 
260  vtkSetMacro(ScalarMode, int);
261  vtkGetMacro(ScalarMode, int);
262  void SetScalarModeToDefault() { this->SetScalarMode(VTK_SCALAR_MODE_DEFAULT); }
266  {
267  this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_FIELD_DATA);
268  }
270  {
271  this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_FIELD_DATA);
272  }
274 
276 
279  void ColorByArrayComponent(int arrayNum, int component);
280  void ColorByArrayComponent(const char* arrayName, int component);
282 
286  const char* GetArrayName() { return this->ArrayName; }
287  int GetArrayId() { return this->ArrayId; }
288  int GetArrayAccessMode() { return this->ArrayAccessMode; }
289  int GetArrayComponent() { return this->ArrayComponent; }
290 
295  vtkMTimeType GetMTime() override;
296 
298 
305  vtkGetObjectMacro(TransformCoordinate, vtkCoordinate);
307 
309 
313  vtkGetMacro(TransformCoordinateUseDouble, bool);
314  vtkSetMacro(TransformCoordinateUseDouble, bool);
315  vtkBooleanMacro(TransformCoordinateUseDouble, bool);
317 
326 
330  void ShallowCopy(vtkAbstractMapper* m) override;
331 
332 protected:
335 
337 
339 
343  double ScalarRange[2];
347 
350 
351  // for coloring by a component of a field data array
352  int ArrayId;
353  char ArrayName[256];
356 
357 private:
358  vtkPolyDataMapper2D(const vtkPolyDataMapper2D&) = delete;
359  void operator=(const vtkPolyDataMapper2D&) = delete;
360 };
361 
362 #endif
abstract class specifies interface to map data
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
a simple class to control print indentation
Definition: vtkIndent.h:119
Store vtkAlgorithm input/output information.
abstract class specifies interface for objects which render 2D actors
Definition: vtkMapper2D.h:36
draw vtkPolyData onto the image plane
vtkScalarsToColors * LookupTable
void SetInputData(vtkPolyData *in)
Set the input to the mapper.
void SetScalarModeToUsePointData()
Control how the filter works with scalar point data and cell attribute data.
void SetScalarModeToUseCellData()
Control how the filter works with scalar point data and cell attribute data.
vtkPolyData * GetInput()
Set the input to the mapper.
void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
void ColorByArrayComponent(const char *arrayName, int component)
Choose which component of which field data array to color by.
void SetScalarModeToDefault()
Control how the filter works with scalar point data and cell attribute data.
void ShallowCopy(vtkAbstractMapper *m) override
Make a shallow copy of this mapper.
vtkUnsignedCharArray * Colors
virtual void SetTransformCoordinate(vtkCoordinate *)
Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates.
vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
static vtkPolyDataMapper2D * New()
vtkTypeBool UseLookupTableScalarRange
const char * GetArrayName()
Get the array name or number and component to color by.
~vtkPolyDataMapper2D() override
void ColorByArrayComponent(int arrayNum, int component)
Choose which component of which field data array to color by.
void SetColorModeToDirectScalars()
Control how the scalar data is mapped to colors.
void SetScalarModeToUsePointFieldData()
Control how the filter works with scalar point data and cell attribute data.
vtkMTimeType GetMTime() override
Overload standard modified time function.
const char * GetColorModeAsString()
Return the method of coloring scalar data.
virtual void CreateDefaultLookupTable()
Create default lookup table.
void SetScalarModeToUseCellFieldData()
Control how the filter works with scalar point data and cell attribute data.
void SetColorModeToDefault()
Control how the scalar data is mapped to colors.
vtkCoordinate * TransformCoordinate
void SetColorModeToMapScalars()
Control how the scalar data is mapped to colors.
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkUnsignedCharArray * MapScalars(double alpha)
Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table,...
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:200
Superclass for mapping scalar values to colors.
record modification and/or execution time
Definition: vtkTimeStamp.h:55
dynamic, self-adjusting array of unsigned char
@ component
Definition: vtkX3D.h:181
@ alpha
Definition: vtkX3D.h:256
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SCALAR_MODE_DEFAULT
#define VTK_SCALAR_MODE_USE_POINT_DATA
#define VTK_SCALAR_MODE_USE_CELL_DATA
#define VTK_SCALAR_MODE_USE_CELL_FIELD_DATA
#define VTK_SCALAR_MODE_USE_POINT_FIELD_DATA
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287