VTK  9.2.5
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=========================================================================*/
25#ifndef vtkOSPRayRendererNode_h
26#define vtkOSPRayRendererNode_h
27
28#include "RTWrapper/RTWrapper.h" // for handle types
29#include "vtkDeprecation.h" // For deprecation macro
30#include "vtkInformation.h"
31#include "vtkOSPRayCache.h" // For common cache infrastructure
32#include "vtkRenderer.h"
33#include "vtkRendererNode.h"
34#include "vtkRenderingRayTracingModule.h" // For export macro
35
36#include <vector> // for ivars
37
38#ifdef VTKOSPRAY_ENABLE_DENOISER
39#include <OpenImageDenoise/oidn.hpp> // for denoiser structures
40#endif
41
47class vtkMatrix4x4;
48class vtkOSPRayRendererNodeInternals;
50class vtkRenderer;
51
52class VTKRENDERINGRAYTRACING_EXPORT vtkOSPRayRendererNode : public vtkRendererNode
53{
54public:
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
62 void Build(bool prepass) override;
63
67 void Render(bool prepass) override;
68
72 void Invalidate(bool prepass) override;
73
77 virtual void WriteLayer(unsigned char* buffer, float* zbuffer, int buffx, int buffy, int layer);
78
79 // state beyond rendering core...
80
87
89
92 static void SetSamplesPerPixel(int, vtkRenderer* renderer);
93 static int GetSamplesPerPixel(vtkRenderer* renderer);
95
102
104
107 static void SetMaxContribution(double, vtkRenderer* renderer);
108 static double GetMaxContribution(vtkRenderer* renderer);
110
116
118
121 static void SetMaxDepth(int, vtkRenderer* renderer);
122 static int GetMaxDepth(vtkRenderer* renderer);
124
131
133
136 static void SetMinContribution(double, vtkRenderer* renderer);
137 static double GetMinContribution(vtkRenderer* renderer);
139
146
148
151 static void SetRouletteDepth(int, vtkRenderer* renderer);
152 static int GetRouletteDepth(vtkRenderer* renderer);
154
166
168
171 VTK_DEPRECATED_IN_9_2_0("Use vtkVolumeProperty::SetScatteringAnisotropy instead")
172 static void SetVolumeAnisotropy(double value, vtkRenderer* renderer)
173 {
174 if (!renderer)
175 {
176 return;
177 }
178 vtkInformation* info = renderer->GetInformation();
180 };
181 VTK_DEPRECATED_IN_9_2_0("Use vtkVolumeProperty::GetScatteringAnisotropy instead")
182 static double GetVolumeAnisotropy(vtkRenderer* renderer)
183 {
184 constexpr double DEFAULT_VOLUME_ANISOTROPY = 0.0;
185 if (!renderer)
186 {
187 return DEFAULT_VOLUME_ANISOTROPY;
188 }
189 vtkInformation* info = renderer->GetInformation();
190 if (info && info->Has(vtkOSPRayRendererNode::VOLUME_ANISOTROPY()))
191 {
192 return (info->Get(vtkOSPRayRendererNode::VOLUME_ANISOTROPY()));
193 }
194 return DEFAULT_VOLUME_ANISOTROPY;
195 };
197
203
205
208 static void SetVarianceThreshold(double, vtkRenderer* renderer);
209 static double GetVarianceThreshold(vtkRenderer* renderer);
211
213
219 static void SetMaxFrames(int, vtkRenderer* renderer);
220 static int GetMaxFrames(vtkRenderer* renderer);
222
224
229 static void SetRendererType(std::string name, vtkRenderer* renderer);
230 static std::string GetRendererType(vtkRenderer* renderer);
232
240
243 static void SetAmbientSamples(int, vtkRenderer* renderer);
244 static int GetAmbientSamples(vtkRenderer* renderer);
246
253
256 static void SetCompositeOnGL(int, vtkRenderer* renderer);
257 static int GetCompositeOnGL(vtkRenderer* renderer);
259
265
268 static void SetNorthPole(double*, vtkRenderer* renderer);
269 static double* GetNorthPole(vtkRenderer* renderer);
271
277
280 static void SetEastPole(double*, vtkRenderer* renderer);
281 static double* GetEastPole(vtkRenderer* renderer);
283
288
290
296
302
305 static void SetViewTime(double, vtkRenderer* renderer);
306 static double GetViewTime(vtkRenderer* renderer);
308
314
317 static void SetTimeCacheSize(int, vtkRenderer* renderer);
318 static int GetTimeCacheSize(vtkRenderer* renderer);
320
324 OSPRenderer GetORenderer() { return this->ORenderer; }
325 void AddLight(OSPLight light) { this->Lights.push_back(light); }
326
330 virtual void* GetBuffer() { return this->Buffer.data(); }
331
335 virtual float* GetZBuffer() { return this->ZBuffer.data(); }
336
337 // Get the last renderer color buffer as an OpenGL texture.
338 virtual int GetColorBufferTextureGL() { return this->ColorBufferTex; }
339
340 // Get the last renderer depth buffer as an OpenGL texture.
341 virtual int GetDepthBufferTextureGL() { return this->DepthBufferTex; }
342
343 // if you want to traverse your children in a specific order
344 // or way override this method
345 void Traverse(int operation) override;
346
353
359
362 static void SetDenoiserThreshold(int, vtkRenderer* renderer);
363 static int GetDenoiserThreshold(vtkRenderer* renderer);
365
367
374 static void SetEnableDenoiser(int, vtkRenderer* renderer);
375 static int GetEnableDenoiser(vtkRenderer* renderer);
377
379 {
384 NumberOfMode
385 };
386
388
399
400 std::vector<OSPGeometricModel> GeometricModels;
401 std::vector<OSPVolumetricModel> VolumetricModels;
402 std::vector<OSPInstance> Instances;
403
404protected:
407
411 void Denoise();
412
413 // internal structures
414 std::vector<float> Buffer;
415 std::vector<float> ZBuffer;
416
419
420 OSPWorld OWorld{ nullptr };
421 OSPRenderer ORenderer{ nullptr };
422 OSPFrameBuffer OFrameBuffer{ nullptr };
423 OSPCamera OCamera{ nullptr };
424 int ImageX, ImageY;
425 std::vector<OSPLight> Lights;
430 bool UseBackplate{ true }; // use bgcolor for pathtracer or use bgcolor light
431 std::vector<float> ODepthBuffer;
436 vtkOSPRayRendererNodeInternals* Internal;
437 std::string PreviousType;
438
439#ifdef VTKOSPRAY_ENABLE_DENOISER
440 oidn::DeviceRef DenoiserDevice;
441 oidn::FilterRef DenoiserFilter;
442#endif
443 bool DenoiserDirty{ true };
444 std::vector<osp::vec4f> ColorBuffer;
445 std::vector<osp::vec3f> NormalBuffer;
446 std::vector<osp::vec3f> AlbedoBuffer;
447 std::vector<osp::vec4f> DenoisedBuffer;
448
450 std::set<OSPWorld> CacheContents;
451
452private:
454 void operator=(const vtkOSPRayRendererNode&) = delete;
455};
456
457#endif
#define OSPWorld
Definition: RTWrapper.h:17
#define OSPLight
Definition: RTWrapper.h:22
#define OSPFrameBuffer
Definition: RTWrapper.h:28
#define OSPRenderer
Definition: RTWrapper.h:16
#define OSPCamera
Definition: RTWrapper.h:21
a simple class to control print indentation
Definition: vtkIndent.h:40
Key for double values in vtkInformation.
Key for integer values in vtkInformation.
Key for vtkObjectBase values.
Key for string values in vtkInformation.
Store vtkAlgorithm input/output information.
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:42
temporal cache ospray structures to speed flipbooks
a collection of materials for vtk apps to draw from
links vtkRenderers to OSPRay
static void SetMaxFrames(int, vtkRenderer *renderer)
When present on renderer, controls the number of ospray render calls for each refresh.
static double GetVarianceThreshold(vtkRenderer *renderer)
Convenience method to set/get VARIANCE_THRESHOLD on a vtkRenderer.
static void SetRendererType(std::string name, vtkRenderer *renderer)
Set the OSPRay renderer type to use (e.g.
static vtkOSPRayRendererNode * GetRendererNode(vtkViewNode *)
Convenience method to get and downcast renderable.
std::vector< osp::vec3f > NormalBuffer
std::vector< float > Buffer
RTW::Backend * GetBackend()
static void SetAmbientSamples(int, vtkRenderer *renderer)
Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.
virtual float * GetZBuffer()
Get the last rendered ZBuffer.
static int GetRouletteDepth(vtkRenderer *renderer)
Convenience method to set/get ROULETTE_DEPTH on a vtkRenderer.
void Build(bool prepass) override
Builds myself.
static vtkInformationDoubleKey * MIN_CONTRIBUTION()
When present on renderer, sample contributions below this value will be neglected to speedup renderin...
static void SetCompositeOnGL(int, vtkRenderer *renderer)
Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.
static vtkInformationDoubleKey * VOLUME_ANISOTROPY()
When present on renderer, affects path traced rendering phase function.
static vtkInformationDoubleKey * MAX_CONTRIBUTION()
When present on renderer, samples are clamped to this value before they are accumulated into the fram...
~vtkOSPRayRendererNode() override
virtual int GetColorBufferTextureGL()
OSPRenderer GetORenderer()
Methods for other nodes to access.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkInformationIntegerKey * SAMPLES_PER_PIXEL()
When present on renderer, controls the number of primary rays shot per pixel default is 1.
std::vector< OSPVolumetricModel > VolumetricModels
std::vector< OSPInstance > Instances
static int GetAmbientSamples(vtkRenderer *renderer)
Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.
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)
Enable denoising (if supported).
static void SetEastPole(double *, vtkRenderer *renderer)
Convenience method to set/get EAST_POLE on a vtkRenderer.
static vtkInformationObjectBaseKey * MATERIAL_LIBRARY()
Material Library attached to the renderer.
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)
Convenience method to set/get MAX_CONTRIBUTION on a vtkRenderer.
vtkOSPRayRendererNodeInternals * Internal
static int GetTimeCacheSize(vtkRenderer *renderer)
Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.
static void SetMinContribution(double, vtkRenderer *renderer)
Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.
static int GetMaxFrames(vtkRenderer *renderer)
When present on renderer, controls the number of ospray render calls for each refresh.
std::vector< float > ODepthBuffer
static int GetMaxDepth(vtkRenderer *renderer)
Convenience method to set/get MAX_DEPTH on a vtkRenderer.
static vtkInformationIntegerKey * BACKGROUND_MODE()
Control use of the path tracer backplate and environmental background.
static vtkInformationIntegerKey * ROULETTE_DEPTH()
When present on renderer, controls the ray recursion depth at which to start Russian roulette termina...
static BackgroundMode GetBackgroundMode(vtkRenderer *renderer)
Control use of the path tracer backplate and environmental background.
static double GetViewTime(vtkRenderer *renderer)
Convenience method to set/get VIEW_TIME on a vtkRenderer.
static double * GetEastPole(vtkRenderer *renderer)
Convenience method to set/get EAST_POLE on a vtkRenderer.
std::vector< OSPLight > Lights
static vtkInformationIntegerKey * MAX_DEPTH()
When present on renderer, controls the maximum ray recursion depth default is 20.
static std::string GetRendererType(vtkRenderer *renderer)
Set the OSPRay renderer type to use (e.g.
static vtkInformationIntegerKey * TIME_CACHE_SIZE()
Temporal cache size.
vtkOSPRayCache< vtkOSPRayCacheItemObject > * Cache
static void SetDenoiserThreshold(int, vtkRenderer *renderer)
Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.
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.
virtual void * GetBuffer()
Get the last rendered ColorBuffer.
static double GetMinContribution(vtkRenderer *renderer)
Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.
std::set< OSPWorld > CacheContents
virtual int GetDepthBufferTextureGL()
static vtkInformationDoubleKey * VARIANCE_THRESHOLD()
When present on renderer, controls the threshold for adaptive accumulation default is 0....
static vtkInformationIntegerKey * COMPOSITE_ON_GL()
used to make the renderer add ospray's content onto GL rendered content on the window
std::vector< osp::vec3f > AlbedoBuffer
void AddLight(OSPLight light)
void Render(bool prepass) override
Traverse graph in ospray's preferred order and render.
static vtkOSPRayMaterialLibrary * GetMaterialLibrary(vtkRenderer *renderer)
Convenience method to set/get Material library on a renderer.
static int GetSamplesPerPixel(vtkRenderer *renderer)
Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.
static vtkInformationIntegerKey * AMBIENT_SAMPLES()
When present on renderer, controls the number of ambient occlusion samples shot per hit.
std::vector< osp::vec4f > ColorBuffer
static vtkInformationIntegerKey * ENABLE_DENOISER()
Enable denoising (if supported).
static void SetNorthPole(double *, vtkRenderer *renderer)
Convenience method to set/get NORTH_POLE on a vtkRenderer.
static double * GetNorthPole(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 int GetCompositeOnGL(vtkRenderer *renderer)
Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.
void Traverse(int operation) override
static vtkOSPRayRendererNode * New()
static void SetViewTime(double, vtkRenderer *renderer)
Convenience method to set/get VIEW_TIME on a vtkRenderer.
void Invalidate(bool prepass) override
Invalidates cached rendering data.
static void SetSamplesPerPixel(int, vtkRenderer *renderer)
Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.
std::vector< osp::vec4f > DenoisedBuffer
static vtkInformationDoubleVectorKey * NORTH_POLE()
World space direction of north pole for gradient and texture background.
void Denoise()
Denoise the colors stored in ColorBuffer and put into Buffer.
std::vector< OSPGeometricModel > GeometricModels
static vtkInformationIntegerKey * MAX_FRAMES()
When present on renderer, controls the number of ospray render calls for each refresh.
static vtkInformationDoubleVectorKey * EAST_POLE()
World space direction of east pole for texture background.
static void SetEnableDenoiser(int, vtkRenderer *renderer)
Convenience method to set/get ENABLE_DENOISER on a vtkRenderer.
static vtkInformationIntegerKey * DENOISER_THRESHOLD()
Accumulation threshold when above which denoising kicks in.
static int GetDenoiserThreshold(vtkRenderer *renderer)
Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.
static void SetTimeCacheSize(int, vtkRenderer *renderer)
Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.
static vtkInformationStringKey * RENDERER_TYPE()
Set the OSPRay renderer type to use (e.g.
vtkRenderer * GetRenderer()
static vtkInformationDoubleKey * VIEW_TIME()
Requested time to show in a renderer and to lookup in a temporal cache.
static void SetBackgroundMode(BackgroundMode, vtkRenderer *renderer)
Control use of the path tracer backplate and environmental background.
vtkViewNode specialized for vtkRenderers
abstract specification for renderers
Definition: vtkRenderer.h:73
a node within a VTK scene graph
Definition: vtkViewNode.h:42
#define VTK_DEPRECATED_IN_9_2_0(reason)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287