VTK  9.1.0
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=========================================================================*/
102#ifndef vtkSmartVolumeMapper_h
103#define vtkSmartVolumeMapper_h
104
105#include "vtkImageReslice.h" // for VTK_RESLICE_NEAREST, VTK_RESLICE_CUBIC
106#include "vtkRenderingVolumeOpenGL2Module.h" // For export macro
107#include "vtkVolumeMapper.h"
108
111class vtkImageResample;
114class vtkRenderWindow;
115class vtkVolume;
118
119class VTKRENDERINGVOLUMEOPENGL2_EXPORT vtkSmartVolumeMapper : public vtkVolumeMapper
120{
121public:
124 void PrintSelf(ostream& os, vtkIndent indent) override;
125
127
137 vtkSetMacro(FinalColorWindow, float);
139
141
144 vtkGetMacro(FinalColorWindow, float);
146
148
155 vtkSetMacro(FinalColorLevel, float);
157
159
162 vtkGetMacro(FinalColorLevel, float);
164
165 // The possible values for the default and current render mode ivars
166 enum
167 {
168 DefaultRenderMode = 0,
169 RayCastRenderMode = 1,
170 GPURenderMode = 2,
171 OSPRayRenderMode = 3,
172 UndefinedRenderMode = 4,
173 InvalidRenderMode = 5
174 };
175
181
188
195
202
208
210
213 vtkGetMacro(RequestedRenderMode, int);
215
221
223
230 vtkSetMacro(MaxMemoryInBytes, vtkIdType);
231 vtkGetMacro(MaxMemoryInBytes, vtkIdType);
233
235
241 vtkSetClampMacro(MaxMemoryFraction, float, 0.1f, 1.0f);
242 vtkGetMacro(MaxMemoryFraction, float);
244
246
250 vtkSetClampMacro(InterpolationMode, int, VTK_RESLICE_NEAREST, VTK_RESLICE_CUBIC);
251 vtkGetMacro(InterpolationMode, int);
256
263 vtkImageData* image, int blend_mode, double viewDirection[3], double viewUp[3]);
264
266
272 vtkSetClampMacro(InteractiveUpdateRate, double, 1.0e-10, 1.0e10);
274
276
281 vtkGetMacro(InteractiveUpdateRate, double);
283
285
293 vtkSetClampMacro(InteractiveAdjustSampleDistances, vtkTypeBool, 0, 1);
294 vtkGetMacro(InteractiveAdjustSampleDistances, vtkTypeBool);
295 vtkBooleanMacro(InteractiveAdjustSampleDistances, vtkTypeBool);
297
299
308 vtkSetClampMacro(AutoAdjustSampleDistances, vtkTypeBool, 0, 1);
309 vtkGetMacro(AutoAdjustSampleDistances, vtkTypeBool);
310 vtkBooleanMacro(AutoAdjustSampleDistances, vtkTypeBool);
312
314
321 vtkSetMacro(SampleDistance, float);
322 vtkGetMacro(SampleDistance, float);
324
329 void Render(vtkRenderer*, vtkVolume*) override;
330
338
340
348 {
349 DISABLED = -1,
350 MAGNITUDE = 0,
351 COMPONENT = 1,
352 };
353
354 void SetVectorMode(int mode);
355 vtkGetMacro(VectorMode, int);
356
357 vtkSetClampMacro(VectorComponent, int, 0, 3);
358 vtkGetMacro(VectorComponent, int);
360
362
365 vtkSetStringMacro(Transfer2DYAxisArray);
366 vtkGetStringMacro(Transfer2DYAxisArray);
368
369protected:
372
379
386
388
394
396
402
407
409
417
419
428
434
436
448
454
460
465 vtkGetObjectMacro(GPUMapper, vtkGPUVolumeRayCastMapper);
466
468
475
482
487
493
500
509
511
522
524
531
538
539private:
541
545 void SetupVectorMode(vtkVolume* vol);
551 void ComputeMagnitudeCellData(vtkDataSet* input, vtkDataArray* arr);
552 void ComputeMagnitudePointData(vtkDataSet* input, vtkDataArray* arr);
554
556 void operator=(const vtkSmartVolumeMapper&) = delete;
557
558 vtkOSPRayVolumeInterface* OSPRayMapper;
559};
560
561#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
Ray casting performed on the GPU.
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
Resamples an image to be larger or smaller.
a simple class to control print indentation
Definition: vtkIndent.h:113
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:182
Adaptive volume mapper.
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 propogated 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...
int CurrentRenderMode
The requested render mode is used to compute the current render mode.
~vtkSmartVolumeMapper() override
vtkDataSet * LastFilterInput
Keep a cache of the last input to the mapper so that input data changes can be propogated 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 ...
record modification and/or execution time
Definition: vtkTimeStamp.h:52
Abstract class for a volume mapper.
represents the common properties for rendering a volume.
represents a volume (data & properties) in a rendered scene
Definition: vtkVolume.h:144
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_RESLICE_CUBIC
#define VTK_RESLICE_NEAREST
int vtkIdType
Definition: vtkType.h:332