BroadPhase.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
 
#include <Jolt/Physics/Collision/BroadPhase/BroadPhaseQuery.h>
#include <Jolt/Physics/Collision/BroadPhase/BroadPhaseLayer.h>
 
JPH_NAMESPACE_BEGIN
 
// Shorthand function to ifdef out code if broadphase stats tracking is off
#ifdef JPH_TRACK_BROADPHASE_STATS
    #define JPH_IF_TRACK_BROADPHASE_STATS(...) __VA_ARGS__
#else
    #define JPH_IF_TRACK_BROADPHASE_STATS(...)
#endif // JPH_TRACK_BROADPHASE_STATS
 
class BodyManager;
struct BodyPair;
 
using BodyPairCollector = CollisionCollector<BodyPair, CollisionCollectorTraitsCollideShape>;
 
class JPH_EXPORT BroadPhase : public BroadPhaseQuery
{
public:
    virtual void        Init(BodyManager *inBodyManager, const BroadPhaseLayerInterface &inLayerInterface);
 
    virtual void        Optimize()                                                          { /* Optionally overridden by implementation */ }
 
    virtual void        FrameSync()                                                         { /* Optionally overridden by implementation */ }
 
    virtual void        LockModifications()                                                 { /* Optionally overridden by implementation */ }
 
    struct UpdateState { void *mData[4]; };
 
    virtual UpdateState UpdatePrepare()                                                     { return UpdateState(); }
 
    virtual void        UpdateFinalize([[maybe_unused]] const UpdateState &inUpdateState)   { /* Optionally overridden by implementation */ }
 
    virtual void        UnlockModifications()                                               { /* Optionally overridden by implementation */ }
 
    using AddState = void *;
 
    virtual AddState    AddBodiesPrepare([[maybe_unused]] BodyID *ioBodies, [[maybe_unused]] int inNumber) { return nullptr; } // By default the broadphase doesn't support this
 
    virtual void        AddBodiesFinalize(BodyID *ioBodies, int inNumber, AddState inAddState) = 0;
 
    virtual void        AddBodiesAbort([[maybe_unused]] BodyID *ioBodies, [[maybe_unused]] int inNumber, [[maybe_unused]] AddState inAddState)  { /* By default nothing needs to be done */ }
 
    virtual void        RemoveBodies(BodyID *ioBodies, int inNumber) = 0;
 
    virtual void        NotifyBodiesAABBChanged(BodyID *ioBodies, int inNumber, bool inTakeLock = true) = 0;
 
    virtual void        NotifyBodiesLayerChanged(BodyID *ioBodies, int inNumber) = 0;
 
    virtual void        FindCollidingPairs(BodyID *ioActiveBodies, int inNumActiveBodies, float inSpeculativeContactDistance, const ObjectVsBroadPhaseLayerFilter &inObjectVsBroadPhaseLayerFilter, const ObjectLayerPairFilter &inObjectLayerPairFilter, BodyPairCollector &ioPairCollector) const = 0;
 
    virtual void        CastAABoxNoLock(const AABoxCast &inBox, CastShapeBodyCollector &ioCollector, const BroadPhaseLayerFilter &inBroadPhaseLayerFilter, const ObjectLayerFilter &inObjectLayerFilter) const = 0;
 
    virtual AABox       GetBounds() const = 0;
 
#ifdef JPH_TRACK_BROADPHASE_STATS
    virtual void        ReportStats()                                                       { /* Can be implemented by derived classes */ }
#endif // JPH_TRACK_BROADPHASE_STATS
 
protected:
    BodyManager *       mBodyManager = nullptr;
};
 
JPH_NAMESPACE_END