HitDetail.h

Go to the documentation of this file.

#pragma once
 
#include "Math/TVector3.h"
#include "Math/TOrthonormalBasis3.h"
#include "Math/math.h"
#include "Core/ECoordSys.h"
#include "Core/HitInfo.h"
#include "Core/FaceTopology.h"
#include "Utility/utility.h"
 
#include <Common/assertion.h>
#include <Common/primitive_type.h>
 
#include <cstddef>
#include <utility>
#include <cmath>
 
namespace ph { class Primitive; }
 
namespace ph
{
 
class HitDetail final
{
public:
    inline static constexpr auto NO_FACE_ID = static_cast<uint64>(-1);
 
    HitDetail();
 
    HitDetail& setHitIntrinsics(
        const Primitive*      primitive,
        const math::Vector3R& uvw,
        real                  rayT,
        uint64                faceID = NO_FACE_ID,
        FaceTopology          faceTopology = FaceTopology(EFaceTopology::General));
 
    void computeBases();
 
    math::Vector3R getPos(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getShadingNormal(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getGeometryNormal(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getdPdU(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getdPdV(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getdNdU(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getdNdV(ECoordSys coordSys = ECoordSys::World) const;
    math::Vector3R getUVW() const;
    const math::Basis3R& getGeometryBasis(ECoordSys coordSys = ECoordSys::World) const;
    const math::Basis3R& getShadingBasis(ECoordSys coordSys = ECoordSys::World) const;
 
    real getRayT() const;
 
    uint64 getFaceID() const;
 
    FaceTopology getFaceTopology() const;
 
    const Primitive* getPrimitive() const;
 
    const HitInfo& getHitInfo(ECoordSys coordSys = ECoordSys::World) const;
    HitInfo& getHitInfo(ECoordSys coordSys = ECoordSys::World);
    std::pair<real, real> getDistanceErrorFactors() const;
    void setDistanceErrorFactors(real meanFactor, real maxFactor);
 
private:
    const Primitive* m_primitive;
    math::Vector3R   m_uvw;
    real             m_rayT;
    HitInfo          m_hitInfos[enum_size<ECoordSys>()];
    uint64           m_faceID;
    FaceTopology     m_faceTopology;
    int8             m_meanDistanceErrorFactorExp2;
    int8             m_maxDistanceErrorFactorExp2;
};
 
// In-header Implementations:
 
inline math::Vector3R HitDetail::getPos(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getPos();
}
 
inline math::Vector3R HitDetail::getShadingNormal(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getShadingNormal();
}
 
inline math::Vector3R HitDetail::getGeometryNormal(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getGeometryNormal();
}
 
inline math::Vector3R HitDetail::getdPdU(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getdPdU();
}
 
inline math::Vector3R HitDetail::getdPdV(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getdPdV();
}
 
inline math::Vector3R HitDetail::getdNdU(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getdNdU();
}
 
inline math::Vector3R HitDetail::getdNdV(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getdNdV();
}
 
inline const math::Basis3R& HitDetail::getGeometryBasis(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getGeometryBasis();
}
 
inline const math::Basis3R& HitDetail::getShadingBasis(const ECoordSys coordSys) const
{
    return getHitInfo(coordSys).getShadingBasis();
}
 
inline real HitDetail::getRayT() const
{
    return m_rayT;
}
 
inline uint64 HitDetail::getFaceID() const
{
    return m_faceID;
}
 
inline FaceTopology HitDetail::getFaceTopology() const
{
    return FaceTopology(m_faceTopology);
}
 
inline const Primitive* HitDetail::getPrimitive() const
{
    return m_primitive;
}
 
inline math::Vector3R HitDetail::getUVW() const
{
    return m_uvw;
}
 
inline const HitInfo& HitDetail::getHitInfo(const ECoordSys coordSys) const
{
    PH_ASSERT_IN_RANGE(enum_to_value(coordSys), 0, enum_size<ECoordSys>());
    return m_hitInfos[enum_to_value(coordSys)];
}
 
inline HitInfo& HitDetail::getHitInfo(const ECoordSys coordSys)
{
    PH_ASSERT_IN_RANGE(enum_to_value(coordSys), 0, enum_size<ECoordSys>());
    return m_hitInfos[enum_to_value(coordSys)];
}
 
inline std::pair<real, real> HitDetail::getDistanceErrorFactors() const
{
    return {
        static_cast<real>(std::exp2(m_meanDistanceErrorFactorExp2)),
        static_cast<real>(std::exp2(m_maxDistanceErrorFactorExp2))};
}
 
inline void HitDetail::setDistanceErrorFactors(const real meanFactor, const real maxFactor)
{
    // These should be absolute values
    PH_ASSERT_GE(meanFactor, 0.0_r);
    PH_ASSERT_GE(maxFactor, 0.0_r);
 
    m_meanDistanceErrorFactorExp2 = static_cast<int8>(std::round(std::log2(meanFactor)));
    m_maxDistanceErrorFactorExp2 = static_cast<int8>(std::ceil(std::log2(maxFactor)));
}
 
}// end namespace ph