VTK
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 =========================================================================*/
34 #ifndef vtkImageProperty_h
35 #define vtkImageProperty_h
36 
37 #include "vtkRenderingCoreModule.h" // For export macro
38 #include "vtkObject.h"
39 
40 class vtkScalarsToColors;
41 
42 class VTKRENDERINGCORE_EXPORT vtkImageProperty : public vtkObject
43 {
44 public:
45  vtkTypeMacro(vtkImageProperty,vtkObject);
46  void PrintSelf(ostream& os, vtkIndent indent);
47 
51  static vtkImageProperty *New();
52 
57 
59 
62  vtkSetMacro(ColorWindow, double);
63  vtkGetMacro(ColorWindow, double);
65 
67 
70  vtkSetMacro(ColorLevel, double);
71  vtkGetMacro(ColorLevel, double);
73 
75 
80  virtual void SetLookupTable(vtkScalarsToColors *lut);
81  vtkGetObjectMacro(LookupTable, vtkScalarsToColors);
83 
85 
90  vtkSetMacro(UseLookupTableScalarRange, int);
91  vtkGetMacro(UseLookupTableScalarRange, int);
92  vtkBooleanMacro(UseLookupTableScalarRange, int);
94 
96 
101  vtkSetClampMacro(Opacity, double, 0.0, 1.0);
102  vtkGetMacro(Opacity, double);
104 
106 
109  vtkSetClampMacro(Ambient, double, 0.0, 1.0);
110  vtkGetMacro(Ambient, double);
112 
114 
117  vtkSetClampMacro(Diffuse, double, 0.0, 1.0);
118  vtkGetMacro(Diffuse, double);
120 
122 
125  vtkSetClampMacro(InterpolationType, int,
127  vtkGetMacro(InterpolationType, int);
129  this->SetInterpolationType(VTK_NEAREST_INTERPOLATION); };
131  this->SetInterpolationType(VTK_LINEAR_INTERPOLATION); };
133  this->SetInterpolationType(VTK_CUBIC_INTERPOLATION); };
134  virtual const char *GetInterpolationTypeAsString();
136 
138 
142  vtkSetMacro(LayerNumber, int);
144  { return this->LayerNumber; }
146 
148 
152  vtkSetMacro(Checkerboard, int);
153  vtkBooleanMacro(Checkerboard, int);
154  vtkGetMacro(Checkerboard, int);
156 
158 
161  vtkSetVector2Macro(CheckerboardSpacing, double);
162  vtkGetVector2Macro(CheckerboardSpacing, double);
164 
166 
170  vtkSetVector2Macro(CheckerboardOffset, double);
171  vtkGetVector2Macro(CheckerboardOffset, double);
173 
175 
181  vtkSetMacro(Backing, int);
182  vtkBooleanMacro(Backing, int);
183  vtkGetMacro(Backing, int);
185 
187 
190  vtkSetVector3Macro(BackingColor, double);
191  vtkGetVector3Macro(BackingColor, double);
193 
199 
200 protected:
203 
205  double ColorWindow;
206  double ColorLevel;
210  double Opacity;
211  double Ambient;
212  double Diffuse;
214  double CheckerboardSpacing[2];
215  double CheckerboardOffset[2];
216  int Backing;
217  double BackingColor[3];
218 
219 private:
220  vtkImageProperty(const vtkImageProperty&) VTK_DELETE_FUNCTION;
221  void operator=(const vtkImageProperty&) VTK_DELETE_FUNCTION;
222 };
223 
224 #endif
vtkImageProperty::ColorWindow
double ColorWindow
Definition: vtkImageProperty.h:205
vtkImageProperty::Checkerboard
int Checkerboard
Definition: vtkImageProperty.h:213
vtkImageProperty::ColorLevel
double ColorLevel
Definition: vtkImageProperty.h:206
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkImageProperty::UseLookupTableScalarRange
int UseLookupTableScalarRange
Definition: vtkImageProperty.h:207
VTK_CUBIC_INTERPOLATION
#define VTK_CUBIC_INTERPOLATION
Definition: vtkSystemIncludes.h:109
vtkImageProperty::DeepCopy
void DeepCopy(vtkImageProperty *p)
Assign one property to another.
vtkImageProperty::Opacity
double Opacity
Definition: vtkImageProperty.h:210
VTK_NEAREST_INTERPOLATION
#define VTK_NEAREST_INTERPOLATION
Definition: vtkSystemIncludes.h:107
vtkImageProperty::~vtkImageProperty
~vtkImageProperty()
vtkImageProperty::vtkImageProperty
vtkImageProperty()
vtkImageProperty::Backing
int Backing
Definition: vtkImageProperty.h:216
vtkMTimeType
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
vtkImageProperty::GetLayerNumber
int GetLayerNumber()
Definition: vtkImageProperty.h:143
vtkImageProperty::Diffuse
double Diffuse
Definition: vtkImageProperty.h:212
vtkImageProperty::LayerNumber
int LayerNumber
Definition: vtkImageProperty.h:209
vtkImageProperty
image display properties
Definition: vtkImageProperty.h:43
vtkImageProperty::SetInterpolationTypeToLinear
void SetInterpolationTypeToLinear()
Definition: vtkImageProperty.h:130
vtkImageProperty::SetLookupTable
virtual void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the data.
vtkImageProperty::SetInterpolationTypeToNearest
void SetInterpolationTypeToNearest()
Definition: vtkImageProperty.h:128
vtkImageProperty::SetInterpolationTypeToCubic
void SetInterpolationTypeToCubic()
Definition: vtkImageProperty.h:132
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkImageProperty::LookupTable
vtkScalarsToColors * LookupTable
Definition: vtkImageProperty.h:204
VTK_LINEAR_INTERPOLATION
#define VTK_LINEAR_INTERPOLATION
Definition: vtkSystemIncludes.h:108
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:67
vtkImageProperty::New
static vtkImageProperty * New()
Construct a property with no lookup table.
vtkImageProperty::GetMTime
vtkMTimeType GetMTime()
Get the MTime for this property.
vtkObject.h
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkImageProperty::Ambient
double Ambient
Definition: vtkImageProperty.h:211
vtkImageProperty::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkImageProperty::GetInterpolationTypeAsString
virtual const char * GetInterpolationTypeAsString()
vtkImageProperty::InterpolationType
int InterpolationType
Definition: vtkImageProperty.h:208