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 =========================================================================*/
33 #ifndef vtkImageProperty_h
34 #define vtkImageProperty_h
35 
36 #include "vtkRenderingCoreModule.h" // For export macro
37 #include "vtkObject.h"
38 
39 class vtkScalarsToColors;
40 
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent);
46 
48  static vtkImageProperty *New();
49 
52 
54 
55  vtkSetMacro(ColorWindow, double);
56  vtkGetMacro(ColorWindow, double);
58 
60 
61  vtkSetMacro(ColorLevel, double);
62  vtkGetMacro(ColorLevel, double);
64 
66 
69  virtual void SetLookupTable(vtkScalarsToColors *lut);
72 
74 
76  vtkSetMacro(UseLookupTableScalarRange, int);
77  vtkGetMacro(UseLookupTableScalarRange, int);
78  vtkBooleanMacro(UseLookupTableScalarRange, int);
80 
82 
85  vtkSetClampMacro(Opacity, double, 0.0, 1.0);
86  vtkGetMacro(Opacity, double);
88 
90 
91  vtkSetClampMacro(Ambient, double, 0.0, 1.0);
92  vtkGetMacro(Ambient, double);
94 
96 
97  vtkSetClampMacro(Diffuse, double, 0.0, 1.0);
98  vtkGetMacro(Diffuse, double);
100 
102 
103  vtkSetClampMacro(InterpolationType, int,
105  vtkGetMacro(InterpolationType, int);
107  this->SetInterpolationType(VTK_NEAREST_INTERPOLATION); };
109  this->SetInterpolationType(VTK_LINEAR_INTERPOLATION); };
111  this->SetInterpolationType(VTK_CUBIC_INTERPOLATION); };
112  virtual const char *GetInterpolationTypeAsString();
114 
116 
118  vtkSetMacro(LayerNumber, int);
120  { return this->LayerNumber; }
122 
124 
126  vtkSetMacro(Checkerboard, int);
127  vtkBooleanMacro(Checkerboard, int);
128  vtkGetMacro(Checkerboard, int);
130 
132 
133  vtkSetVector2Macro(CheckerboardSpacing, double);
134  vtkGetVector2Macro(CheckerboardSpacing, double);
136 
138 
140  vtkSetVector2Macro(CheckerboardOffset, double);
141  vtkGetVector2Macro(CheckerboardOffset, double);
143 
145 
149  vtkSetMacro(Backing, int);
150  vtkBooleanMacro(Backing, int);
151  vtkGetMacro(Backing, int);
153 
155 
156  vtkSetVector3Macro(BackingColor, double);
157  vtkGetVector3Macro(BackingColor, double);
159 
162  unsigned long GetMTime();
163 
164 protected:
167 
169  double ColorWindow;
170  double ColorLevel;
174  double Opacity;
175  double Ambient;
176  double Diffuse;
178  double CheckerboardSpacing[2];
179  double CheckerboardOffset[2];
180  int Backing;
181  double BackingColor[3];
182 
183 private:
184  vtkImageProperty(const vtkImageProperty&); // Not implemented.
185  void operator=(const vtkImageProperty&); // Not implemented.
186 };
187 
188 #endif
vtkGetObjectMacro
#define vtkGetObjectMacro(name, type)
Definition: vtkSetGet.h:232
vtkImageProperty::ColorWindow
double ColorWindow
Definition: vtkImageProperty.h:169
vtkSetVector2Macro
#define vtkSetVector2Macro(name, type)
Definition: vtkSetGet.h:254
vtkImageProperty::GetMTime
unsigned long GetMTime()
vtkImageProperty::Checkerboard
int Checkerboard
Definition: vtkImageProperty.h:177
vtkGetVector2Macro
#define vtkGetVector2Macro(name, type)
Definition: vtkSetGet.h:270
vtkSetVector3Macro
#define vtkSetVector3Macro(name, type)
Definition: vtkSetGet.h:287
vtkImageProperty::ColorLevel
double ColorLevel
Definition: vtkImageProperty.h:170
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkImageProperty::UseLookupTableScalarRange
int UseLookupTableScalarRange
Definition: vtkImageProperty.h:171
VTK_CUBIC_INTERPOLATION
#define VTK_CUBIC_INTERPOLATION
Definition: vtkSystemIncludes.h:105
vtkImageProperty::DeepCopy
void DeepCopy(vtkImageProperty *p)
vtkImageProperty::Opacity
double Opacity
Definition: vtkImageProperty.h:174
VTK_NEAREST_INTERPOLATION
#define VTK_NEAREST_INTERPOLATION
Definition: vtkSystemIncludes.h:103
vtkImageProperty::~vtkImageProperty
~vtkImageProperty()
vtkImageProperty::vtkImageProperty
vtkImageProperty()
vtkImageProperty::Backing
int Backing
Definition: vtkImageProperty.h:180
vtkImageProperty::GetLayerNumber
int GetLayerNumber()
Definition: vtkImageProperty.h:119
vtkImageProperty::Diffuse
double Diffuse
Definition: vtkImageProperty.h:176
vtkSetClampMacro
#define vtkSetClampMacro(name, type, min, max)
Definition: vtkSetGet.h:143
vtkGetVector3Macro
#define vtkGetVector3Macro(name, type)
Definition: vtkSetGet.h:304
vtkImageProperty::LayerNumber
int LayerNumber
Definition: vtkImageProperty.h:173
vtkImageProperty
image display properties
Definition: vtkImageProperty.h:42
vtkImageProperty::SetInterpolationTypeToLinear
void SetInterpolationTypeToLinear()
Definition: vtkImageProperty.h:108
vtkImageProperty::SetLookupTable
virtual void SetLookupTable(vtkScalarsToColors *lut)
vtkImageProperty::SetInterpolationTypeToNearest
void SetInterpolationTypeToNearest()
Definition: vtkImageProperty.h:106
vtkImageProperty::SetInterpolationTypeToCubic
void SetInterpolationTypeToCubic()
Definition: vtkImageProperty.h:110
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkRenderingCoreModule.h
vtkImageProperty::LookupTable
vtkScalarsToColors * LookupTable
Definition: vtkImageProperty.h:168
VTK_LINEAR_INTERPOLATION
#define VTK_LINEAR_INTERPOLATION
Definition: vtkSystemIncludes.h:104
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:63
vtkImageProperty::New
static vtkImageProperty * New()
vtkObject.h
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
vtkImageProperty::Ambient
double Ambient
Definition: vtkImageProperty.h:175
vtkgl::p
GLfloat GLfloat p
Definition: vtkgl.h:15717
vtkImageProperty::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
VTKRENDERINGCORE_EXPORT
#define VTKRENDERINGCORE_EXPORT
Definition: vtkRenderingCoreModule.h:15
vtkImageProperty::GetInterpolationTypeAsString
virtual const char * GetInterpolationTypeAsString()
vtkImageProperty::InterpolationType
int InterpolationType
Definition: vtkImageProperty.h:172