VehicleTransmission.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/ObjectStream/SerializableObject.h>
#include <Jolt/Core/StreamIn.h>
#include <Jolt/Core/StreamOut.h>
#include <Jolt/Physics/StateRecorder.h>
 
JPH_NAMESPACE_BEGIN

enum class ETransmissionMode : uint8
{
    Auto,                                                               
    Manual,                                                             
};

class JPH_EXPORT VehicleTransmissionSettings
{
    JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, VehicleTransmissionSettings)
 
public:
    void                    SaveBinaryState(StreamOut &inStream) const;

    void                    RestoreBinaryState(StreamIn &inStream);
 
    ETransmissionMode       mMode = ETransmissionMode::Auto;            
    Array<float>            mGearRatios { 2.66f, 1.78f, 1.3f, 1.0f, 0.74f }; 
    Array<float>            mReverseGearRatios { -2.90f };              
    float                   mSwitchTime = 0.5f;                         
    float                   mClutchReleaseTime = 0.3f;                  
    float                   mSwitchLatency = 0.5f;                      
    float                   mShiftUpRPM = 4000.0f;                      
    float                   mShiftDownRPM = 2000.0f;                    
    float                   mClutchStrength = 10.0f;                    
};

class JPH_EXPORT VehicleTransmission : public VehicleTransmissionSettings
{
public:
    void                    Set(int inCurrentGear, float inClutchFriction) { mCurrentGear = inCurrentGear; mClutchFriction = inClutchFriction; }

    void                    Update(float inDeltaTime, float inCurrentRPM, float inForwardInput, bool inCanShiftUp);

    int                     GetCurrentGear() const                      { return mCurrentGear; }

    float                   GetClutchFriction() const                   { return mClutchFriction; }

    bool                    IsSwitchingGear() const                     { return mGearSwitchTimeLeft > 0.0f; }

    float                   GetCurrentRatio() const;

    bool                    AllowSleep() const                          { return mGearSwitchTimeLeft <= 0.0f && mClutchReleaseTimeLeft <= 0.0f && mGearSwitchLatencyTimeLeft <= 0.0f; }

    void                    SaveState(StateRecorder &inStream) const;
    void                    RestoreState(StateRecorder &inStream);
 
private:
    int                     mCurrentGear = 0;                           
    float                   mClutchFriction = 1.0f;                     
    float                   mGearSwitchTimeLeft = 0.0f;                 
    float                   mClutchReleaseTimeLeft = 0.0f;              
    float                   mGearSwitchLatencyTimeLeft = 0.0f;          
};
 
JPH_NAMESPACE_END