VTK  9.2.6
vtkSmartVolumeMapper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkSmartVolumeMapper.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=========================================================================*/
75
76#ifndef vtkSmartVolumeMapper_h
77#define vtkSmartVolumeMapper_h
78
79#include "vtkImageReslice.h" // for VTK_RESLICE_NEAREST, VTK_RESLICE_CUBIC
80#include "vtkRenderingVolumeOpenGL2Module.h" // For export macro
81#include "vtkVolumeMapper.h"
82
88class vtkRenderWindow;
89class vtkVolume;
92
93class VTKRENDERINGVOLUMEOPENGL2_EXPORT vtkSmartVolumeMapper : public vtkVolumeMapper
94{
95public:
98 void PrintSelf(ostream& os, vtkIndent indent) override;
99
101
111 vtkSetMacro(FinalColorWindow, float);
113
115
118 vtkGetMacro(FinalColorWindow, float);
120
122
129 vtkSetMacro(FinalColorLevel, float);
131
133
136 vtkGetMacro(FinalColorLevel, float);
138
139 // The possible values for the default and current render mode ivars
140 enum
141 {
148 };
149
155
162
169
176
182
184
187 vtkGetMacro(RequestedRenderMode, int);
189
195
197
207
209
215 vtkSetClampMacro(MaxMemoryFraction, float, 0.1f, 1.0f);
216 vtkGetMacro(MaxMemoryFraction, float);
218
220
225 vtkGetMacro(InterpolationMode, int);
230
237 vtkImageData* image, int blend_mode, double viewDirection[3], double viewUp[3]);
238
240
246 vtkSetClampMacro(InteractiveUpdateRate, double, 1.0e-10, 1.0e10);
248
250
255 vtkGetMacro(InteractiveUpdateRate, double);
257
259
271
273
282 vtkSetClampMacro(AutoAdjustSampleDistances, vtkTypeBool, 0, 1);
286
288
295 vtkSetMacro(SampleDistance, float);
296 vtkGetMacro(SampleDistance, float);
298
300
306 vtkSetClampMacro(GlobalIlluminationReach, float, 0.0f, 1.0f);
307 vtkGetMacro(GlobalIlluminationReach, float);
309
311
317 vtkSetClampMacro(VolumetricScatteringBlending, float, 0.0f, 2.0f);
318 vtkGetMacro(VolumetricScatteringBlending, float);
320
325 void Render(vtkRenderer*, vtkVolume*) override;
326
334
336
344 {
348 };
349
350 void SetVectorMode(int mode);
351 vtkGetMacro(VectorMode, int);
352
353 vtkSetClampMacro(VectorComponent, int, 0, 3);
354 vtkGetMacro(VectorComponent, int);
356
358
361 vtkSetStringMacro(Transfer2DYAxisArray);
362 vtkGetStringMacro(Transfer2DYAxisArray);
364
365protected:
368
375
382
384
390
392
398
403
405
413
415
424
430
432
444
450
456
462
464
471
478
483
488
493
499
506
515
517
528
530
537
544
545private:
547
551 void SetupVectorMode(vtkVolume* vol);
557 void ComputeMagnitudeCellData(vtkDataSet* input, vtkDataArray* arr);
558 void ComputeMagnitudePointData(vtkDataSet* input, vtkDataArray* arr);
560
562 void operator=(const vtkSmartVolumeMapper&) = delete;
563
564 vtkOSPRayVolumeInterface* OSPRayMapper;
565};
566
567#endif
abstract class to specify dataset behavior
Definition vtkDataSet.h:63
Ray casting performed on the GPU.
topologically and geometrically regular array of data
Resamples an image to be larger or smaller.
a simple class to control print indentation
Definition vtkIndent.h:40
Mapper to render volumes defined as vtkMultiBlockDataSet.
Removes link dependence on optional ospray module.
create a window for renderers to draw into
abstract specification for renderers
Definition vtkRenderer.h:73
float MaxMemoryFraction
GPU mapper-specific memory ivars.
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
vtkTypeBool AutoAdjustSampleDistances
Set whether or not the sample distance should be automatically calculated within the internal volume ...
int Initialized
Initialization variables.
int VectorMode
VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's ...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestedRenderMode
The requested render mode is used to compute the current render mode.
int GetLastUsedRenderMode()
This will return the render mode used during the previous call to Render().
vtkImageResample * GPUResampleFilter
This is the resample filter that may be used if we need to create a low resolution version of the vol...
vtkFixedPointVolumeRayCastMapper * RayCastMapper
The three potential mappers.
vtkImageData * InputDataMagnitude
This filter is used to compute the magnitude of 3-component data.
float SampleDistance
The distance between sample points along the ray.
vtkDataSet * LastInput
Keep a cache of the last input to the mapper so that input data changes can be propagated to the resa...
vtkIdType MaxMemoryInBytes
GPU mapper-specific memory ivars.
void SetVectorMode(int mode)
VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's ...
void Initialize(vtkRenderer *ren, vtkVolume *vol)
The initialize method.
int InitializedBlendMode
We need to keep track of the blend mode we had when we initialized because we need to reinitialize (a...
void SetInterpolationModeToLinear()
Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
void ConnectFilterInput(vtkImageResample *f)
Connect input of the vtkSmartVolumeMapper to the input of the internal resample filter by doing a sha...
void SetRequestedRenderModeToOSPRay()
Set the requested render mode to vtkSmartVolumeMapper::OSPRayRenderMode.
void CreateCanonicalView(vtkRenderer *ren, vtkVolume *volume, vtkVolume *volume2, vtkImageData *image, int blend_mode, double viewDirection[3], double viewUp[3])
This method can be used to render a representative view of the input data into the supplied image giv...
float GlobalIlluminationReach
Secondary rays ambient/global adjustment coefficient.
int CurrentRenderMode
The requested render mode is used to compute the current render mode.
friend class vtkMultiBlockVolumeMapper
Expose GPU mapper for additional customization.
~vtkSmartVolumeMapper() override
vtkDataSet * LastFilterInput
Keep a cache of the last input to the mapper so that input data changes can be propagated to the resa...
void SetInterpolationModeToNearestNeighbor()
Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
void SetRequestedRenderMode(int mode)
Set the requested render mode.
float FinalColorLevel
Window / level ivars.
static vtkSmartVolumeMapper * New()
double InteractiveUpdateRate
If the DesiredUpdateRate of the vtkRenderWindow causing the Render is at or above this value,...
void ConnectMapperInput(vtkVolumeMapper *m)
Connect input of the vtkSmartVolumeMapper to the input of the internal volume mapper by doing a shall...
int VectorComponent
VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's ...
vtkTypeBool InteractiveAdjustSampleDistances
If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and ...
int InterpolationMode
Used for downsampling.
vtkTimeStamp SupportStatusCheckTime
Initialization variables.
void SetRequestedRenderModeToRayCast()
Set the requested render mode to vtkSmartVolumeMapper::RayCastRenderMode.
vtkGPUVolumeRayCastMapper * GPUMapper
The three potential mappers.
void SetRequestedRenderModeToGPU()
Set the requested render mode to vtkSmartVolumeMapper::GPURenderMode.
vtkGPUVolumeRayCastMapper * GPULowResMapper
The three potential mappers.
float FinalColorWindow
Window / level ivars.
vtkTimeStamp MagnitudeUploadTime
VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's ...
int GPUSupported
Initialization variables.
void SetRequestedRenderModeToDefault()
Set the requested render mode to vtkSmartVolumeMapper::DefaultRenderMode.
vtkImageMagnitude * ImageMagnitude
This filter is used to compute the magnitude of 3-component data.
int RayCastSupported
Initialization variables.
void ComputeRenderMode(vtkRenderer *ren, vtkVolume *vol)
The method that computes the render mode from the requested render mode based on the support status f...
void Render(vtkRenderer *, vtkVolume *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume.
char * Transfer2DYAxisArray
Define the array used for the Y axis of transfer 2D.
void SetInterpolationModeToCubic()
Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
int LowResGPUNecessary
Initialization variables.
VectorModeType
VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's ...
float VolumetricScatteringBlending
Blending coefficient between surfacic and volumetric models in GPU Mapper.
record modification and/or execution time
represents the common properties for rendering a volume.
represents a volume (data & properties) in a rendered scene
Definition vtkVolume.h:51
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
#define vtkDataArray
#define VTK_RESLICE_CUBIC
#define VTK_RESLICE_NEAREST
int vtkIdType
Definition vtkType.h:332