CollisionCollector.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
JPH_NAMESPACE_BEGIN
 
class Body;
class TransformedShape;
 
class CollisionCollectorTraitsCastRay
{
public:
    static constexpr float InitialEarlyOutFraction = 1.0f + FLT_EPSILON;    
    static constexpr float ShouldEarlyOutFraction = 0.0f;                   
};
 
class CollisionCollectorTraitsCastShape
{
public:
    static constexpr float InitialEarlyOutFraction = 1.0f + FLT_EPSILON;    
    static constexpr float ShouldEarlyOutFraction = -FLT_MAX;               
};
 
class CollisionCollectorTraitsCollideShape
{
public:
    static constexpr float InitialEarlyOutFraction = FLT_MAX;               
    static constexpr float ShouldEarlyOutFraction = -FLT_MAX;               
};
 
using CollisionCollectorTraitsCollidePoint = CollisionCollectorTraitsCollideShape;
 
template <class ResultTypeArg, class TraitsType>
class CollisionCollector
{
public:
    using ResultType = ResultTypeArg;
 
                            CollisionCollector() = default;
 
    template <class ResultTypeArg2>
    explicit                CollisionCollector(const CollisionCollector<ResultTypeArg2, TraitsType> &inRHS) : mEarlyOutFraction(inRHS.GetEarlyOutFraction()), mContext(inRHS.GetContext()) { }
                            CollisionCollector(const CollisionCollector<ResultTypeArg, TraitsType> &inRHS) = default;
 
    virtual                 ~CollisionCollector() = default;
 
    virtual void            Reset()                                         { mEarlyOutFraction = TraitsType::InitialEarlyOutFraction; }
 
    virtual void            OnBody([[maybe_unused]] const Body &inBody)     { /* Collects nothing by default */ }
 
    void                    SetContext(const TransformedShape *inContext)   { mContext = inContext; }
    const TransformedShape *GetContext() const                              { return mContext; }
 
    virtual void            SetUserData(uint64 inUserData)                  { /* Does nothing by default */ }
 
    virtual void            AddHit(const ResultType &inResult) = 0;
 
    inline void             UpdateEarlyOutFraction(float inFraction)        { JPH_ASSERT(inFraction <= mEarlyOutFraction); mEarlyOutFraction = inFraction; }
 
    inline void             ResetEarlyOutFraction(float inFraction = TraitsType::InitialEarlyOutFraction) { mEarlyOutFraction = inFraction; }
 
    inline void             ForceEarlyOut()                                 { mEarlyOutFraction = TraitsType::ShouldEarlyOutFraction; }
 
    inline bool             ShouldEarlyOut() const                          { return mEarlyOutFraction <= TraitsType::ShouldEarlyOutFraction; }
 
    inline float            GetEarlyOutFraction() const                     { return mEarlyOutFraction; }
 
    inline float            GetPositiveEarlyOutFraction() const             { return max(FLT_MIN, mEarlyOutFraction); }
 
private:
    float                   mEarlyOutFraction = TraitsType::InitialEarlyOutFraction;
 
    const TransformedShape *mContext = nullptr;
};
 
JPH_NAMESPACE_END