Emitter.h

Go to the documentation of this file.

#pragma once
 
#include "Math/math_fwd.h"
#include "Math/math.h"
#include "Math/Color/Spectrum.h"
#include "Utility/TBitFlags.h"
 
#include <Common/primitive_type.h>
 
namespace ph
{
 
class SurfaceHit;
class HitProbe;
class DirectEnergySampleQuery;
class DirectEnergyPdfQuery;
class EnergyEmissionSampleQuery;
class SampleFlow;
 
namespace detail
{
 
using EmitterFlagIntType = uint8;
 
inline constexpr auto efs_zero_bounce_sample_bits = math::flag_bit<uint8, 1>();
inline constexpr auto efs_bsdf_sample_bits        = math::flag_bit<uint8, 2>();
inline constexpr auto efs_direct_sample_bits      = math::flag_bit<uint8, 3>();
inline constexpr auto efs_emission_sample_bits    = math::flag_bit<uint8, 4>();
 
}// end namespace detail
 
enum class EEmitterFeatureSet : detail::EmitterFlagIntType
{
    ZeroBounceSample = detail::efs_zero_bounce_sample_bits,
 
    BsdfSample = detail::efs_bsdf_sample_bits,
 
    DirectSample = detail::efs_direct_sample_bits,
 
    EmissionSample = detail::efs_emission_sample_bits,
 
    // Special values:
 
    Default = 
        detail::efs_zero_bounce_sample_bits |
        detail::efs_bsdf_sample_bits |
        detail::efs_direct_sample_bits |
        detail::efs_emission_sample_bits,
};
 
PH_DEFINE_INLINE_ENUM_FLAG_OPERATORS(EEmitterFeatureSet);
 
using EmitterFeatureSet = TEnumFlags<EEmitterFeatureSet>;
 
class Emitter
{
public:
    constexpr static auto defaultFeatureSet = EmitterFeatureSet(EEmitterFeatureSet::Default);
 
    explicit Emitter(EmitterFeatureSet featureSet = defaultFeatureSet);
 
    virtual ~Emitter();
 
    virtual void evalEmittedEnergy(const SurfaceHit& Xe, math::Spectrum* out_energy) const = 0;
 
    virtual void genDirectSample(
        DirectEnergySampleQuery& query, 
        SampleFlow& sampleFlow,
        HitProbe& probe) const = 0;
 
    virtual void calcDirectPdf(DirectEnergyPdfQuery& query) const = 0;
 
    virtual void emitRay(
        EnergyEmissionSampleQuery& query, 
        SampleFlow& sampleFlow,
        HitProbe& probe) const = 0;
 
    virtual real calcRadiantFluxApprox() const;
 
    EmitterFeatureSet getFeatureSet() const;
 
private:
    EmitterFeatureSet m_featureSet;
};
 
// In-header Implementations:
 
inline real Emitter::calcRadiantFluxApprox() const
{
    // Non-zero to avoid not being sampled
    return 1.0_r;
}
 
inline EmitterFeatureSet Emitter::getFeatureSet() const
{
    return m_featureSet;
}
 
}// end namespace ph