VTK  9.0.3
vtkOSPRayRendererNode.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOSPRayRendererNode.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 =========================================================================*/
22 #ifndef vtkOSPRayRendererNode_h
23 #define vtkOSPRayRendererNode_h
24 
25 #include "vtkRendererNode.h"
26 #include "vtkRenderingRayTracingModule.h" // For export macro
27 #include <vector> // for ivars
28 
29 #include "RTWrapper/RTWrapper.h" // for handle types
30 
31 #ifdef VTKOSPRAY_ENABLE_DENOISER
32 #include <OpenImageDenoise/oidn.hpp> // for denoiser structures
33 #endif
34 
40 class vtkMatrix4x4;
41 class vtkOSPRayRendererNodeInternals;
43 class vtkRenderer;
44 
45 class VTKRENDERINGRAYTRACING_EXPORT vtkOSPRayRendererNode : public vtkRendererNode
46 {
47 public:
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
55  virtual void Build(bool prepass) override;
56 
60  virtual void Render(bool prepass) override;
61 
65  virtual void Invalidate(bool prepass) override;
66 
70  virtual void WriteLayer(unsigned char* buffer, float* zbuffer, int buffx, int buffy, int layer);
71 
72  // state beyond rendering core...
73 
80 
82 
85  static void SetSamplesPerPixel(int, vtkRenderer* renderer);
86  static int GetSamplesPerPixel(vtkRenderer* renderer);
88 
95 
97 
100  static void SetMaxContribution(double, vtkRenderer* renderer);
101  static double GetMaxContribution(vtkRenderer* renderer);
103 
109 
111 
114  static void SetMaxDepth(int, vtkRenderer* renderer);
115  static int GetMaxDepth(vtkRenderer* renderer);
117 
124 
126 
129  static void SetMinContribution(double, vtkRenderer* renderer);
130  static double GetMinContribution(vtkRenderer* renderer);
132 
139 
141 
144  static void SetRouletteDepth(int, vtkRenderer* renderer);
145  static int GetRouletteDepth(vtkRenderer* renderer);
147 
153 
155 
158  static void SetVarianceThreshold(double, vtkRenderer* renderer);
159  static double GetVarianceThreshold(vtkRenderer* renderer);
161 
163 
169  static void SetMaxFrames(int, vtkRenderer* renderer);
170  static int GetMaxFrames(vtkRenderer* renderer);
172 
174 
179  static void SetRendererType(std::string name, vtkRenderer* renderer);
182 
190 
193  static void SetAmbientSamples(int, vtkRenderer* renderer);
194  static int GetAmbientSamples(vtkRenderer* renderer);
196 
203 
206  static void SetCompositeOnGL(int, vtkRenderer* renderer);
207  static int GetCompositeOnGL(vtkRenderer* renderer);
209 
215 
218  static void SetNorthPole(double*, vtkRenderer* renderer);
219  static double* GetNorthPole(vtkRenderer* renderer);
221 
227 
230  static void SetEastPole(double*, vtkRenderer* renderer);
231  static double* GetEastPole(vtkRenderer* renderer);
233 
238 
240 
246 
252 
255  static void SetViewTime(double, vtkRenderer* renderer);
256  static double GetViewTime(vtkRenderer* renderer);
258 
264 
267  static void SetTimeCacheSize(int, vtkRenderer* renderer);
268  static int GetTimeCacheSize(vtkRenderer* renderer);
270 
274  OSPModel GetOModel() { return this->OModel; }
275  OSPRenderer GetORenderer() { return this->ORenderer; }
276  void AddLight(OSPLight light) { this->Lights.push_back(light); }
277 
281  virtual void* GetBuffer() { return this->Buffer.data(); }
282 
286  virtual float* GetZBuffer() { return this->ZBuffer.data(); }
287 
288  // Get the last renderer color buffer as an OpenGL texture.
289  virtual int GetColorBufferTextureGL() { return this->ColorBufferTex; }
290 
291  // Get the last renderer depth buffer as an OpenGL texture.
292  virtual int GetDepthBufferTextureGL() { return this->DepthBufferTex; }
293 
294  // if you want to traverse your children in a specific order
295  // or way override this method
296  virtual void Traverse(int operation) override;
297 
304 
310 
313  static void SetDenoiserThreshold(int, vtkRenderer* renderer);
314  static int GetDenoiserThreshold(vtkRenderer* renderer);
316 
318 
325  static void SetEnableDenoiser(int, vtkRenderer* renderer);
326  static int GetEnableDenoiser(vtkRenderer* renderer);
328 
330 
338  static void SetBackgroundMode(int, vtkRenderer* renderer);
339  static int GetBackgroundMode(vtkRenderer* renderer);
341 protected:
344 
348  void Denoise();
349 
350  // internal structures
351 #ifdef VTKOSPRAY_ENABLE_DENOISER
352  std::vector<float> Buffer;
353 #else
354  std::vector<unsigned char> Buffer;
355 #endif
356  std::vector<float> ZBuffer;
357 
360 
365  int ImageX, ImageY;
366  std::vector<OSPLight> Lights;
371  std::vector<float> ODepthBuffer;
376  vtkOSPRayRendererNodeInternals* Internal;
378 
379 #ifdef VTKOSPRAY_ENABLE_DENOISER
380  oidn::DeviceRef DenoiserDevice;
381  oidn::FilterRef DenoiserFilter;
382 #endif
383  bool DenoiserDirty{ true };
384  std::vector<osp::vec4f> ColorBuffer;
385  std::vector<osp::vec3f> NormalBuffer;
386  std::vector<osp::vec3f> AlbedoBuffer;
387  std::vector<osp::vec4f> DenoisedBuffer;
388 
389 private:
391  void operator=(const vtkOSPRayRendererNode&) = delete;
392 };
393 
394 #endif
#define OSPLight
Definition: RTWrapper.h:19
#define OSPData
Definition: RTWrapper.h:17
#define OSPFrameBuffer
Definition: RTWrapper.h:25
#define OSPRenderer
Definition: RTWrapper.h:15
#define OSPModel
Definition: RTWrapper.h:16
a simple class to control print indentation
Definition: vtkIndent.h:34
Key for double values in vtkInformation.
Key for integer values in vtkInformation.
Key for vtkObjectBase values.
Key for string values in vtkInformation.
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:36
a collection of materials for vtk apps to draw from
links vtkRenderers to OSPRay
static void SetMaxFrames(int, vtkRenderer *renderer)
static double GetVarianceThreshold(vtkRenderer *renderer)
static vtkOSPRayRendererNode * GetRendererNode(vtkViewNode *)
Convenience method to get and downcast renderable.
static vtkInformationDoubleKey * VARIANCE_THRESHOLD()
When present on renderer, controls the threshold for adaptive accumulation default is 0....
static void SetRendererType(std::string name, vtkRenderer *renderer)
std::vector< osp::vec3f > NormalBuffer
static vtkInformationIntegerKey * ENABLE_DENOISER()
Enable denoising (if supported).
OSPModel GetOModel()
Methods for other nodes to access.
virtual float * GetZBuffer()
Get the last rendered ZBuffer.
static vtkInformationObjectBaseKey * MATERIAL_LIBRARY()
Material Library attached to the renderer.
static void SetAmbientSamples(int, vtkRenderer *renderer)
Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.
static int GetRouletteDepth(vtkRenderer *renderer)
static void SetCompositeOnGL(int, vtkRenderer *renderer)
Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.
static vtkInformationIntegerKey * MAX_DEPTH()
When present on renderer, controls the maximum ray recursion depth default is 20.
static vtkOSPRayRendererNode * New()
~vtkOSPRayRendererNode() override
virtual void Build(bool prepass) override
Builds myself.
virtual int GetColorBufferTextureGL()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static int GetAmbientSamples(vtkRenderer *renderer)
static void SetMaterialLibrary(vtkOSPRayMaterialLibrary *, vtkRenderer *renderer)
Convenience method to set/get Material library on a renderer.
static void SetVarianceThreshold(double, vtkRenderer *renderer)
Convenience method to set/get VARIANCE_THRESHOLD on a vtkRenderer.
static int GetEnableDenoiser(vtkRenderer *renderer)
static void SetEastPole(double *, vtkRenderer *renderer)
Convenience method to set/get EAST_POLE on a vtkRenderer.
static vtkInformationIntegerKey * SAMPLES_PER_PIXEL()
When present on renderer, controls the number of primary rays shot per pixel default is 1.
static vtkInformationIntegerKey * AMBIENT_SAMPLES()
When present on renderer, controls the number of ambient occlusion samples shot per hit.
static double * GetNorthPole(vtkRenderer *renderer)
static vtkInformationDoubleVectorKey * EAST_POLE()
World space direction of east pole for texture background.
static void SetMaxContribution(double, vtkRenderer *renderer)
Convenience method to set/get MAX_CONTRIBUTION on a vtkRenderer.
static void SetMaxDepth(int, vtkRenderer *renderer)
Convenience method to set/get MAX_DEPTH on a vtkRenderer.
static double GetMaxContribution(vtkRenderer *renderer)
vtkOSPRayRendererNodeInternals * Internal
static int GetTimeCacheSize(vtkRenderer *renderer)
static vtkInformationDoubleVectorKey * NORTH_POLE()
World space direction of north pole for gradient and texture background.
static vtkInformationIntegerKey * BACKGROUND_MODE()
Control use of the path tracer backplate and environmental background.
static void SetMinContribution(double, vtkRenderer *renderer)
Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.
static int GetBackgroundMode(vtkRenderer *renderer)
static int GetMaxFrames(vtkRenderer *renderer)
std::vector< float > ODepthBuffer
static void SetBackgroundMode(int, vtkRenderer *renderer)
virtual void * GetBuffer()
Get the last rendered ColorBuffer.
static int GetMaxDepth(vtkRenderer *renderer)
vtkRenderer * GetRenderer()
static double * GetEastPole(vtkRenderer *renderer)
static double GetViewTime(vtkRenderer *renderer)
std::vector< OSPLight > Lights
static std::string GetRendererType(vtkRenderer *renderer)
virtual void Traverse(int operation) override
static void SetDenoiserThreshold(int, vtkRenderer *renderer)
Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.
static vtkInformationIntegerKey * TIME_CACHE_SIZE()
Temporal cache size.
static vtkInformationDoubleKey * MAX_CONTRIBUTION()
When present on renderer, samples are clamped to this value before they are accumulated into the fram...
RTW::Backend * GetBackend()
std::vector< float > ZBuffer
virtual void WriteLayer(unsigned char *buffer, float *zbuffer, int buffx, int buffy, int layer)
Put my results into the correct place in the provided pixel buffer.
std::vector< unsigned char > Buffer
static double GetMinContribution(vtkRenderer *renderer)
static vtkInformationDoubleKey * VIEW_TIME()
Requested time to show in a renderer and to lookup in a temporal cache.
virtual void Invalidate(bool prepass) override
Invalidates cached rendering data.
virtual int GetDepthBufferTextureGL()
std::vector< osp::vec3f > AlbedoBuffer
void AddLight(OSPLight light)
virtual void Render(bool prepass) override
Traverse graph in ospray's preferred order and render.
static int GetSamplesPerPixel(vtkRenderer *renderer)
std::vector< osp::vec4f > ColorBuffer
static void SetNorthPole(double *, vtkRenderer *renderer)
Convenience method to set/get NORTH_POLE on a vtkRenderer.
static void SetRouletteDepth(int, vtkRenderer *renderer)
Convenience method to set/get ROULETTE_DEPTH on a vtkRenderer.
static vtkInformationStringKey * RENDERER_TYPE()
Set the OSPRay renderer type to use (e.g.
static int GetCompositeOnGL(vtkRenderer *renderer)
static vtkInformationIntegerKey * MAX_FRAMES()
When present on renderer, controls the number of ospray render calls for each refresh.
static vtkInformationIntegerKey * ROULETTE_DEPTH()
When present on renderer, controls the ray recursion depth at which to start Russian roulette termina...
static vtkInformationIntegerKey * DENOISER_THRESHOLD()
Accumulation threshold when above which denoising kicks in.
static vtkInformationDoubleKey * MIN_CONTRIBUTION()
When present on renderer, sample contributions below this value will be neglected to speedup renderin...
static void SetViewTime(double, vtkRenderer *renderer)
Convenience method to set/get VIEW_TIME on a vtkRenderer.
static void SetSamplesPerPixel(int, vtkRenderer *renderer)
Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.
std::vector< osp::vec4f > DenoisedBuffer
void Denoise()
Denoise the colors stored in ColorBuffer and put into Buffer.
static vtkOSPRayMaterialLibrary * GetMaterialLibrary(vtkRenderer *renderer)
static void SetEnableDenoiser(int, vtkRenderer *renderer)
Convenience method to set/get ENABLE_DENOISER on a vtkRenderer.
static int GetDenoiserThreshold(vtkRenderer *renderer)
static vtkInformationIntegerKey * COMPOSITE_ON_GL()
used to make the renderer add ospray's content onto GL rendered content on the window
static void SetTimeCacheSize(int, vtkRenderer *renderer)
Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.
vtkViewNode specialized for vtkRenderers
abstract specification for renderers
Definition: vtkRenderer.h:68
a node within a VTK scene graph
Definition: vtkViewNode.h:38
@ name
Definition: vtkX3D.h:225
@ string
Definition: vtkX3D.h:496
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293