RaytraceHandles.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/RaytraceRegistry.h>
 
#include <agxCollide/Shape.h>
 
namespace agxCollide
{
  class MeshData;
}
 
namespace agxSensor
{
  class RtInstanceData;
 
  struct RtSceneHandle;
  struct RtScene;
  struct RtShape;
  struct RtShapeInstanceHandle;
  struct RtMaterialHandle;
 
  using RtSceneHandleRef = std::shared_ptr<RtSceneHandle>;
  using RtSceneRef = std::shared_ptr<RtScene>;
 
  using RtShapeRef = std::shared_ptr<RtShape>;
  using RtShapeInstanceHandleRef = std::shared_ptr<RtShapeInstanceHandle>;
  using RtMaterialHandleRef = std::shared_ptr<RtMaterialHandle>;
 
  struct AGXSENSOR_EXPORT RtMaterialHandle
  {
    enum class Type
    {
      UNKNOWN,
      OPAQUE_LAMBERTIAN,
      OPAQUE_GGX_AND_OREN_NAYAR,
      OPAQUE_BRDF_EXPLICIT,
      AMBIENT_ATMOSPHERE,
      NUM_TYPES
    };
  };
 
  struct AGXSENSOR_EXPORT RtMaterialInstance
  {
    static RtMaterialInstance create( RtMaterialHandle::Type type );
 
    RtMaterialInstance as( RtMaterialHandle::Type inType ) const;
 
    template<RtMaterialHandle::Type Type>
    RtMaterialInstance as() const;
 
    bool is( RtMaterialHandle::Type inType ) const;
 
    template<RtMaterialHandle::Type Type>
    bool is() const;
 
    bool operator== ( const RtMaterialInstance& other ) const;
 
    bool operator!= ( const RtMaterialInstance& other ) const;
 
    RtMaterialHandleRef handle{ nullptr };
    RtMaterialHandle::Type type{ RtMaterialHandle::Type::UNKNOWN };
  };
 
  inline RtMaterialInstance RtMaterialInstance::as( RtMaterialHandle::Type inType ) const
  {
    return is( inType ) ?
             *this :
             // Invalid material of given inType.
             RtMaterialInstance{ nullptr, inType };
  }
 
  template<RtMaterialHandle::Type Type>
  inline RtMaterialInstance RtMaterialInstance::as() const
  {
    return this->as( Type );
  }
 
  inline bool RtMaterialInstance::is( RtMaterialHandle::Type inType ) const
  {
    return this->type == inType;
  }
 
  template<RtMaterialHandle::Type Type>
  inline bool RtMaterialInstance::is() const
  {
    return this->is( Type );
  }
 
  inline bool RtMaterialInstance::operator== ( const RtMaterialInstance& other ) const
  {
    return handle == other.handle && type == other.type;
  }
 
  inline bool RtMaterialInstance::operator!= ( const RtMaterialInstance& other ) const
  {
    return !( *this == other );
  }
 
  struct AGXSENSOR_EXPORT RtSceneHandle
  {
    static RtSceneHandleRef create();
  };
 
  struct AGXSENSOR_EXPORT RtScene
  {
    static RtSceneRef create();
 
    void setMaterial( RtMaterialInstance newMaterial );
 
    RtSceneHandleRef handle{ nullptr };
    RtMaterialInstance material{ nullptr };
  };
 
  struct AGXSENSOR_EXPORT RtShape
  {
    static RtShapeRef create( const agx::Vec3Vector& vertices, const agx::UInt32Vector& indices );
 
    static RtShapeRef create( const agx::Vec3Vector& vertices, const agx::UInt32Vector& indices, const agx::Vec3Vector& normals );
 
    static RtShapeRef create( const agxCollide::MeshData* data );
 
    static RtShapeRef create( agxCollide::Shape::Type shapeType );
 
    static RtShapeRef create( const agxCollide::Shape* shape );
 
    static RtShapeRef create( const agxCollide::RenderData* renderData );
 
    void setVertices( const agx::Vec3Vector& vertices );
  };
  using RtShapeHandle = RtShape;
  using RtShapeHandleRef = RtShapeRef;
 
  struct AGXSENSOR_EXPORT RtShapeInstanceHandle
  {
    void setTransform( const agx::AffineMatrix4x4& agxTransform,
                       agx::Vec3 scale = agx::Vec3( 1 ) );
 
    void setEntityId( RtEntityId id );
 
    void setMaterial( RtMaterialInstance materialInstance );
  };
 
  struct AGXSENSOR_EXPORT RtNode
  {
  };
}