ObjectLayer.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>
 
JPH_NAMESPACE_BEGIN
 
#if JPH_OBJECT_LAYER_BITS == 16
    using ObjectLayer = uint16;
#elif JPH_OBJECT_LAYER_BITS == 32
    using ObjectLayer = uint32;
#elif JPH_OBJECT_LAYER_BITS == 64
    using ObjectLayer = uint64;
#else
    #error Invalid value for JPH_OBJECT_LAYER_BITS. Must be 16, 32 or 64.
#endif
 
static constexpr ObjectLayer cObjectLayerInvalid = ObjectLayer(~ObjectLayer(0U));
 
class JPH_EXPORT ObjectLayerFilter : public NonCopyable
{
public:
    virtual                 ~ObjectLayerFilter() = default;
 
    virtual bool            ShouldCollide([[maybe_unused]] ObjectLayer inLayer) const
    {
        return true;
    }
 
#ifdef JPH_TRACK_BROADPHASE_STATS
    virtual String          GetDescription() const
    {
        return "No Description";
    }
#endif // JPH_TRACK_BROADPHASE_STATS
};
 
class JPH_EXPORT ObjectLayerPairFilter : public NonCopyable
{
public:
    virtual                 ~ObjectLayerPairFilter() = default;
 
    virtual bool            ShouldCollide([[maybe_unused]] ObjectLayer inLayer1, [[maybe_unused]] ObjectLayer inLayer2) const
    {
        return true;
    }
};
 
class JPH_EXPORT DefaultObjectLayerFilter : public ObjectLayerFilter
{
public:
                            DefaultObjectLayerFilter(const ObjectLayerPairFilter &inObjectLayerPairFilter, ObjectLayer inLayer) :
        mObjectLayerPairFilter(inObjectLayerPairFilter),
        mLayer(inLayer)
    {
    }
 
                            DefaultObjectLayerFilter(const DefaultObjectLayerFilter &inRHS) :
        mObjectLayerPairFilter(inRHS.mObjectLayerPairFilter),
        mLayer(inRHS.mLayer)
    {
    }
 
    // See ObjectLayerFilter::ShouldCollide
    virtual bool            ShouldCollide(ObjectLayer inLayer) const override
    {
        return mObjectLayerPairFilter.ShouldCollide(mLayer, inLayer);
    }
 
private:
    const ObjectLayerPairFilter & mObjectLayerPairFilter;
    ObjectLayer             mLayer;
};
 
class JPH_EXPORT SpecifiedObjectLayerFilter : public ObjectLayerFilter
{
public:
    explicit                SpecifiedObjectLayerFilter(ObjectLayer inLayer) :
        mLayer(inLayer)
    {
    }
 
    // See ObjectLayerFilter::ShouldCollide
    virtual bool            ShouldCollide(ObjectLayer inLayer) const override
    {
        return mLayer == inLayer;
    }
 
private:
    ObjectLayer             mLayer;
};
 
JPH_NAMESPACE_END