CharacterID.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2025 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Jolt/Core/HashCombine.h>
 
JPH_NAMESPACE_BEGIN
 
class JPH_EXPORT CharacterID
{
public:
    JPH_OVERRIDE_NEW_DELETE
 
    static constexpr uint32 cInvalidCharacterID = 0xffffffff;   
 
                            CharacterID() :
        mID(cInvalidCharacterID)
    {
    }
 
    explicit                CharacterID(uint32 inID) :
        mID(inID)
    {
    }
 
    inline uint32           GetValue() const
    {
        return mID;
    }
 
    inline bool             IsInvalid() const
    {
        return mID == cInvalidCharacterID;
    }
 
    inline bool             operator == (const CharacterID &inRHS) const
    {
        return mID == inRHS.mID;
    }
 
    inline bool             operator != (const CharacterID &inRHS) const
    {
        return mID != inRHS.mID;
    }
 
    inline bool             operator < (const CharacterID &inRHS) const
    {
        return mID < inRHS.mID;
    }
 
    inline bool             operator > (const CharacterID &inRHS) const
    {
        return mID > inRHS.mID;
    }
 
    inline uint64           GetHash() const
    {
        return Hash<uint32>{} (mID);
    }
 
    static CharacterID      sNextCharacterID()
    {
        for (;;)
        {
            uint32 next = sNextID.fetch_add(1, std::memory_order_relaxed);
            if (next != cInvalidCharacterID)
                return CharacterID(next);
        }
    }
 
    static void             sSetNextCharacterID(uint32 inNextValue = 1)
    {
        sNextID.store(inNextValue, std::memory_order_relaxed);
    }
 
private:
    inline static atomic<uint32> sNextID = 1;
 
    uint32                  mID;
};
 
JPH_NAMESPACE_END