VTK  9.1.0
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
55#ifndef vtkVolumeProperty_h
56#define vtkVolumeProperty_h
57
58#include "vtkImplicitFunction.h" // For vtkImplicitFunction
59#include "vtkNew.h" // Needed for vtkNew
60#include "vtkObject.h"
61#include "vtkRenderingCoreModule.h" // For export macro
62#include "vtkSmartPointer.h" // Needed for vtkSmartPointer
63
64// STL includes
65#include <set> // For labelmap labels set
66#include <unordered_map> // For labelmap transfer function maps
67
70class vtkImageData;
72class vtkTimeStamp;
73
74class VTKRENDERINGCORE_EXPORT vtkVolumeProperty : public vtkObject
75{
76public:
79 void PrintSelf(ostream& os, vtkIndent indent) override;
81
87
89
110 vtkSetClampMacro(IndependentComponents, vtkTypeBool, 0, 1);
111 vtkGetMacro(IndependentComponents, vtkTypeBool);
112 vtkBooleanMacro(IndependentComponents, vtkTypeBool);
114
116
120 vtkSetClampMacro(InterpolationType, int, VTK_NEAREST_INTERPOLATION, VTK_LINEAR_INTERPOLATION);
121 vtkGetMacro(InterpolationType, int);
122 void SetInterpolationTypeToNearest() { this->SetInterpolationType(VTK_NEAREST_INTERPOLATION); }
123 void SetInterpolationTypeToLinear() { this->SetInterpolationType(VTK_LINEAR_INTERPOLATION); }
124 const char* GetInterpolationTypeAsString(void);
126
128
132 virtual void SetComponentWeight(int index, double value);
133 virtual double GetComponentWeight(int index);
135
142 void SetColor(vtkPiecewiseFunction* function) { this->SetColor(0, function); }
143
151 void SetColor(vtkColorTransferFunction* function) { this->SetColor(0, function); }
152
158 int GetColorChannels() { return this->GetColorChannels(0); }
159
167
175
182
190
192
198 void SetScalarOpacityUnitDistance(int index, double distance);
199 void SetScalarOpacityUnitDistance(double distance)
200 {
201 this->SetScalarOpacityUnitDistance(0, distance);
202 }
206
213
215
223
226
235 {
236 TF_1D = 0,
237 TF_2D
238 };
239
240 vtkSetClampMacro(TransferFunctionMode, int, 0, 1);
241 vtkGetMacro(TransferFunctionMode, int);
243
254
256
263 virtual void SetDisableGradientOpacity(int index, int value);
264 virtual void SetDisableGradientOpacity(int value) { this->SetDisableGradientOpacity(0, value); }
265 virtual void DisableGradientOpacityOn(int index) { this->SetDisableGradientOpacity(index, 1); }
267 virtual void DisableGradientOpacityOff(int index) { this->SetDisableGradientOpacity(index, 0); }
270 virtual int GetDisableGradientOpacity() { return this->GetDisableGradientOpacity(0); }
274
282 {
283 switch (this->TransferFunctionMode)
284 {
285 case TF_1D:
286 return (this->GradientOpacity[index] != nullptr);
287 case TF_2D:
288 return true;
289 }
290 return false;
291 }
292
293 /*
294 * Check whether or not we have label map gradient opacity functions.
295 */
296 bool HasLabelGradientOpacity() { return !this->LabelGradientOpacity.empty(); }
297
299
319 void SetShade(int index, int value);
320 void SetShade(int value) { this->SetShade(0, value); }
321 int GetShade(int index);
322 int GetShade() { return this->GetShade(0); }
323 void ShadeOn(int index);
324 void ShadeOn() { this->ShadeOn(0); }
325 void ShadeOff(int index);
326 void ShadeOff() { this->ShadeOff(0); }
328
330
333 void SetAmbient(int index, double value);
334 void SetAmbient(double value) { this->SetAmbient(0, value); }
335 double GetAmbient(int index);
336 double GetAmbient() { return this->GetAmbient(0); }
338
340
343 void SetDiffuse(int index, double value);
344 void SetDiffuse(double value) { this->SetDiffuse(0, value); }
345 double GetDiffuse(int index);
346 double GetDiffuse() { return this->GetDiffuse(0); }
348
350
353 void SetSpecular(int index, double value);
354 void SetSpecular(double value) { this->SetSpecular(0, value); }
355 double GetSpecular(int index);
356 double GetSpecular() { return this->GetSpecular(0); }
358
360
363 void SetSpecularPower(int index, double value);
364 void SetSpecularPower(double value) { this->SetSpecularPower(0, value); }
366 double GetSpecularPower() { return this->GetSpecularPower(0); }
368
374
376
383
392
399
406
413
420
422
431 vtkSetMacro(UseClippedVoxelIntensity, int);
432 vtkGetMacro(UseClippedVoxelIntensity, int);
433 vtkBooleanMacro(UseClippedVoxelIntensity, int);
435
437
446 vtkSetMacro(ClippedVoxelIntensity, double);
447 vtkGetMacro(ClippedVoxelIntensity, double);
449
451
457
459
465
467
473
478 vtkGetMacro(LabelColorMTime, vtkTimeStamp);
479
484 vtkGetMacro(LabelScalarOpacityMTime, vtkTimeStamp);
485
490 vtkGetMacro(LabelGradientOpacityMTime, vtkTimeStamp);
491
496 std::size_t GetNumberOfLabels();
497
502 std::set<int> GetLabelMapLabels();
503
504protected:
507
514
516
518 double ComponentWeight[VTK_MAX_VRCOMP];
519
521
522 int ColorChannels[VTK_MAX_VRCOMP];
523
524 vtkPiecewiseFunction* GrayTransferFunction[VTK_MAX_VRCOMP];
525 vtkTimeStamp GrayTransferFunctionMTime[VTK_MAX_VRCOMP];
526
528 vtkTimeStamp RGBTransferFunctionMTime[VTK_MAX_VRCOMP];
529
531 vtkTimeStamp ScalarOpacityMTime[VTK_MAX_VRCOMP];
532 double ScalarOpacityUnitDistance[VTK_MAX_VRCOMP];
533
535 vtkTimeStamp GradientOpacityMTime[VTK_MAX_VRCOMP];
536
537 vtkPiecewiseFunction* DefaultGradientOpacity[VTK_MAX_VRCOMP];
538 int DisableGradientOpacity[VTK_MAX_VRCOMP];
539
541 vtkImageData* TransferFunction2D[VTK_MAX_VRCOMP];
542 vtkTimeStamp TransferFunction2DMTime[VTK_MAX_VRCOMP];
543
547
548 int Shade[VTK_MAX_VRCOMP];
549 double Ambient[VTK_MAX_VRCOMP];
550 double Diffuse[VTK_MAX_VRCOMP];
551 double Specular[VTK_MAX_VRCOMP];
552 double SpecularPower[VTK_MAX_VRCOMP];
553
556
561
566
570 std::unordered_map<int, vtkColorTransferFunction*> LabelColor;
571 std::unordered_map<int, vtkPiecewiseFunction*> LabelScalarOpacity;
572 std::unordered_map<int, vtkPiecewiseFunction*> LabelGradientOpacity;
573 std::set<int> LabelMapLabels;
574
575private:
576 vtkVolumeProperty(const vtkVolumeProperty&) = delete;
577 void operator=(const vtkVolumeProperty&) = delete;
578};
579
584{
586 {
587 return "Nearest Neighbor";
588 }
590 {
591 return "Linear";
592 }
593 return "Unknown";
594}
595
596#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
Definition: vtkImageData.h:48
abstract interface for implicit functions
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
Defines a 1D piecewise function.
record modification and/or execution time
Definition: vtkTimeStamp.h:33
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...
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.
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.
@ function
Definition: vtkX3D.h:255
@ value
Definition: vtkX3D.h:226
@ index
Definition: vtkX3D.h:252
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_MAX_VRCOMP
#define VTK_NEAREST_INTERPOLATION
#define VTK_LINEAR_INTERPOLATION
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287