RaytraceOutputHandler.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
#pragma once
#include <agxSensor/RaytraceOutput.h>
#include <agxSensor/RaytraceRemoveRayMisses.h>
#include <agxSensor/RaytraceOutputNoise.h>
#include <agxSensor/SensorOutputHandler.h>
 
#include <agx/HashTable.h>
 
namespace agxSensor
{
  class RtNodeGroupHandler;
 
  AGX_DECLARE_POINTER_TYPES( RtOutputHandler );
 
  class AGXSENSOR_EXPORT RtOutputHandler : public RtSystemNode, public ISensorOutputHandler
  {
    public:
      enum RuntimeFlag : agx::UInt32
      {
        RAYTRACING = 1 << 0,
        FETCHING_DATA = 1 << 1,
        RESTORED = 1 << 2
      };
 
      using RuntimeState = agx::AtomicState<RuntimeFlag>;
 
    public:
      RtOutputHandler();
 
      bool add( size_t uniqueId, RtOutput* output );
 
      template<typename T, RtOutput::Field... field>
      RtOutput* add();
 
      RtOutput* get( size_t uniqueId );
 
      ISensorOutput* getBase( size_t uniqueId ) override;
 
      template<typename T>
      RtOutput* get();
 
      template<typename T>
      BinaryOutputView<T> view();
 
      void setRaytraceDepth( size_t steps = 1 );
 
      size_t getRaytraceDepth() const;
 
      void setAmbientHitSeed( agx::UInt32 seed = 783u );
 
      agx::UInt32 getAmbientHitSeed() const;
 
      void setEnableRemoveRayMisses( bool enable );
 
      bool getEnableRemoveRayMisses() const;
 
      bool add( RtOutputNoise* noise );
 
      bool remove( RtOutputNoise* noise );
 
      bool contains( const RtOutputNoise* noise ) const;
 
      RtOutputNoiseRefVector getOutputNoises() const;
 
      DOXYGEN_START_INTERNAL_BLOCK()
 
    public:
      using ISensorOutputHandler::view;
 
    public:
 
      RtSystemNodeProxy* getProxy( const RtOutputNoise* noise ) const;
 
      virtual void onParentConnect( RtSystemNode& parent ) override;
 
      virtual void execute( const CallbackData& data ) override;
 
      virtual void complete() override;
 
      AGXSTREAM_DECLARE_SERIALIZABLE( agxSensor::RtOutputHandler );
 
      virtual bool insertParent( SystemNode& parent ) override;
 
    protected:
      virtual RtNode* createNode() final override;
 
      DOXYGEN_END_INTERNAL_BLOCK()
 
    private:
      struct OutputNoiseData
      {
        RtOutputNoiseRef noise;
        RtSystemNodeRef proxy;
      };
 
      bool tryAssembleLocalRtOutputChain();
 
    private:
      using OutputTable = agx::HashTable<size_t, RtOutputRef>;
      using OutputNoiseDataVector = std::vector<OutputNoiseData>;
 
    private:
      RtNodeGroupHandler* getExitNode() const;
 
    private:
      OutputTable m_outputs;
      RuntimeState m_runtimeState;
      RtNode* m_parentNode;
      size_t m_raytraceDepth;
      RtNode* m_raytraceNode;
      RtNode* m_beamDivergenceNode;
      agx::UInt32 m_ambientHitSeed;
      RtNode* m_assemblyNode;
      RtRemoveRayMissesRef m_removeRayMisses;
      OutputNoiseDataVector m_outputNoises;
  };
 
  template<typename T, RtOutput::Field... field>
  RtOutput* RtOutputHandler::add()
  {
    RtOutputRef output = new RtOutput();
    output->build<field...>();
 
    if ( !RtOutput::template verifySize<T>( output->getElementSize() ) )
      return nullptr;
 
    if ( !this->add( RtOutput::template getTypeHash<T>(), output ) )
      return nullptr;
 
    return output;
  }
 
  template<typename T>
  RtOutput* RtOutputHandler::get()
  {
    return this->get( RtOutput::template getTypeHash<T>() );
  }
 
  template<typename T>
  BinaryOutputView<T> RtOutputHandler::view()
  {
    return this->view<T>( RtOutput::template getTypeHash<T>() );
  }
}