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=========================================================================*/
72
73#ifndef vtkSmartVolumeMapper_h
74#define vtkSmartVolumeMapper_h
75
76#include "vtkImageReslice.h" // for VTK_RESLICE_NEAREST, VTK_RESLICE_CUBIC
77#include "vtkRenderingVolumeOpenGL2Module.h" // For export macro
78#include "vtkVolumeMapper.h"
79
85class vtkRenderWindow;
86class vtkVolume;
89
90class VTKRENDERINGVOLUMEOPENGL2_EXPORT vtkSmartVolumeMapper : public vtkVolumeMapper
91{
92public:
95 void PrintSelf(ostream& os, vtkIndent indent) override;
96
98
108 vtkSetMacro(FinalColorWindow, float);
110
112
115 vtkGetMacro(FinalColorWindow, float);
117
119
126 vtkSetMacro(FinalColorLevel, float);
128
130
133 vtkGetMacro(FinalColorLevel, float);
135
136 // The possible values for the default and current render mode ivars
137 enum
138 {
145 };
146
152
159
166
173
179
181
184 vtkGetMacro(RequestedRenderMode, int);
186
192
194
204
206
212 vtkSetClampMacro(MaxMemoryFraction, float, 0.1f, 1.0f);
213 vtkGetMacro(MaxMemoryFraction, float);
215
217
222 vtkGetMacro(InterpolationMode, int);
227
234 vtkImageData* image, int blend_mode, double viewDirection[3], double viewUp[3]);
235
237
243 vtkSetClampMacro(InteractiveUpdateRate, double, 1.0e-10, 1.0e10);
245
247
252 vtkGetMacro(InteractiveUpdateRate, double);
254
256
268
270
279 vtkSetClampMacro(AutoAdjustSampleDistances, vtkTypeBool, 0, 1);
283
285
292 vtkSetMacro(SampleDistance, float);
293 vtkGetMacro(SampleDistance, float);
295
297
303 vtkSetClampMacro(GlobalIlluminationReach, float, 0.0f, 1.0f);
304 vtkGetMacro(GlobalIlluminationReach, float);
306
308
314 vtkSetClampMacro(VolumetricScatteringBlending, float, 0.0f, 2.0f);
315 vtkGetMacro(VolumetricScatteringBlending, float);
317
322 void Render(vtkRenderer*, vtkVolume*) override;
323
331
333
341 {
345 };
346
347 void SetVectorMode(int mode);
348 vtkGetMacro(VectorMode, int);
349
350 vtkSetClampMacro(VectorComponent, int, 0, 3);
351 vtkGetMacro(VectorComponent, int);
353
355
358 vtkSetStringMacro(Transfer2DYAxisArray);
359 vtkGetStringMacro(Transfer2DYAxisArray);
361
362protected:
365
372
379
381
387
389
395
400
402
410
412
421
427
429
441
447
453
459
461
468
475
480
485
490
496
503
512
514
525
527
534
541
542private:
544
548 void SetupVectorMode(vtkVolume* vol);
554 void ComputeMagnitudeCellData(vtkDataSet* input, vtkDataArray* arr);
555 void ComputeMagnitudePointData(vtkDataSet* input, vtkDataArray* arr);
557
559 void operator=(const vtkSmartVolumeMapper&) = delete;
560
561 vtkOSPRayVolumeInterface* OSPRayMapper;
562};
563
564#endif
abstract class to specify dataset behavior
Definition vtkDataSet.h:57
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:34
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:67
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:45
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