VTK  9.2.6
vtkVolumeProperty.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkVolumeProperty.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=========================================================================*/
15
61#ifndef vtkVolumeProperty_h
62#define vtkVolumeProperty_h
63
64#include "vtkImplicitFunction.h" // For vtkImplicitFunction
65#include "vtkNew.h" // Needed for vtkNew
66#include "vtkObject.h"
67#include "vtkRenderingCoreModule.h" // For export macro
68#include "vtkSmartPointer.h" // Needed for vtkSmartPointer
69
70// STL includes
71#include <set> // For labelmap labels set
72#include <unordered_map> // For labelmap transfer function maps
73
76class vtkImageData;
78class vtkTimeStamp;
79
80class VTKRENDERINGCORE_EXPORT vtkVolumeProperty : public vtkObject
81{
82public:
85 void PrintSelf(ostream& os, vtkIndent indent) override;
87
93
95
116 vtkSetClampMacro(IndependentComponents, vtkTypeBool, 0, 1);
117 vtkGetMacro(IndependentComponents, vtkTypeBool);
118 vtkBooleanMacro(IndependentComponents, vtkTypeBool);
120
122
126 vtkSetClampMacro(InterpolationType, int, VTK_NEAREST_INTERPOLATION, VTK_LINEAR_INTERPOLATION);
127 vtkGetMacro(InterpolationType, int);
128 void SetInterpolationTypeToNearest() { this->SetInterpolationType(VTK_NEAREST_INTERPOLATION); }
129 void SetInterpolationTypeToLinear() { this->SetInterpolationType(VTK_LINEAR_INTERPOLATION); }
130 const char* GetInterpolationTypeAsString(void);
132
134
138 virtual void SetComponentWeight(int index, double value);
139 virtual double GetComponentWeight(int index);
141
147 void SetColor(int index, vtkPiecewiseFunction* function);
148 void SetColor(vtkPiecewiseFunction* function) { this->SetColor(0, function); }
149
156 void SetColor(int index, vtkColorTransferFunction* function);
157 void SetColor(vtkColorTransferFunction* function) { this->SetColor(0, function); }
158
163 int GetColorChannels(int index);
164 int GetColorChannels() { return this->GetColorChannels(0); }
165
173
181
186 void SetScalarOpacity(int index, vtkPiecewiseFunction* function);
187 void SetScalarOpacity(vtkPiecewiseFunction* function) { this->SetScalarOpacity(0, function); }
188
196
198
204 void SetScalarOpacityUnitDistance(int index, double distance);
205 void SetScalarOpacityUnitDistance(double distance)
206 {
207 this->SetScalarOpacityUnitDistance(0, distance);
208 }
212
217 void SetGradientOpacity(int index, vtkPiecewiseFunction* function);
218 void SetGradientOpacity(vtkPiecewiseFunction* function) { this->SetGradientOpacity(0, function); }
219
221
227 void SetTransferFunction2D(int index, vtkImageData* function);
228 void SetTransferFunction2D(vtkImageData* function) { this->SetTransferFunction2D(0, function); };
229
232
241 {
242 TF_1D = 0,
243 TF_2D
244 };
245
246 vtkSetClampMacro(TransferFunctionMode, int, 0, 1);
247 vtkGetMacro(TransferFunctionMode, int);
248 void SetTransferFunctionModeTo1D() { this->SetTransferFunctionMode(TF_1D); }
249 void SetTransferFunctionModeTo2D() { this->SetTransferFunctionMode(TF_2D); }
251
262
264
271 virtual void SetDisableGradientOpacity(int index, int value);
272 virtual void SetDisableGradientOpacity(int value) { this->SetDisableGradientOpacity(0, value); }
273 virtual void DisableGradientOpacityOn(int index) { this->SetDisableGradientOpacity(index, 1); }
275 virtual void DisableGradientOpacityOff(int index) { this->SetDisableGradientOpacity(index, 0); }
277 virtual int GetDisableGradientOpacity(int index);
278 virtual int GetDisableGradientOpacity() { return this->GetDisableGradientOpacity(0); }
282
289 bool HasGradientOpacity(int index = 0)
290 {
291 switch (this->TransferFunctionMode)
292 {
293 case TF_1D:
294 return (this->GradientOpacity[index] != nullptr);
295 case TF_2D:
296 return true;
297 }
298 return false;
299 }
300
301 /*
302 * Check whether or not we have label map gradient opacity functions.
303 */
304 bool HasLabelGradientOpacity() { return !this->LabelGradientOpacity.empty(); }
305
307
327 void SetShade(int index, int value);
328 void SetShade(int value) { this->SetShade(0, value); }
329 int GetShade(int index);
330 int GetShade() { return this->GetShade(0); }
331 void ShadeOn(int index);
332 void ShadeOn() { this->ShadeOn(0); }
333 void ShadeOff(int index);
334 void ShadeOff() { this->ShadeOff(0); }
336
338
341 void SetAmbient(int index, double value);
342 void SetAmbient(double value) { this->SetAmbient(0, value); }
343 double GetAmbient(int index);
344 double GetAmbient() { return this->GetAmbient(0); }
346
348
351 void SetDiffuse(int index, double value);
352 void SetDiffuse(double value) { this->SetDiffuse(0, value); }
353 double GetDiffuse(int index);
354 double GetDiffuse() { return this->GetDiffuse(0); }
356
358
361 void SetSpecular(int index, double value);
362 void SetSpecular(double value) { this->SetSpecular(0, value); }
363 double GetSpecular(int index);
364 double GetSpecular() { return this->GetSpecular(0); }
366
368
371 void SetSpecularPower(int index, double value);
372 void SetSpecularPower(double value) { this->SetSpecularPower(0, value); }
373 double GetSpecularPower(int index);
374 double GetSpecularPower() { return this->GetSpecularPower(0); }
376
382
384
391
393
400 vtkSetClampMacro(ScatteringAnisotropy, float, -1.0, 1.0);
401 vtkGetMacro(ScatteringAnisotropy, float);
403
412
419
426
433
440
442
451 vtkSetMacro(UseClippedVoxelIntensity, int);
452 vtkGetMacro(UseClippedVoxelIntensity, int);
453 vtkBooleanMacro(UseClippedVoxelIntensity, int);
455
457
466 vtkSetMacro(ClippedVoxelIntensity, double);
467 vtkGetMacro(ClippedVoxelIntensity, double);
469
471
474 void SetLabelColor(int label, vtkColorTransferFunction* function);
477
479
482 void SetLabelScalarOpacity(int label, vtkPiecewiseFunction* function);
485
487
493
498 vtkGetMacro(LabelColorMTime, vtkTimeStamp);
499
504 vtkGetMacro(LabelScalarOpacityMTime, vtkTimeStamp);
505
510 vtkGetMacro(LabelGradientOpacityMTime, vtkTimeStamp);
511
516 std::size_t GetNumberOfLabels();
517
522 std::set<int> GetLabelMapLabels();
523
524protected:
527
534
535 virtual void CreateDefaultGradientOpacity(int index);
536
538 double ComponentWeight[VTK_MAX_VRCOMP];
539
541
542 float ScatteringAnisotropy = 0.0;
543
544 int ColorChannels[VTK_MAX_VRCOMP];
545
546 vtkPiecewiseFunction* GrayTransferFunction[VTK_MAX_VRCOMP];
547 vtkTimeStamp GrayTransferFunctionMTime[VTK_MAX_VRCOMP];
548
550 vtkTimeStamp RGBTransferFunctionMTime[VTK_MAX_VRCOMP];
551
553 vtkTimeStamp ScalarOpacityMTime[VTK_MAX_VRCOMP];
554 double ScalarOpacityUnitDistance[VTK_MAX_VRCOMP];
555
557 vtkTimeStamp GradientOpacityMTime[VTK_MAX_VRCOMP];
558
559 vtkPiecewiseFunction* DefaultGradientOpacity[VTK_MAX_VRCOMP];
560 int DisableGradientOpacity[VTK_MAX_VRCOMP];
561
563 vtkImageData* TransferFunction2D[VTK_MAX_VRCOMP];
564 vtkTimeStamp TransferFunction2DMTime[VTK_MAX_VRCOMP];
565
569
570 int Shade[VTK_MAX_VRCOMP];
571 double Ambient[VTK_MAX_VRCOMP];
572 double Diffuse[VTK_MAX_VRCOMP];
573 double Specular[VTK_MAX_VRCOMP];
574 double SpecularPower[VTK_MAX_VRCOMP];
575
578
583
588
592 std::unordered_map<int, vtkColorTransferFunction*> LabelColor;
593 std::unordered_map<int, vtkPiecewiseFunction*> LabelScalarOpacity;
594 std::unordered_map<int, vtkPiecewiseFunction*> LabelGradientOpacity;
595 std::set<int> LabelMapLabels;
596
597private:
598 vtkVolumeProperty(const vtkVolumeProperty&) = delete;
599 void operator=(const vtkVolumeProperty&) = delete;
600};
601
606{
608 {
609 return "Nearest Neighbor";
610 }
612 {
613 return "Linear";
614 }
615 return "Unknown";
616}
617
618#endif
Defines a transfer function for mapping a property to an RGB color value.
helper object to manage setting and generating contour values
topologically and geometrically regular array of data
abstract interface for implicit functions
a simple class to control print indentation
Definition vtkIndent.h:40
Allocate and hold a VTK object.
Definition vtkNew.h:62
abstract base class for most VTK objects
Definition vtkObject.h:63
Defines a 1D piecewise function.
Hold a reference to a vtkObjectBase instance.
record modification and/or execution time
represents the common properties for rendering a volume.
void SetSpecular(int index, double value)
Set/Get the specular lighting coefficient.
void SetDiffuse(double value)
Set/Get the diffuse lighting coefficient.
void SetAmbient(int index, double value)
Set/Get the ambient lighting coefficient.
vtkMTimeType GetMTime() override
Get the modified time for this object (or the properties registered with this object).
double GetAmbient(int index)
Set/Get the ambient lighting coefficient.
virtual double GetComponentWeight(int index)
Set/Get the scalar component weights.
vtkPiecewiseFunction * GetLabelGradientOpacity(int label)
Set/Get the gradient opacity function for a label in the label map.
vtkTimeStamp LabelGradientOpacityMTime
vtkImageData * GetTransferFunction2D(int index)
Color-opacity transfer function mode.
vtkPiecewiseFunction * GetStoredGradientOpacity()
Enable/Disable the gradient opacity function for the given component.
vtkTimeStamp GetRGBTransferFunctionMTime()
void SetShade(int index, int value)
Set/Get the shading of a volume.
void ShadeOn()
Set/Get the shading of a volume.
void SetScalarOpacityUnitDistance(double distance)
Set/Get the unit distance on which the scalar opacity transfer function is defined.
void SetLabelScalarOpacity(int label, vtkPiecewiseFunction *function)
Set/Get the opacity transfer function for a label in the label map.
vtkImageData * GetTransferFunction2D()
Color-opacity transfer function mode.
std::size_t GetNumberOfLabels()
Get the number of labels that are provided with transfer functions using either SetLabelColor,...
virtual int GetDisableGradientOpacity(int index)
Enable/Disable the gradient opacity function for the given component.
void SetTransferFunction2D(vtkImageData *function)
Color-opacity transfer function mode.
void SetSpecular(double value)
Set/Get the specular lighting coefficient.
vtkPiecewiseFunction * GetGrayTransferFunction()
void SetColor(vtkPiecewiseFunction *function)
vtkTimeStamp GetGrayTransferFunctionMTime(int index)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the GrayTransferFunction wa...
vtkTimeStamp LabelColorMTime
double GetSpecular()
Set/Get the specular lighting coefficient.
vtkGetSmartPointerMacro(SliceFunction, vtkImplicitFunction)
Get/Set the function used for slicing.
vtkContourValues * GetIsoSurfaceValues()
Get contour values for isosurface blending mode.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSmartPointer< vtkImplicitFunction > SliceFunction
Function used for slice.
double GetSpecularPower(int index)
Set/Get the specular power.
vtkPiecewiseFunction * GetStoredGradientOpacity(int index)
Enable/Disable the gradient opacity function for the given component.
vtkColorTransferFunction * GetRGBTransferFunction()
void SetTransferFunction2D(int index, vtkImageData *function)
Set/Get a 2D transfer function.
vtkTimeStamp GetScalarOpacityMTime()
void SetGradientOpacity(int index, vtkPiecewiseFunction *function)
Set the opacity of a volume to an opacity transfer function based on gradient magnitude for the given...
void SetTransferFunctionModeTo1D()
Color-opacity transfer function mode.
double GetSpecularPower()
Set/Get the specular power.
virtual void DisableGradientOpacityOn(int index)
Enable/Disable the gradient opacity function for the given component.
void SetSpecularPower(double value)
Set/Get the specular power.
double GetScalarOpacityUnitDistance()
Set/Get the unit distance on which the scalar opacity transfer function is defined.
void SetTransferFunctionModeTo2D()
Color-opacity transfer function mode.
virtual void DisableGradientOpacityOff(int index)
Enable/Disable the gradient opacity function for the given component.
void ShadeOn(int index)
Set/Get the shading of a volume.
void ShadeOff(int index)
Set/Get the shading of a volume.
void SetShade(int value)
Set/Get the shading of a volume.
void SetScalarOpacityUnitDistance(int index, double distance)
Set/Get the unit distance on which the scalar opacity transfer function is defined.
vtkPiecewiseFunction * GetScalarOpacity()
std::unordered_map< int, vtkPiecewiseFunction * > LabelScalarOpacity
vtkPiecewiseFunction * GetScalarOpacity(int index)
Get the scalar opacity transfer function for the given component.
virtual void SetComponentWeight(int index, double value)
Set/Get the scalar component weights.
double GetDiffuse()
Set/Get the diffuse lighting coefficient.
virtual void SetDisableGradientOpacity(int index, int value)
Enable/Disable the gradient opacity function for the given component.
vtkTypeBool IndependentComponents
void SetAmbient(double value)
Set/Get the ambient lighting coefficient.
vtkTimeStamp GetGrayTransferFunctionMTime()
std::set< int > LabelMapLabels
virtual void DisableGradientOpacityOff()
Enable/Disable the gradient opacity function for the given component.
vtkPiecewiseFunction * GetGradientOpacity()
virtual void SetDisableGradientOpacity(int value)
Enable/Disable the gradient opacity function for the given component.
void SetLabelColor(int label, vtkColorTransferFunction *function)
Set/Get the color transfer function for a label in the label map.
std::set< int > GetLabelMapLabels()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get access to the internal set that keeps tra...
int GetShade()
Set/Get the shading of a volume.
void UpdateMTimes()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE UpdateMTimes performs a Modified() on all Tim...
void SetInterpolationTypeToNearest()
Set the interpolation type for sampling a volume.
int GetColorChannels(int index)
Get the number of color channels in the transfer function for the given component.
const char * GetInterpolationTypeAsString(void)
Return the interpolation type as a descriptive character string.
vtkPiecewiseFunction * GetLabelScalarOpacity(int label)
Set/Get the opacity transfer function for a label in the label map.
virtual void DisableGradientOpacityOn()
Enable/Disable the gradient opacity function for the given component.
void DeepCopy(vtkVolumeProperty *p)
TransferMode
Color-opacity transfer function mode.
vtkTimeStamp GetRGBTransferFunctionMTime(int index)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the RGBTransferFunction was...
static vtkVolumeProperty * New()
void SetLabelGradientOpacity(int label, vtkPiecewiseFunction *function)
Set/Get the gradient opacity function for a label in the label map.
bool HasGradientOpacity(int index=0)
Check whether or not we have the gradient opacity.
void SetSpecularPower(int index, double value)
Set/Get the specular power.
vtkTimeStamp GetTransferFunction2DMTime(int index)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time when the TransferFunction2D was ...
void SetScalarOpacity(int index, vtkPiecewiseFunction *function)
Set the opacity of a volume to an opacity transfer function based on scalar value for the component i...
int GetShade(int index)
Set/Get the shading of a volume.
void SetColor(int index, vtkColorTransferFunction *function)
Set the color of a volume to an RGB transfer function for the component indicated by index.
vtkNew< vtkContourValues > IsoSurfaceValues
Contour values for isosurface blend mode.
std::unordered_map< int, vtkColorTransferFunction * > LabelColor
Label map transfer functions.
void ShadeOff()
Set/Get the shading of a volume.
vtkTimeStamp GetTransferFunction2DMTime()
void SetColor(int index, vtkPiecewiseFunction *function)
Set the color of a volume to a gray level transfer function for the component indicated by index.
vtkColorTransferFunction * GetLabelColor(int label)
Set/Get the color transfer function for a label in the label map.
vtkPiecewiseFunction * GetGrayTransferFunction(int index)
Get the gray transfer function.
void SetInterpolationTypeToLinear()
Set the interpolation type for sampling a volume.
std::unordered_map< int, vtkPiecewiseFunction * > LabelGradientOpacity
vtkColorTransferFunction * GetRGBTransferFunction(int index)
Get the RGB transfer function for the given component.
double GetAmbient()
Set/Get the ambient lighting coefficient.
void SetGradientOpacity(vtkPiecewiseFunction *function)
vtkSetSmartPointerMacro(SliceFunction, vtkImplicitFunction)
Get/Set the function used for slicing.
void SetScalarOpacity(vtkPiecewiseFunction *function)
double GetDiffuse(int index)
Set/Get the diffuse lighting coefficient.
virtual int GetDisableGradientOpacity()
Enable/Disable the gradient opacity function for the given component.
void SetColor(vtkColorTransferFunction *function)
~vtkVolumeProperty() override
double GetScalarOpacityUnitDistance(int index)
Set/Get the unit distance on which the scalar opacity transfer function is defined.
vtkTimeStamp GetGradientOpacityMTime(int index)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the gradient opacity transf...
virtual void CreateDefaultGradientOpacity(int index)
vtkTimeStamp GetScalarOpacityMTime(int index)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the scalar opacity transfer...
vtkTimeStamp GetGradientOpacityMTime()
void SetDiffuse(int index, double value)
Set/Get the diffuse lighting coefficient.
vtkPiecewiseFunction * GetGradientOpacity(int index)
Get the gradient magnitude opacity transfer function for the given component.
vtkTimeStamp LabelScalarOpacityMTime
double GetSpecular(int index)
Set/Get the specular lighting coefficient.
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_MAX_VRCOMP
#define VTK_NEAREST_INTERPOLATION
#define VTK_LINEAR_INTERPOLATION
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287