VTK  9.2.6
vtkOpenGLGPUVolumeRayCastMapper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkOpenGLGPUVolumeRayCastMapper.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=========================================================================*/
62
63#ifndef vtkOpenGLGPUVolumeRayCastMapper_h
64#define vtkOpenGLGPUVolumeRayCastMapper_h
65#include <map> // For methods
66
68#include "vtkNew.h" // For vtkNew
69#include "vtkRenderingVolumeOpenGL2Module.h" // For export macro
70#include "vtkShader.h" // For methods
71#include "vtkSmartPointer.h" // For smartptr
72
75class vtkOpenGLCamera;
76class vtkOpenGLTransferFunctions2D;
77class vtkOpenGLVolumeGradientOpacityTables;
78class vtkOpenGLVolumeOpacityTables;
79class vtkOpenGLVolumeRGBTables;
82class vtkVolume;
86
87class VTKRENDERINGVOLUMEOPENGL2_EXPORT vtkOpenGLGPUVolumeRayCastMapper
89{
90public:
92
93 enum Passes
94 {
97 };
98
100 void PrintSelf(ostream& os, vtkIndent indent) override;
101
102 // Description:
103 // Low level API to enable access to depth texture in
104 // RenderToTexture mode. It will return either nullptr if
105 // RenderToImage was never turned on or texture captured
106 // the last time RenderToImage was on.
108
109 // Description:
110 // Low level API to enable access to color texture in
111 // RenderToTexture mode. It will return either nullptr if
112 // RenderToImage was never turned on or texture captured
113 // the last time RenderToImage was on.
115
116 // Description:
117 // Low level API to export the depth texture as vtkImageData in
118 // RenderToImage mode.
119 void GetDepthImage(vtkImageData* im) override;
120
121 // Description:
122 // Low level API to export the color texture as vtkImageData in
123 // RenderToImage mode.
124 void GetColorImage(vtkImageData* im) override;
125
126 // Description:
127 // Mapper can have multiple passes and internally it will set
128 // the state. The state can not be set externally explicitly
129 // but can be set indirectly depending on the options set by
130 // the user.
131 vtkGetMacro(CurrentPass, int);
132
133 // Sets a depth texture for this mapper to use
134 // This allows many mappers to use the same
135 // texture reducing GPU usage. If this is set
136 // the standard depth texture code is skipped
137 // The depth texture should be activated
138 // and deactivated outside of this class
140
146 void SetPartitions(unsigned short x, unsigned short y, unsigned short z);
147
157
158 // Description:
159 // Delete OpenGL objects.
160 // \post done: this->OpenGLObjectsCreated==0
161 void ReleaseGraphicsResources(vtkWindow* window) override;
162
163protected:
166
168
169 // Description:
170 // Build vertex and fragment shader for the volume rendering
172 vtkRenderer* ren, vtkVolume* vol, int noOfComponents, int independentComponents);
173
174 // Description:
175 // Build vertex and fragment shader for the volume rendering
177
178 // TODO Take these out as these are no longer needed
179 // Methods called by the AMR Volume Mapper.
180 void PreRender(vtkRenderer* vtkNotUsed(ren), vtkVolume* vtkNotUsed(vol),
181 double vtkNotUsed(datasetBounds)[6], double vtkNotUsed(scalarRange)[2],
182 int vtkNotUsed(noOfComponents), unsigned int vtkNotUsed(numberOfLevels)) override
183 {
184 }
185
186 // \pre input is up-to-date
187 void RenderBlock(vtkRenderer* vtkNotUsed(ren), vtkVolume* vtkNotUsed(vol),
188 unsigned int vtkNotUsed(level)) override
189 {
190 }
191
192 void PostRender(vtkRenderer* vtkNotUsed(ren), int vtkNotUsed(noOfComponents)) override {}
193
194 // Description:
195 // Rendering volume on GPU
196 void GPURender(vtkRenderer* ren, vtkVolume* vol) override;
197
198 // Description:
199 // Method that performs the actual rendering given a volume and a shader
201 vtkOpenGLShaderProperty* shaderProperty);
202
203 // Description:
204 // Update the reduction factor of the render viewport (this->ReductionFactor)
205 // according to the time spent in seconds to render the previous frame
206 // (this->TimeToDraw) and a time in seconds allocated to render the next
207 // frame (allocatedTime).
208 // \pre valid_current_reduction_range: this->ReductionFactor>0.0 && this->ReductionFactor<=1.0
209 // \pre positive_TimeToDraw: this->TimeToDraw>=0.0
210 // \pre positive_time: allocatedTime>0
211 // \post valid_new_reduction_range: this->ReductionFactor>0.0 && this->ReductionFactor<=1.0
212 void ComputeReductionFactor(double allocatedTime);
213
214 // Description:
215 // Empty implementation.
216 void GetReductionRatio(double* ratio) override { ratio[0] = ratio[1] = ratio[2] = 1.0; }
217
218 // Description:
219 // Empty implementation.
221 vtkRenderWindow* vtkNotUsed(window), vtkVolumeProperty* vtkNotUsed(property)) override
222 {
223 return 1;
224 }
225
227
231
236 std::map<vtkShader::Type, vtkShader*>& shaders, vtkOpenGLShaderProperty* p);
237
242 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
243
249 std::map<vtkShader::Type, vtkShader*>& shaders, vtkOpenGLShaderProperty* p);
251 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
253 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
255 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
257 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
259 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
261 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
263 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
265 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
267 std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
269 std::map<vtkShader::Type, vtkShader*>& shaders, vtkVolume* vol, bool prePass);
270
275
283
286
287public:
289 using VolumeInputMap = std::map<int, vtkVolumeInputHelper>;
291
292private:
293 class vtkInternal;
294 vtkInternal* Impl;
295
296 friend class vtkVolumeTexture;
297
299 void operator=(const vtkOpenGLGPUVolumeRayCastMapper&) = delete;
300};
301
302#endif // vtkOpenGLGPUVolumeRayCastMapper_h
topologically and geometrically regular array of data
abstract interface for implicit functions
a simple class to control print indentation
Definition vtkIndent.h:34
Allocate and hold a VTK object.
Definition vtkNew.h:56
OpenGL camera.
void GetColorImage(vtkImageData *im) override
Low level API to export the color texture as vtkImageData in RenderToImage mode.
void ReplaceShaderRTT(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void SetShaderParametersRenderPass()
Update parameters from RenderPass.
void PreRender(vtkRenderer *vtkNotUsed(ren), vtkVolume *vtkNotUsed(vol), double vtkNotUsed(datasetBounds)[6], double vtkNotUsed(scalarRange)[2], int vtkNotUsed(noOfComponents), unsigned int vtkNotUsed(numberOfLevels)) override
void ReplaceShaderCustomUniforms(std::map< vtkShader::Type, vtkShader * > &shaders, vtkOpenGLShaderProperty *p)
RenderPass string replacements on shader templates called from ReplaceShaderValues.
void GetShaderTemplate(std::map< vtkShader::Type, vtkShader * > &shaders, vtkOpenGLShaderProperty *p)
Create the basic shader template strings before substitutions.
void GetDepthImage(vtkImageData *im) override
Low level API to export the depth texture as vtkImageData in RenderToImage mode.
void BuildShader(vtkRenderer *ren)
void ReplaceShaderCropping(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void ReplaceShaderRenderPass(std::map< vtkShader::Type, vtkShader * > &shaders, vtkVolume *vol, bool prePass)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void DoGPURender(vtkRenderer *ren, vtkOpenGLCamera *cam, vtkShaderProgram *shaderProgram, vtkOpenGLShaderProperty *shaderProperty)
std::map< int, vtkVolumeInputHelper > VolumeInputMap
bool PreLoadData(vtkRenderer *ren, vtkVolume *vol)
Load the volume texture into GPU memory.
void ReplaceShaderTermination(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void RenderBlock(vtkRenderer *vtkNotUsed(ren), vtkVolume *vtkNotUsed(vol), unsigned int vtkNotUsed(level)) override
void PostRender(vtkRenderer *vtkNotUsed(ren), int vtkNotUsed(noOfComponents)) override
void SetSharedDepthTexture(vtkTextureObject *nt)
void ComputeReductionFactor(double allocatedTime)
void ReplaceShaderPicking(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void ReplaceShaderBase(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ReplaceShaderClipping(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
vtkMTimeType GetRenderPassStageMTime(vtkVolume *vol)
vtkOpenGLRenderPass API
vtkTextureObject * GetColorTexture()
void ReplaceShaderCompute(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void ReplaceShaderMasking(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void BuildDepthPassShader(vtkRenderer *ren, vtkVolume *vol, int noOfComponents, int independentComponents)
vtkGenericOpenGLResourceFreeCallback * ResourceCallback
void SetPartitions(unsigned short x, unsigned short y, unsigned short z)
Set a fixed number of partitions in which to split the volume during rendring.
vtkNew< vtkInformation > LastRenderPassInfo
Caches the vtkOpenGLRenderPass::RenderPasses() information.
vtkTextureObject * GetDepthTexture()
void GPURender(vtkRenderer *ren, vtkVolume *vol) override
Handled in the subclass - the actual render method.
static vtkOpenGLGPUVolumeRayCastMapper * New()
void ReplaceShaderValues(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Perform string replacements on the shader templates.
void ReleaseGraphicsResources(vtkWindow *window) override
Release any graphics resources that are being consumed by this mapper.
void ReplaceShaderShading(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
int IsRenderSupported(vtkRenderWindow *vtkNotUsed(window), vtkVolumeProperty *vtkNotUsed(property)) override
Based on hardware and properties, we may or may not be able to render using 3D texture mapping.
represent GPU shader properties
create a window for renderers to draw into
abstract specification for renderers
Definition vtkRenderer.h:67
The ShaderProgram uses one or more Shader objects.
abstracts an OpenGL texture object.
Convenience container for internal structures specific to a volume input.
represents the common properties for rendering a volume.
Creates and manages the volume texture rendered by vtkOpenGLGPUVolumeRayCastMapper.
represents a volume (data & properties) in a rendered scene
Definition vtkVolume.h:45
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287