CollisionGroup.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/GroupFilter.h>
#include <Jolt/ObjectStream/SerializableObject.h>
 
JPH_NAMESPACE_BEGIN
 
class StreamIn;
class StreamOut;
 
class JPH_EXPORT CollisionGroup
{
    JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, CollisionGroup)
 
public:
    using GroupID           = uint32;
    using SubGroupID        = uint32;
 
    static const GroupID    cInvalidGroup = ~GroupID(0);
    static const SubGroupID cInvalidSubGroup = ~SubGroupID(0);
 
                            CollisionGroup() = default;
 
                            CollisionGroup(const GroupFilter *inFilter, GroupID inGroupID, SubGroupID inSubGroupID) : mGroupFilter(inFilter), mGroupID(inGroupID), mSubGroupID(inSubGroupID) { }
 
 
    bool                    operator == (const CollisionGroup &inRHS) const
    {
        return mGroupFilter == inRHS.mGroupFilter && mGroupID == inRHS.mGroupID && mSubGroupID == inRHS.mSubGroupID;
    }
 
    bool                    operator != (const CollisionGroup &inRHS) const
    {
        return !(*this == inRHS);
    }
 
    inline void             SetGroupFilter(const GroupFilter *inFilter)
    {
        mGroupFilter = inFilter;
    }
 
    inline const GroupFilter *GetGroupFilter() const
    {
        return mGroupFilter;
    }
 
    inline void             SetGroupID(GroupID inID)
    {
        mGroupID = inID;
    }
 
    inline GroupID          GetGroupID() const
    {
        return mGroupID;
    }
 
    inline void             SetSubGroupID(SubGroupID inID)
    {
        mSubGroupID = inID;
    }
 
    inline SubGroupID       GetSubGroupID() const
    {
        return mSubGroupID;
    }
 
    bool                    CanCollide(const CollisionGroup &inOther) const
    {
        // Call the CanCollide function of the first group filter that's not null
        if (mGroupFilter != nullptr)
            return mGroupFilter->CanCollide(*this, inOther);
        else if (inOther.mGroupFilter != nullptr)
            return inOther.mGroupFilter->CanCollide(inOther, *this);
        else
            return true;
    }
 
    void                    SaveBinaryState(StreamOut &inStream) const;
 
    void                    RestoreBinaryState(StreamIn &inStream);
 
    static const CollisionGroup sInvalid;
 
private:
    RefConst<GroupFilter>   mGroupFilter;
    GroupID                 mGroupID = cInvalidGroup;
    SubGroupID              mSubGroupID = cInvalidSubGroup;
};
 
JPH_NAMESPACE_END