BodyID.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/HashCombine.h>
 
JPH_NAMESPACE_BEGIN
 
class BodyID
{
public:
    JPH_OVERRIDE_NEW_DELETE
 
    static constexpr uint32 cInvalidBodyID = 0xffffffff;    
    static constexpr uint32 cBroadPhaseBit = 0x00800000;    
    static constexpr uint32 cMaxBodyIndex = 0x7fffff;       
    static constexpr uint8  cMaxSequenceNumber = 0xff;      
 
                            BodyID() :
        mID(cInvalidBodyID)
    {
    }
 
    explicit                BodyID(uint32 inID) :
        mID(inID)
    {
        JPH_ASSERT((inID & cBroadPhaseBit) == 0 || inID == cInvalidBodyID); // Check bit used by broadphase
    }
 
    explicit                BodyID(uint32 inID, uint8 inSequenceNumber) :
        mID((uint32(inSequenceNumber) << 24) | inID)
    {
        JPH_ASSERT(inID < cMaxBodyIndex); // Should not use bit pattern for invalid ID and should not use the broadphase bit
    }
 
    inline uint32           GetIndex() const
    {
        return mID & cMaxBodyIndex;
    }
 
    inline uint8            GetSequenceNumber() const
    {
        return uint8(mID >> 24);
    }
 
    inline uint32           GetIndexAndSequenceNumber() const
    {
        return mID;
    }
 
    inline bool             IsInvalid() const
    {
        return mID == cInvalidBodyID;
    }
 
    inline bool             operator == (const BodyID &inRHS) const
    {
        return mID == inRHS.mID;
    }
 
    inline bool             operator != (const BodyID &inRHS) const
    {
        return mID != inRHS.mID;
    }
 
    inline bool             operator < (const BodyID &inRHS) const
    {
        return mID < inRHS.mID;
    }
 
    inline bool             operator > (const BodyID &inRHS) const
    {
        return mID > inRHS.mID;
    }
 
private:
    uint32                  mID;
};
 
JPH_NAMESPACE_END
 
// Create a std::hash for BodyID
JPH_MAKE_HASHABLE(JPH::BodyID, t.GetIndexAndSequenceNumber())