VTK  9.5.2
vtkPolyDataMapper2D.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
27#ifndef vtkPolyDataMapper2D_h
28#define vtkPolyDataMapper2D_h
29
30#include "vtkMapper2D.h"
31#include "vtkRenderingCoreModule.h" // For export macro
32#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
33
34VTK_ABI_NAMESPACE_BEGIN
35class vtkCoordinate;
36class vtkPolyData;
39
40class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkPolyDataMapper2D : public vtkMapper2D
41{
42public:
45 void PrintSelf(ostream& os, vtkIndent indent) override;
46
48
54
56
62
68
70
73 vtkSetMacro(ScalarVisibility, vtkTypeBool);
74 vtkGetMacro(ScalarVisibility, vtkTypeBool);
75 vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
77
79
92 vtkSetMacro(ColorMode, int);
93 vtkGetMacro(ColorMode, int);
98
102 const char* GetColorModeAsString();
103
105
113 vtkSetMacro(UseLookupTableScalarRange, vtkTypeBool);
114 vtkGetMacro(UseLookupTableScalarRange, vtkTypeBool);
115 vtkBooleanMacro(UseLookupTableScalarRange, vtkTypeBool);
117
119
124 vtkSetVector2Macro(ScalarRange, double);
125 vtkGetVectorMacro(ScalarRange, double, 2);
127
129
141 vtkSetMacro(ScalarMode, int);
142 vtkGetMacro(ScalarMode, int);
143 void SetScalarModeToDefault() { this->SetScalarMode(VTK_SCALAR_MODE_DEFAULT); }
147 {
148 this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_FIELD_DATA);
149 }
151 {
152 this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_FIELD_DATA);
153 }
155
157
160 void ColorByArrayComponent(int arrayNum, int component);
161 void ColorByArrayComponent(const char* arrayName, int component);
163
167 vtkGetStringMacro(ArrayName);
168 vtkSetStringMacro(ArrayName);
169 vtkGetMacro(ArrayId, int);
170 vtkSetMacro(ArrayId, int);
171 vtkGetMacro(ArrayAccessMode, int);
172 vtkSetMacro(ArrayAccessMode, int);
173 vtkGetMacro(ArrayComponent, int);
174 vtkSetMacro(ArrayComponent, int);
175
181
183
190 vtkGetObjectMacro(TransformCoordinate, vtkCoordinate);
192
194
198 vtkGetMacro(TransformCoordinateUseDouble, bool);
199 vtkSetMacro(TransformCoordinateUseDouble, bool);
200 vtkBooleanMacro(TransformCoordinateUseDouble, bool);
202
211
216
217protected:
220
222
224
228 double ScalarRange[2];
232
235
236 // for coloring by a component of a field data array
238 char* ArrayName = nullptr;
241
242private:
244 void operator=(const vtkPolyDataMapper2D&) = delete;
245};
246
247VTK_ABI_NAMESPACE_END
248#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:29
Store vtkAlgorithm input/output information.
abstract class specifies interface for objects which render 2D actors
Definition vtkMapper2D.h:26
draw vtkPolyData onto the image plane
vtkPolyData * GetInput()
Set the input to the mapper.
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.
static vtkPolyDataMapper2D * New()
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.
const char * GetColorModeAsString()
Return the method of coloring scalar 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.
vtkTypeBool UseLookupTableScalarRange
~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.
vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
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:72
Superclass for mapping scalar values to colors.
record modification and/or execution time
dynamic, self-adjusting array of unsigned char
int vtkTypeBool
Definition vtkABI.h:64
#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
#define VTK_MARSHALAUTO