VTK
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 =========================================================================*/
39 #ifndef vtkPolyDataMapper2D_h
40 #define vtkPolyDataMapper2D_h
41 
42 
43 #include "vtkRenderingCoreModule.h" // For export macro
44 #include "vtkMapper2D.h"
45 
46 class vtkCoordinate;
47 class vtkPolyData;
48 class vtkScalarsToColors;
50 
51 class VTKRENDERINGCORE_EXPORT vtkPolyDataMapper2D : public vtkMapper2D
52 {
53 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
59 
65 
67 
73 
78  virtual void CreateDefaultLookupTable();
79 
81 
84  vtkSetMacro(ScalarVisibility, vtkTypeBool);
85  vtkGetMacro(ScalarVisibility, vtkTypeBool);
86  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
88 
90 
103  vtkSetMacro(ColorMode, int);
104  vtkGetMacro(ColorMode, int);
109 
113  const char *GetColorModeAsString();
114 
116 
124  vtkSetMacro(UseLookupTableScalarRange, vtkTypeBool);
125  vtkGetMacro(UseLookupTableScalarRange, vtkTypeBool);
126  vtkBooleanMacro(UseLookupTableScalarRange, vtkTypeBool);
128 
130 
135  vtkSetVector2Macro(ScalarRange, double);
136  vtkGetVectorMacro(ScalarRange, double, 2);
138 
140 
152  vtkSetMacro(ScalarMode, int);
153  vtkGetMacro(ScalarMode, int);
155  { this->SetScalarMode(VTK_SCALAR_MODE_DEFAULT); }
157  { this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_DATA); }
159  { this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_DATA); }
161  { this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_FIELD_DATA); }
163  { this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_FIELD_DATA); }
165 
167 
170  void ColorByArrayComponent(int arrayNum, int component);
171  void ColorByArrayComponent(const char* arrayName, int component);
173 
177  const char* GetArrayName() { return this->ArrayName; }
178  int GetArrayId() { return this->ArrayId; }
179  int GetArrayAccessMode() { return this->ArrayAccessMode; }
180  int GetArrayComponent() { return this->ArrayComponent; }
181 
186  vtkMTimeType GetMTime() override;
187 
189 
196  vtkGetObjectMacro(TransformCoordinate, vtkCoordinate);
198 
200 
204  vtkGetMacro(TransformCoordinateUseDouble, bool);
205  vtkSetMacro(TransformCoordinateUseDouble, bool);
206  vtkBooleanMacro(TransformCoordinateUseDouble, bool);
208 
217 
221  void ShallowCopy(vtkAbstractMapper *m) override;
222 
223 protected:
226 
228 
230 
234  double ScalarRange[2];
238 
241 
242  // for coloring by a component of a field data array
243  int ArrayId;
244  char ArrayName[256];
247 private:
248  vtkPolyDataMapper2D(const vtkPolyDataMapper2D&) = delete;
249  void operator=(const vtkPolyDataMapper2D&) = delete;
250 };
251 
252 
253 #endif
vtkPolyDataMapper2D::SetColorModeToDirectScalars
void SetColorModeToDirectScalars()
VTK_SCALAR_MODE_DEFAULT
#define VTK_SCALAR_MODE_DEFAULT
Definition: vtkAbstractMapper.h:37
vtkPolyDataMapper2D::FillInputPortInformation
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
vtkPolyDataMapper2D::SetInputData
void SetInputData(vtkPolyData *in)
Set the input to the mapper.
VTK_SCALAR_MODE_USE_CELL_FIELD_DATA
#define VTK_SCALAR_MODE_USE_CELL_FIELD_DATA
Definition: vtkAbstractMapper.h:41
VTK_SCALAR_MODE_USE_POINT_DATA
#define VTK_SCALAR_MODE_USE_POINT_DATA
Definition: vtkAbstractMapper.h:38
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:52
vtkX3D::alpha
@ alpha
Definition: vtkX3D.h:250
vtkX3D::component
@ component
Definition: vtkX3D.h:175
VTK_SCALAR_MODE_USE_POINT_FIELD_DATA
#define VTK_SCALAR_MODE_USE_POINT_FIELD_DATA
Definition: vtkAbstractMapper.h:40
vtkPolyDataMapper2D::GetArrayAccessMode
int GetArrayAccessMode()
Definition: vtkPolyDataMapper2D.h:179
vtkPolyDataMapper2D::ColorByArrayComponent
void ColorByArrayComponent(int arrayNum, int component)
Choose which component of which field data array to color by.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkPolyDataMapper2D::SetScalarModeToUsePointFieldData
void SetScalarModeToUsePointFieldData()
Definition: vtkPolyDataMapper2D.h:160
vtkPolyDataMapper2D::SetLookupTable
void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:42
vtkPolyDataMapper2D::GetMTime
vtkMTimeType GetMTime() override
Overload standard modified time function.
vtkPolyDataMapper2D::New
static vtkPolyDataMapper2D * New()
vtkPolyDataMapper2D::ColorByArrayComponent
void ColorByArrayComponent(const char *arrayName, int component)
vtkPolyDataMapper2D::GetArrayId
int GetArrayId()
Definition: vtkPolyDataMapper2D.h:178
vtkPolyDataMapper2D::SetScalarModeToUsePointData
void SetScalarModeToUsePointData()
Definition: vtkPolyDataMapper2D.h:156
vtkPolyDataMapper2D::LookupTable
vtkScalarsToColors * LookupTable
Definition: vtkPolyDataMapper2D.h:231
vtkPolyDataMapper2D::~vtkPolyDataMapper2D
~vtkPolyDataMapper2D() override
vtkPolyDataMapper2D::MapScalars
vtkUnsignedCharArray * MapScalars(double alpha)
Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table,...
vtkPolyDataMapper2D::SetScalarModeToUseCellFieldData
void SetScalarModeToUseCellFieldData()
Definition: vtkPolyDataMapper2D.h:162
vtkPolyDataMapper2D::ArrayId
int ArrayId
Definition: vtkPolyDataMapper2D.h:243
VTK_SCALAR_MODE_USE_CELL_DATA
#define VTK_SCALAR_MODE_USE_CELL_DATA
Definition: vtkAbstractMapper.h:39
vtkPolyDataMapper2D::GetArrayName
const char * GetArrayName()
Get the array name or number and component to color by.
Definition: vtkPolyDataMapper2D.h:177
vtkPolyDataMapper2D::ShallowCopy
void ShallowCopy(vtkAbstractMapper *m) override
Make a shallow copy of this mapper.
vtkPolyDataMapper2D::TransformCoordinateUseDouble
bool TransformCoordinateUseDouble
Definition: vtkPolyDataMapper2D.h:240
vtkPolyDataMapper2D::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkMapper2D.h
vtkCoordinate
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:82
vtkPolyDataMapper2D::ScalarVisibility
vtkTypeBool ScalarVisibility
Definition: vtkPolyDataMapper2D.h:232
vtkPolyDataMapper2D::UseLookupTableScalarRange
vtkTypeBool UseLookupTableScalarRange
Definition: vtkPolyDataMapper2D.h:235
vtkPolyDataMapper2D::ScalarMode
int ScalarMode
Definition: vtkPolyDataMapper2D.h:237
vtkPolyDataMapper2D::SetColorModeToDefault
void SetColorModeToDefault()
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:67
vtkMapper2D
abstract class specifies interface for objects which render 2D actors
Definition: vtkMapper2D.h:36
vtkPolyDataMapper2D::ArrayComponent
int ArrayComponent
Definition: vtkPolyDataMapper2D.h:245
vtkPolyDataMapper2D::CreateDefaultLookupTable
virtual void CreateDefaultLookupTable()
Create default lookup table.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkPolyDataMapper2D::TransformCoordinate
vtkCoordinate * TransformCoordinate
Definition: vtkPolyDataMapper2D.h:239
vtkPolyDataMapper2D::GetLookupTable
vtkScalarsToColors * GetLookupTable()
vtkPolyDataMapper2D::SetColorModeToMapScalars
void SetColorModeToMapScalars()
vtkPolyDataMapper2D::BuildTime
vtkTimeStamp BuildTime
Definition: vtkPolyDataMapper2D.h:233
vtkPolyDataMapper2D::ColorMode
int ColorMode
Definition: vtkPolyDataMapper2D.h:236
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkPolyDataMapper2D::GetInput
vtkPolyData * GetInput()
vtkPolyDataMapper2D::SetScalarModeToDefault
void SetScalarModeToDefault()
Definition: vtkPolyDataMapper2D.h:154
vtkPolyDataMapper2D::SetTransformCoordinate
virtual void SetTransformCoordinate(vtkCoordinate *)
Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates.
vtkPolyDataMapper2D::vtkPolyDataMapper2D
vtkPolyDataMapper2D()
vtkPolyDataMapper2D::GetArrayComponent
int GetArrayComponent()
Definition: vtkPolyDataMapper2D.h:180
vtkPolyDataMapper2D::ArrayAccessMode
int ArrayAccessMode
Definition: vtkPolyDataMapper2D.h:246
vtkPolyDataMapper2D::SetScalarModeToUseCellData
void SetScalarModeToUseCellData()
Definition: vtkPolyDataMapper2D.h:158
vtkPolyDataMapper2D::Colors
vtkUnsignedCharArray * Colors
Definition: vtkPolyDataMapper2D.h:229
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkAbstractMapper
abstract class specifies interface to map data
Definition: vtkAbstractMapper.h:56
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkPolyDataMapper2D::GetColorModeAsString
const char * GetColorModeAsString()
Return the method of coloring scalar data.