VTK  9.2.6
vtkImageProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageProperty.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 =========================================================================*/
140 #ifndef vtkImageProperty_h
141 #define vtkImageProperty_h
142 
143 #include "vtkObject.h"
144 #include "vtkRenderingCoreModule.h" // For export macro
145 
146 class vtkScalarsToColors;
147 
148 class VTKRENDERINGCORE_EXPORT vtkImageProperty : public vtkObject
149 {
150 public:
151  vtkTypeMacro(vtkImageProperty, vtkObject);
152  void PrintSelf(ostream& os, vtkIndent indent) override;
153 
158 
163 
165 
168  vtkSetMacro(ColorWindow, double);
169  vtkGetMacro(ColorWindow, double);
171 
173 
176  vtkSetMacro(ColorLevel, double);
177  vtkGetMacro(ColorLevel, double);
179 
181 
186  virtual void SetLookupTable(vtkScalarsToColors* lut);
187  vtkGetObjectMacro(LookupTable, vtkScalarsToColors);
189 
191 
196  vtkSetMacro(UseLookupTableScalarRange, vtkTypeBool);
197  vtkGetMacro(UseLookupTableScalarRange, vtkTypeBool);
198  vtkBooleanMacro(UseLookupTableScalarRange, vtkTypeBool);
200 
202 
208  vtkSetClampMacro(Opacity, double, 0.0, 1.0);
209  vtkGetMacro(Opacity, double);
211 
213 
216  vtkSetClampMacro(Ambient, double, 0.0, 1.0);
217  vtkGetMacro(Ambient, double);
219 
221 
224  vtkSetClampMacro(Diffuse, double, 0.0, 1.0);
225  vtkGetMacro(Diffuse, double);
227 
229 
232  vtkSetClampMacro(InterpolationType, int, VTK_NEAREST_INTERPOLATION, VTK_CUBIC_INTERPOLATION);
233  vtkGetMacro(InterpolationType, int);
234  void SetInterpolationTypeToNearest() { this->SetInterpolationType(VTK_NEAREST_INTERPOLATION); }
235  void SetInterpolationTypeToLinear() { this->SetInterpolationType(VTK_LINEAR_INTERPOLATION); }
236  void SetInterpolationTypeToCubic() { this->SetInterpolationType(VTK_CUBIC_INTERPOLATION); }
237  virtual const char* GetInterpolationTypeAsString();
239 
241 
245  vtkSetMacro(LayerNumber, int);
246  int GetLayerNumber() { return this->LayerNumber; }
248 
250 
254  vtkSetMacro(Checkerboard, vtkTypeBool);
255  vtkBooleanMacro(Checkerboard, vtkTypeBool);
256  vtkGetMacro(Checkerboard, vtkTypeBool);
258 
260 
263  vtkSetVector2Macro(CheckerboardSpacing, double);
264  vtkGetVector2Macro(CheckerboardSpacing, double);
266 
268 
272  vtkSetVector2Macro(CheckerboardOffset, double);
273  vtkGetVector2Macro(CheckerboardOffset, double);
275 
277 
283  vtkSetMacro(Backing, vtkTypeBool);
284  vtkBooleanMacro(Backing, vtkTypeBool);
285  vtkGetMacro(Backing, vtkTypeBool);
287 
289 
292  vtkSetVector3Macro(BackingColor, double);
293  vtkGetVector3Macro(BackingColor, double);
295 
300  vtkMTimeType GetMTime() override;
301 
302 protected:
304  ~vtkImageProperty() override;
305 
307  double ColorWindow;
308  double ColorLevel;
312  double Opacity;
313  double Ambient;
314  double Diffuse;
316  double CheckerboardSpacing[2];
317  double CheckerboardOffset[2];
319  double BackingColor[3];
320 
321 private:
322  vtkImageProperty(const vtkImageProperty&) = delete;
323  void operator=(const vtkImageProperty&) = delete;
324 };
325 
326 #endif
image display properties
vtkTypeBool Checkerboard
void DeepCopy(vtkImageProperty *p)
Assign one property to another.
virtual const char * GetInterpolationTypeAsString()
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
static vtkImageProperty * New()
Construct a property with no lookup table.
virtual void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the data.
void SetInterpolationTypeToLinear()
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
vtkScalarsToColors * LookupTable
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetLayerNumber()
Set the layer number.
~vtkImageProperty() override
vtkTypeBool UseLookupTableScalarRange
vtkMTimeType GetMTime() override
Get the MTime for this property.
void SetInterpolationTypeToCubic()
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
void SetInterpolationTypeToNearest()
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
Superclass for mapping scalar values to colors.
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_CUBIC_INTERPOLATION
#define VTK_NEAREST_INTERPOLATION
#define VTK_LINEAR_INTERPOLATION
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287