VTK  9.2.5
vtkAMRVolumeMapper.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAMRVolumeMapper.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 =========================================================================*/
29 #ifndef vtkAMRVolumeMapper_h
30 #define vtkAMRVolumeMapper_h
31 
32 #include "vtkImageReslice.h" // for VTK_RESLICE_NEAREST, VTK_RESLICE_CUBIC
33 #include "vtkRenderingVolumeAMRModule.h" // For export macro
34 #include "vtkVolumeMapper.h"
35 
37 class vtkCamera;
38 class vtkImageData;
39 class vtkOverlappingAMR;
41 class vtkUniformGrid;
42 
43 class VTKRENDERINGVOLUMEAMR_EXPORT vtkAMRVolumeMapper : public vtkVolumeMapper
44 {
45 public:
48  void PrintSelf(ostream& os, vtkIndent indent) override;
49 
51 
54  void SetInputData(vtkImageData*) override;
55  void SetInputData(vtkDataSet*) override;
58  void SetInputConnection(int port, vtkAlgorithmOutput* input) override;
59  void SetInputConnection(vtkAlgorithmOutput* input) override
60  {
61  this->SetInputConnection(0, input);
62  }
64 
66 
70  double* GetBounds() override;
71  void GetBounds(double bounds[6]) override { this->vtkVolumeMapper::GetBounds(bounds); }
73 
85  void SetScalarMode(int mode) override;
86 
88 
93  void SetBlendMode(int mode) override;
94  int GetBlendMode() override;
96 
98 
104  void SelectScalarArray(int arrayNum) override;
105  void SelectScalarArray(const char* arrayName) override;
107 
109 
112  char* GetArrayName() override;
113  int GetArrayId() override;
114  int GetArrayAccessMode() override;
116 
120  const char* GetScalarModeAsString();
122 
126  void SetCropping(vtkTypeBool) override;
129 
131 
137  double arg1, double arg2, double arg3, double arg4, double arg5, double arg6) override;
138  void SetCroppingRegionPlanes(const double* planes) override
139  {
140  this->SetCroppingRegionPlanes(planes[0], planes[1], planes[2], planes[3], planes[4], planes[5]);
141  }
142  void GetCroppingRegionPlanes(double* planes) override;
143  double* GetCroppingRegionPlanes() VTK_SIZEHINT(6) override;
146 
157  void SetCroppingRegionFlags(int mode) override;
158  int GetCroppingRegionFlags() override;
160 
161  // The possible values for the default and current render mode ivars
162  enum
163  {
164  DefaultRenderMode = 0,
170  InvalidRenderMode
171  };
172 
174 
181 
188  {
189  this->SetRequestedRenderMode(vtkAMRVolumeMapper::DefaultRenderMode);
190  }
191 
200  {
201  this->SetRequestedRenderMode(vtkAMRVolumeMapper::RayCastAndTextureRenderMode);
202  }
203 
210  {
211  this->SetRequestedRenderMode(vtkAMRVolumeMapper::RayCastRenderMode);
212  }
213 
221  {
222  this->SetRequestedRenderMode(vtkAMRVolumeMapper::TextureRenderMode);
223  }
224 
231  {
232  this->SetRequestedRenderMode(vtkAMRVolumeMapper::GPURenderMode);
233  }
234 
236 
243 
244  void SetInterpolationModeToNearestNeighbor() { this->SetInterpolationMode(VTK_RESLICE_NEAREST); }
245 
246  void SetInterpolationModeToLinear() { this->SetInterpolationMode(VTK_RESLICE_LINEAR); }
247 
248  void SetInterpolationModeToCubic() { this->SetInterpolationMode(VTK_RESLICE_CUBIC); }
249 
251 
255  vtkSetVector3Macro(NumberOfSamples, int);
256  vtkGetVector3Macro(NumberOfSamples, int);
258 
264  void Render(vtkRenderer* ren, vtkVolume* vol) override;
265 
273 
275  vtkInformationVector** inputVector, vtkInformationVector* outputVector);
277  vtkInformationVector** inputVector, vtkInformationVector* outputVector);
280 
282 
285  vtkSetMacro(RequestedResamplingMode, int);
286  vtkGetMacro(RequestedResamplingMode, int);
287  vtkSetMacro(FreezeFocalPoint, bool);
288  vtkGetMacro(FreezeFocalPoint, bool);
290 
292 
296  vtkSetMacro(ResamplerUpdateTolerance, double);
297  vtkGetMacro(ResamplerUpdateTolerance, double);
299 
301 
306  vtkSetMacro(UseDefaultThreading, bool);
307  vtkGetMacro(UseDefaultThreading, bool);
309 
315  vtkCamera* camera, vtkRenderer* renderer, const double data_bounds[6], double out_bounds[6]);
316 
317 protected:
320 
321  // see algorithm for more info
323  void UpdateGrid();
324 
328  int NumberOfSamples[3];
329 
330  // This indicates that the input has meta data for
331  // doing demand driven operations.
335  // Cached values for camera focal point and
336  // the distance between the camera position and
337  // focal point
338  double LastFocalPointPosition[3];
340  // This is used when determining if
341  // either the camera or focal point has
342  // move enough to cause the resampler to update
346 
347 private:
348  vtkAMRVolumeMapper(const vtkAMRVolumeMapper&) = delete;
349  void operator=(const vtkAMRVolumeMapper&) = delete;
350 };
351 
352 #endif
This filter is a concrete instance of vtkMultiBlockDataSetAlgorithm and provides functionality for ex...
AMR class for a volume mapper.
void SetInputData(vtkRectilinearGrid *) override
Set the input data.
void SetInterpolationMode(int mode)
Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
vtkTypeBool GetCropping() override
Turn On/Off orthogonal cropping.
int GetBlendMode() override
Set/Get the blend mode.
double * GetCroppingRegionPlanes() override
Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in...
const char * GetScalarModeAsString()
Return the method for obtaining scalar data.
void UpdateResampler(vtkRenderer *ren, vtkOverlappingAMR *amr)
void SetRequestedRenderModeToRayCast()
Set the requested render mode to vtkAMRVolumeMapper::RayCastRenderMode.
void SetInputData(vtkImageData *) override
Set the input data.
void SetInputData(vtkDataSet *) override
Set the input data.
void SetCroppingRegionPlanes(double arg1, double arg2, double arg3, double arg4, double arg5, double arg6) override
Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in...
void UpdateResamplerFrustrumMethod(vtkRenderer *ren, vtkOverlappingAMR *amr)
void SetInputConnection(int port, vtkAlgorithmOutput *input) override
Set the input data.
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
void ProcessUpdateExtentRequest(vtkRenderer *renderer, vtkInformation *info, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void SelectScalarArray(const char *arrayName) override
When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array t...
vtkSmartVolumeMapper * InternalMapper
vtkUniformGrid * Grid
void GetCroppingRegionPlanes(double *planes) override
Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in...
virtual void SetInputData(vtkOverlappingAMR *)
Set the input data.
~vtkAMRVolumeMapper() override
int GetArrayId() override
Get the array name or number and component to use for rendering.
void SetBlendMode(int mode) override
Set/Get the blend mode.
int GetInterpolationMode()
Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
void SetRequestedRenderModeToTexture()
Set the requested render mode to vtkAMRVolumeMapper::TextureRenderMode.
void SetScalarMode(int mode) override
Control how the mapper works with scalar point data and cell attribute data.
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
void ProcessInformationRequest(vtkRenderer *renderer, vtkInformation *info, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void GetBounds(double bounds[6]) override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
void SetInterpolationModeToNearestNeighbor()
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void SetRequestedRenderMode(int mode)
Set the requested render mode.
void SetRequestedRenderModeToRayCastAndTexture()
Set the requested render mode to vtkAMRVolumeMapper::RayCastAndTextureRenderMode.
int GetArrayAccessMode() override
Get the array name or number and component to use for rendering.
void SelectScalarArray(int arrayNum) override
When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array t...
void SetCropping(vtkTypeBool) override
Turn On/Off orthogonal cropping.
void SetRequestedRenderModeToGPU()
Set the requested render mode to vtkAMRVolumeMapper::GPURenderMode.
static bool ComputeResamplerBoundsFrustumMethod(vtkCamera *camera, vtkRenderer *renderer, const double data_bounds[6], double out_bounds[6])
Utility method used by UpdateResamplerFrustrumMethod() to compute the bounds.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetRequestedRenderMode()
Set the requested render mode.
void SetInputConnection(vtkAlgorithmOutput *input) override
Set the input data.
void SetRequestedRenderModeToDefault()
Set the requested render mode to vtkAMRVolumeMapper::DefaultRenderMode.
static vtkAMRVolumeMapper * New()
void SetCroppingRegionPlanes(const double *planes) override
Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in...
char * GetArrayName() override
Get the array name or number and component to use for rendering.
void Render(vtkRenderer *ren, vtkVolume *vol) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkAMRResampleFilter * Resampler
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
Proxy object to connect input/output ports.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
a virtual camera for 3D rendering
Definition: vtkCamera.h:161
abstract class to specify dataset behavior
Definition: vtkDataSet.h:172
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
hierarchical dataset of vtkUniformGrids
a dataset that is topologically regular with variable spacing in the three coordinate directions
abstract specification for renderers
Definition: vtkRenderer.h:182
Adaptive volume mapper.
image data with blanking
Abstract class for a volume mapper.
virtual void SetCroppingRegionPlanes(double, double, double, double, double, double)
Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in...
represents a volume (data & properties) in a rendered scene
Definition: vtkVolume.h:140
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ info
Definition: vtkX3D.h:382
@ mode
Definition: vtkX3D.h:253
@ port
Definition: vtkX3D.h:453
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_RESLICE_CUBIC
#define VTK_RESLICE_NEAREST
#define VTK_RESLICE_LINEAR
#define VTK_SIZEHINT(...)