StateRecorder.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/StreamIn.h>
#include <Jolt/Core/StreamOut.h>
 
JPH_NAMESPACE_BEGIN
 
class Body;
class Constraint;
class BodyID;
 
JPH_SUPPRESS_WARNING_PUSH
JPH_GCC_SUPPRESS_WARNING("-Wshadow") // GCC complains about the 'Constraints' value conflicting with the 'Constraints' typedef
 
 
enum class EStateRecorderState : uint8
{
    None                = 0,                                                        
    Global              = 1,                                                        
    Bodies              = 2,                                                        
    Contacts            = 4,                                                        
    Constraints         = 8,                                                        
    All                 = Global | Bodies | Contacts | Constraints                  
};
 
JPH_SUPPRESS_WARNING_POP
 
constexpr EStateRecorderState operator | (EStateRecorderState inLHS, EStateRecorderState inRHS)
{
    return EStateRecorderState(uint8(inLHS) | uint8(inRHS));
}
 
constexpr EStateRecorderState operator & (EStateRecorderState inLHS, EStateRecorderState inRHS)
{
    return EStateRecorderState(uint8(inLHS) & uint8(inRHS));
}
 
constexpr EStateRecorderState operator ^ (EStateRecorderState inLHS, EStateRecorderState inRHS)
{
    return EStateRecorderState(uint8(inLHS) ^ uint8(inRHS));
}
 
constexpr EStateRecorderState operator ~ (EStateRecorderState inAllowedDOFs)
{
    return EStateRecorderState(~uint8(inAllowedDOFs));
}
 
constexpr EStateRecorderState & operator |= (EStateRecorderState &ioLHS, EStateRecorderState inRHS)
{
    ioLHS = ioLHS | inRHS;
    return ioLHS;
}
 
constexpr EStateRecorderState & operator &= (EStateRecorderState &ioLHS, EStateRecorderState inRHS)
{
    ioLHS = ioLHS & inRHS;
    return ioLHS;
}
 
constexpr EStateRecorderState & operator ^= (EStateRecorderState &ioLHS, EStateRecorderState inRHS)
{
    ioLHS = ioLHS ^ inRHS;
    return ioLHS;
}
 
class JPH_EXPORT StateRecorderFilter
{
public:
    virtual             ~StateRecorderFilter() = default;
 
 
    virtual bool        ShouldSaveBody([[maybe_unused]] const Body &inBody) const                   { return true; }
 
    virtual bool        ShouldSaveConstraint([[maybe_unused]] const Constraint &inConstraint) const { return true; }
 
    virtual bool        ShouldSaveContact([[maybe_unused]] const BodyID &inBody1, [[maybe_unused]] const BodyID &inBody2) const { return true; }
 
 
    virtual bool        ShouldRestoreContact([[maybe_unused]] const BodyID &inBody1, [[maybe_unused]] const BodyID &inBody2) const { return true; }
 
};
 
class JPH_EXPORT StateRecorder : public StreamIn, public StreamOut
{
public:
                        StateRecorder() = default;
                        StateRecorder(const StateRecorder &inRHS)                   : mIsValidating(inRHS.mIsValidating) { }
 
    void                SetValidating(bool inValidating)                            { mIsValidating = inValidating; }
    bool                IsValidating() const                                        { return mIsValidating; }
 
    void                SetIsLastPart(bool inIsLastPart)                            { mIsLastPart = inIsLastPart; }
    bool                IsLastPart() const                                          { return mIsLastPart; }
 
private:
    bool                mIsValidating = false;
    bool                mIsLastPart = true;
};
 
JPH_NAMESPACE_END