RaytraceAmbientMaterial.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/RaytraceMaterial.h>
 
namespace agxSensor
{
  class AGXSENSOR_EXPORT RtAmbientMaterial : public RtMaterial
  {
    public:
      static constexpr RtMaterialHandle::Type Type = RtMaterialHandle::Type::AMBIENT_ATMOSPHERE;
 
    public:
      static RtAmbientMaterial create();
 
    public:
      RtAmbientMaterial( RtMaterialInstance instance );
 
      float getRefractiveIndex() const;
 
      RtAmbientMaterial setRefractiveIndex( float refractiveIndex );
 
      float getAttenuationCoefficient() const;
 
      RtAmbientMaterial setAttenuationCoefficient( float alpha );
 
      float getReturnProbabilityScaling() const;
 
      RtAmbientMaterial setReturnProbabilityScaling( float A );
 
      float getReturnGammaDistributionShapeParameter() const;
 
      RtAmbientMaterial setReturnGammaDistributionShapeParameter( float k );
 
      float getReturnGammaDistributionScaleParameter() const;
 
      RtAmbientMaterial setReturnGammaDistributionScaleParameter( float theta );
 
      RtAmbientMaterial configureAsAir( float visibility );
 
      RtAmbientMaterial configureAsFog( float visibility, float wavelength, 
                                        float maritimeness = 0.0f );
 
      RtAmbientMaterial configureAsRainfall( float rate, float tropicalness = 0.0f );
 
      RtAmbientMaterial configureAsSnowfall( float rate, float wavelength );
 
    public:
      void store( agxStream::OutputArchive& out ) const;
      void restore( agxStream::InputArchive& in );
 
    private:
      using RtMaterial::RtMaterial;
  };
}