VTK
vtkScalarsToColorsPainter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkScalarsToColorsPainter.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 =========================================================================*/
28 #ifndef vtkScalarsToColorsPainter_h
29 #define vtkScalarsToColorsPainter_h
30 
31 #include "vtkRenderingOpenGLModule.h" // For export macro
32 #include "vtkPainter.h"
33 #include "vtkSmartPointer.h" // needed for vtkSmartPointer.
34 class vtkDataArray;
35 class vtkImageData;
40 class vtkDataSet;
41 class vtkScalarsToColors;
42 
43 class VTKRENDERINGOPENGL_EXPORT vtkScalarsToColorsPainter : public vtkPainter
44 {
45 public:
48  void PrintSelf(ostream& os, vtkIndent indent);
49 
58  static vtkInformationIntegerKey* USE_LOOKUP_TABLE_SCALAR_RANGE();
59 
65  static vtkInformationDoubleVectorKey* SCALAR_RANGE();
66 
71  static vtkInformationIntegerKey* SCALAR_MODE();
72 
80  static vtkInformationIntegerKey* COLOR_MODE();
81 
88  static vtkInformationIntegerKey* INTERPOLATE_SCALARS_BEFORE_MAPPING();
89 
91 
94  static vtkInformationObjectBaseKey* LOOKUP_TABLE();
95  void SetLookupTable(vtkScalarsToColors *lut);
96  vtkScalarsToColors *GetLookupTable();
98 
103  virtual void CreateDefaultLookupTable();
104 
108  static vtkInformationIntegerKey* SCALAR_VISIBILITY();
109 
111 
114  static vtkInformationIntegerKey* ARRAY_ACCESS_MODE();
115  static vtkInformationIntegerKey* ARRAY_ID();
116  static vtkInformationStringKey* ARRAY_NAME();
117  static vtkInformationIntegerKey* ARRAY_COMPONENT();
118  static vtkInformationIntegerKey* FIELD_DATA_TUPLE_ID();
120 
124  static vtkInformationIntegerKey* SCALAR_MATERIAL_MODE();
125 
138  virtual int GetPremultiplyColorsWithAlpha(vtkActor* actor);
139 
143  virtual vtkDataObject *GetOutput();
144 
150  virtual vtkIdType GetTextureSizeLimit();
151 
152 protected:
154  virtual ~vtkScalarsToColorsPainter();
155 
159  virtual vtkDataObject* NewClone(vtkDataObject* data);
160 
166  void MapScalarsToTexture(vtkDataSet* output,
167  vtkDataArray* scalars, vtkDataSet* input);
168 
172  virtual void PrepareForRendering(vtkRenderer* renderer, vtkActor* actor);
173 
179  virtual void MapScalars(vtkDataSet* output,
180  double alpha, int multiply_with_alpha,
181  vtkDataSet* input);
182 
187  virtual void ProcessInformation(vtkInformation*);
188 
192  void ReportReferences(vtkGarbageCollector *collector) VTK_OVERRIDE;
193 
202  int CanUseTextureMapForColoring(vtkDataObject* input);
203 
204 
208  void UpdateColorTextureMap(double alpha, int multiply_with_alpha);
209 
210  // Methods to set the ivars. These are purposefully protected.
211  // The only means of affecting these should be using the vtkInformation
212  // object.
213  vtkSetMacro(UseLookupTableScalarRange, int);
214  vtkSetVector2Macro(ScalarRange, double);
215  vtkSetMacro(ScalarMode, int);
216  vtkSetMacro(ColorMode, int);
217  vtkSetMacro(InterpolateScalarsBeforeMapping, int);
218  vtkSetMacro(ScalarVisibility, int);
219  vtkSetMacro(ScalarMaterialMode, int);
220  vtkSetMacro(ArrayAccessMode, int);
221  vtkSetMacro(ArrayComponent, int);
222  vtkSetMacro(ArrayId, int);
223  vtkSetStringMacro(ArrayName);
224  vtkSetMacro(FieldDataTupleId, vtkIdType);
225 
227 
230  int ArrayId;
231  char* ArrayName;
233 
235  // Lookup table provided via the scalars. This gets preference over the one
236  // set on the mapper by the user.
243  double LastUsedAlpha; // Essential to ensure alpha changes work correctly
244  // for composite datasets.
246  double ScalarRange[2];
249 
251 
252  // This is set when MapScalars decides to use vertex colors for atleast on
253  // dataset in the current pass.
255 
256 private:
257  vtkScalarsToColorsPainter(const vtkScalarsToColorsPainter&) VTK_DELETE_FUNCTION;
258  void operator=(const vtkScalarsToColorsPainter&) VTK_DELETE_FUNCTION;
259 
260 };
261 
262 #endif
vtkScalarsToColorsPainter::ColorMode
int ColorMode
Definition: vtkScalarsToColorsPainter.h:239
vtkInformationStringKey
Key for string values in vtkInformation.
Definition: vtkInformationStringKey.h:36
vtkX3D::alpha
@ alpha
Definition: vtkX3D.h:250
vtkScalarsToColorsPainter
painter that converts scalars to colors. It enable/disables coloring state depending on the ScalarMod...
Definition: vtkScalarsToColorsPainter.h:43
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkScalarsToColorsPainter::UseLookupTableScalarRange
int UseLookupTableScalarRange
Definition: vtkScalarsToColorsPainter.h:248
vtkScalarsToColorsPainter::ColorTextureMap
vtkSmartPointer< vtkImageData > ColorTextureMap
Definition: vtkScalarsToColorsPainter.h:238
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkScalarsToColorsPainter::ArrayComponent
int ArrayComponent
Definition: vtkScalarsToColorsPainter.h:229
vtkScalarsToColorsPainter::ScalarVisibility
int ScalarVisibility
Definition: vtkScalarsToColorsPainter.h:247
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:35
vtkSmartPointer< vtkScalarsToColors >
vtkScalarsToColorsPainter::ArrayAccessMode
int ArrayAccessMode
Definition: vtkScalarsToColorsPainter.h:228
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
vtkPainter::PrintSelf
virtual void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkScalarsToColorsPainter::ArrayId
int ArrayId
Definition: vtkScalarsToColorsPainter.h:230
vtkScalarsToColorsPainter::ScalarMode
int ScalarMode
Definition: vtkScalarsToColorsPainter.h:241
vtkScalarsToColorsPainter::LookupTable
vtkScalarsToColors * LookupTable
Definition: vtkScalarsToColorsPainter.h:234
vtkInformationObjectBaseKey
Key for vtkObjectBase values.
Definition: vtkInformationObjectBaseKey.h:36
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:34
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:51
vtkPainter::ProcessInformation
virtual void ProcessInformation(vtkInformation *)
Called before RenderInternal() if the Information has been changed since the last time this method wa...
Definition: vtkPainter.h:233
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkPainter
Abstract class for drawing poly data.
Definition: vtkPainter.h:61
vtkSmartPointer.h
vtkScalarsToColorsPainter::FieldDataTupleId
vtkIdType FieldDataTupleId
Definition: vtkScalarsToColorsPainter.h:232
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:66
vtkPainter.h
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:99
vtkScalarsToColorsPainter::LastUsedMultiplyWithAlpha
int LastUsedMultiplyWithAlpha
Definition: vtkScalarsToColorsPainter.h:245
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkPainter::GetOutput
virtual vtkDataObject * GetOutput()
Get the output data object from this painter.
Definition: vtkPainter.h:174
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkScalarsToColorsPainter::OutputUpdateTime
vtkTimeStamp OutputUpdateTime
Definition: vtkScalarsToColorsPainter.h:250
vtkInformationDoubleVectorKey
Key for double vector values.
Definition: vtkInformationDoubleVectorKey.h:34
vtkScalarsToColorsPainter::LastUsedAlpha
double LastUsedAlpha
Definition: vtkScalarsToColorsPainter.h:243
vtkScalarsToColorsPainter::ArrayName
char * ArrayName
Definition: vtkScalarsToColorsPainter.h:231
vtkScalarsToColorsPainter::UsingScalarColoring
int UsingScalarColoring
Definition: vtkScalarsToColorsPainter.h:254
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:63
vtkScalarsToColorsPainter::InterpolateScalarsBeforeMapping
int InterpolateScalarsBeforeMapping
Definition: vtkScalarsToColorsPainter.h:240
vtkScalarsToColorsPainter::ScalarsLookupTable
vtkSmartPointer< vtkScalarsToColors > ScalarsLookupTable
Definition: vtkScalarsToColorsPainter.h:237
vtkPainter::PrepareForRendering
virtual void PrepareForRendering(vtkRenderer *, vtkActor *)
Some subclasses may need to do some preprocessing before the actual rendering can be done eg.
Definition: vtkPainter.h:210
vtkScalarsToColorsPainter::OutputData
vtkDataObject * OutputData
Definition: vtkScalarsToColorsPainter.h:224
vtkPainter::ReportReferences
void ReportReferences(vtkGarbageCollector *collector) override
Take part in garbage collection.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkScalarsToColorsPainter::ScalarMaterialMode
int ScalarMaterialMode
Definition: vtkScalarsToColorsPainter.h:242