BodyLock.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/Body/BodyLockInterface.h>
 
JPH_NAMESPACE_BEGIN
 
template <bool Write, class BodyType>
class BodyLockBase : public NonCopyable
{
public:
                                BodyLockBase(const BodyLockInterface &inBodyLockInterface, const BodyID &inBodyID) :
        mBodyLockInterface(inBodyLockInterface)
    {
        if (inBodyID == BodyID())
        {
            // Invalid body id
            mBodyLockMutex = nullptr;
            mBody = nullptr;
        }
        else
        {
            // Get mutex
            mBodyLockMutex = Write? inBodyLockInterface.LockWrite(inBodyID) : inBodyLockInterface.LockRead(inBodyID);
 
            // Get a reference to the body or nullptr when it is no longer valid
            mBody = inBodyLockInterface.TryGetBody(inBodyID);
        }
    }
 
    inline void                 ReleaseLock()
    {
        if (mBodyLockMutex != nullptr)
        {
            if (Write)
                mBodyLockInterface.UnlockWrite(mBodyLockMutex);
            else
                mBodyLockInterface.UnlockRead(mBodyLockMutex);
 
            mBodyLockMutex = nullptr;
            mBody = nullptr;
        }
    }
 
                                ~BodyLockBase()
    {
        ReleaseLock();
    }
 
    inline bool                 Succeeded() const
    {
        return mBody != nullptr;
    }
 
    inline bool                 SucceededAndIsInBroadPhase() const
    {
        return mBody != nullptr && mBody->IsInBroadPhase();
    }
 
    inline BodyType &           GetBody() const
    {
        JPH_ASSERT(mBody != nullptr, "Should check Succeeded() first");
        return *mBody;
    }
 
private:
    const BodyLockInterface &   mBodyLockInterface;
    SharedMutex *               mBodyLockMutex;
    BodyType *                  mBody;
};
 
class BodyLockRead : public BodyLockBase<false, const Body>
{
    using BodyLockBase::BodyLockBase;
};
 
class BodyLockWrite : public BodyLockBase<true, Body>
{
    using BodyLockBase::BodyLockBase;
};
 
JPH_NAMESPACE_END