SpringSettings.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2023 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Jolt/ObjectStream/SerializableObject.h>
 
JPH_NAMESPACE_BEGIN
 
class StreamIn;
class StreamOut;
 
enum class ESpringMode : uint8
{
    FrequencyAndDamping,                    
    StiffnessAndDamping,                    
    MassNormalizedStiffnessAndDamping,      
};
 
class JPH_EXPORT SpringSettings
{
    JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, SpringSettings)
 
public:
                                SpringSettings() = default;
                                SpringSettings(const SpringSettings &) = default;
    SpringSettings &            operator = (const SpringSettings &) = default;
                                SpringSettings(ESpringMode inMode, float inFrequencyOrStiffness, float inDamping) : mMode(inMode), mFrequency(inFrequencyOrStiffness), mDamping(inDamping) { }
 
    void                        SaveBinaryState(StreamOut &inStream) const;
 
    void                        RestoreBinaryState(StreamIn &inStream);
 
    inline bool                 HasStiffness() const                            { return mFrequency > 0.0f; }
 
    inline bool                 HasStiffnessOrDamping() const                   { return mFrequency > 0.0f || (mMode != ESpringMode::FrequencyAndDamping && mDamping > 0.0f); }
 
    ESpringMode                 mMode = ESpringMode::FrequencyAndDamping;
 
    union
    {
        float                   mFrequency = 0.0f;
 
        float                   mStiffness;
    };
 
    float                       mDamping = 0.0f;
};
 
JPH_NAMESPACE_END