vtkAnariSceneGraph.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkAnariSceneGraph_h
#define vtkAnariSceneGraph_h

#include "vtkRendererNode.h"
#include "vtkRenderingAnariModule.h" // For export macro

#include <anari/anari_cpp.hpp> // For ANARI handles

VTK_ABI_NAMESPACE_BEGIN

class vtkInformationIntegerKey;
class vtkInformationDoubleKey;
class vtkInformationObjectBaseKey;
class vtkInformationStringKey;
class vtkInformationDoubleVectorKey;
class vtkAnariSceneGraphInternals;
class vtkRenderer;
class vtkAnariDevice;
class vtkRenderMaterialLibrary;

class VTKRENDERINGANARI_EXPORT vtkAnariSceneGraph : public vtkRendererNode
{
public:
  static vtkAnariSceneGraph* New();
  vtkTypeMacro(vtkAnariSceneGraph, vtkRendererNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Build(bool prepass) override;

  void Render(bool prepass) override;

  void Invalidate(bool prepass) override;

  // state beyond rendering core...

  void SetUpdateWorldOnly(bool onlyUpdateWorld = false);

  static vtkInformationIntegerKey* ACCUMULATION_COUNT();

  static void SetAccumulationCount(vtkRenderer* renderer, int);
  static int GetAccumulationCount(vtkRenderer* renderer);

  static vtkInformationIntegerKey* COMPOSITE_ON_GL();

  static void SetCompositeOnGL(vtkRenderer* renderer, int);
  static int GetCompositeOnGL(vtkRenderer* renderer);


  void AddLight(anari::Light);

  void AddSurface(anari::Surface);

  void AddVolume(anari::Volume);

  void SetCamera(anari::Camera);

  anari::Device GetDeviceHandle() const;

  anari::Renderer GetRendererHandle() const;

  const anari::Extensions& GetAnariDeviceExtensions() const;

  const char* const* GetAnariDeviceExtensionStrings() const;

  virtual const unsigned char* GetBuffer();

  virtual const float* GetZBuffer();

  // if you want to traverse your children in a specific order
  // or way override this method
  virtual void Traverse(int operation) override;

  vtkRenderer* GetRenderer();

  virtual void WriteLayer(unsigned char* buffer, float* zbuffer, int buffx, int buffy, int layer);

  void InvalidateSceneStructure();

  static vtkInformationObjectBaseKey* MATERIAL_LIBRARY();


  static void SetMaterialLibrary(vtkRenderMaterialLibrary*, vtkRenderer* renderer);
  static vtkRenderMaterialLibrary* GetMaterialLibrary(vtkRenderer* renderer);

  static vtkInformationStringKey* MATERIAL_NAMES();

  int ReservePropId();

  void WarningMacroOnce(vtkSmartPointer<vtkObject> caller, const std::string& warning);

protected:
  vtkAnariSceneGraph();
  ~vtkAnariSceneGraph() override;

  void InitAnariFrame(vtkRenderer* ren);
  void SetupAnariRendererParameters(vtkRenderer* ren);
  void InitAnariWorld();
  void UpdateAnariFrameSize();
  void UpdateAnariLights();
  void UpdateAnariSurfaces();
  void UpdateAnariVolumes();
  void CopyAnariFrameBufferData();
  void DebugOutputWorldBounds();
  void ResetReservedPropIds();

  vtkAnariSceneGraphInternals* Internal{ nullptr };

  vtkTimeStamp AnariSceneStructureModifiedMTime;
  vtkMTimeType AnariSceneConstructedMTime{ 0 };
  vtkTimeStamp AnariRendererModifiedTime;
  vtkMTimeType AnariRendererUpdatedTime{ 0 };

  std::map<std::string, std::vector<std::string>> IssuedWarnings;

private:
  vtkAnariSceneGraph(const vtkAnariSceneGraph&) = delete;
  void operator=(const vtkAnariSceneGraph&) = delete;

  void SetAnariDevice(vtkAnariDevice* ad, anari::Extensions e, const char* const* es);
  void SetAnariRenderer(anari::Renderer r);

  // only allow these classes to set the Anari device + renderer
  friend class vtkAnariPass;
};

VTK_ABI_NAMESPACE_END
#endif