BroadPhaseLayer.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/Core/NonCopyable.h>
#include <Jolt/Physics/Collision/ObjectLayer.h>
 
JPH_NAMESPACE_BEGIN
 
class BroadPhaseLayer
{
public:
    using Type = uint8;
 
    JPH_INLINE                      BroadPhaseLayer() = default;
    JPH_INLINE explicit constexpr   BroadPhaseLayer(Type inValue) : mValue(inValue) { }
    JPH_INLINE constexpr            BroadPhaseLayer(const BroadPhaseLayer &) = default;
    JPH_INLINE BroadPhaseLayer &    operator = (const BroadPhaseLayer &) = default;
 
    JPH_INLINE constexpr bool       operator == (const BroadPhaseLayer &inRHS) const
    {
        return mValue == inRHS.mValue;
    }
 
    JPH_INLINE constexpr bool       operator != (const BroadPhaseLayer &inRHS) const
    {
        return mValue != inRHS.mValue;
    }
 
    JPH_INLINE constexpr bool       operator < (const BroadPhaseLayer &inRHS) const
    {
        return mValue < inRHS.mValue;
    }
 
    JPH_INLINE explicit constexpr   operator Type() const
    {
        return mValue;
    }
 
    JPH_INLINE Type                 GetValue() const
    {
        return mValue;
    }
 
private:
    Type                            mValue;
};
 
static constexpr BroadPhaseLayer cBroadPhaseLayerInvalid(0xff);
 
class JPH_EXPORT BroadPhaseLayerInterface : public NonCopyable
{
public:
    virtual                         ~BroadPhaseLayerInterface() = default;
 
    virtual uint                    GetNumBroadPhaseLayers() const = 0;
 
    virtual BroadPhaseLayer         GetBroadPhaseLayer(ObjectLayer inLayer) const = 0;
 
#if defined(JPH_EXTERNAL_PROFILE) || defined(JPH_PROFILE_ENABLED)
    virtual const char *            GetBroadPhaseLayerName(BroadPhaseLayer inLayer) const = 0;
#endif // JPH_EXTERNAL_PROFILE || JPH_PROFILE_ENABLED
};
 
class JPH_EXPORT ObjectVsBroadPhaseLayerFilter : public NonCopyable
{
public:
    virtual                         ~ObjectVsBroadPhaseLayerFilter() = default;
 
    virtual bool                    ShouldCollide([[maybe_unused]] ObjectLayer inLayer1, [[maybe_unused]] BroadPhaseLayer inLayer2) const
    {
        return true;
    }
};
 
class JPH_EXPORT BroadPhaseLayerFilter : public NonCopyable
{
public:
    virtual                         ~BroadPhaseLayerFilter() = default;
 
    virtual bool                    ShouldCollide([[maybe_unused]] BroadPhaseLayer inLayer) const
    {
        return true;
    }
};
 
class JPH_EXPORT DefaultBroadPhaseLayerFilter : public BroadPhaseLayerFilter
{
public:
                                    DefaultBroadPhaseLayerFilter(const ObjectVsBroadPhaseLayerFilter &inObjectVsBroadPhaseLayerFilter, ObjectLayer inLayer) :
        mObjectVsBroadPhaseLayerFilter(inObjectVsBroadPhaseLayerFilter),
        mLayer(inLayer)
    {
    }
 
    // See BroadPhaseLayerFilter::ShouldCollide
    virtual bool                    ShouldCollide(BroadPhaseLayer inLayer) const override
    {
        return mObjectVsBroadPhaseLayerFilter.ShouldCollide(mLayer, inLayer);
    }
 
private:
    const ObjectVsBroadPhaseLayerFilter &mObjectVsBroadPhaseLayerFilter;
    ObjectLayer                     mLayer;
};
 
class JPH_EXPORT SpecifiedBroadPhaseLayerFilter : public BroadPhaseLayerFilter
{
public:
    explicit                        SpecifiedBroadPhaseLayerFilter(BroadPhaseLayer inLayer) :
        mLayer(inLayer)
    {
    }
 
    // See BroadPhaseLayerFilter::ShouldCollide
    virtual bool                    ShouldCollide(BroadPhaseLayer inLayer) const override
    {
        return mLayer == inLayer;
    }
 
private:
    BroadPhaseLayer                 mLayer;
};
 
JPH_NAMESPACE_END