Module com.github.stephengold.joltjni
Package com.github.stephengold.joltjni

Class VehicleTransmissionSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.VehicleTransmissionSettings
All Implemented Interfaces:
ConstJoltPhysicsObject, ConstVehicleTransmissionSettings, AutoCloseable, Comparable<JoltPhysicsObject>
Direct Known Subclasses:
VehicleTransmission
public class VehicleTransmissionSettings extends JoltPhysicsObject implements ConstVehicleTransmissionSettings
Settings used to configure the transmission (gearbox) of a WheeledVehicleController.

  • Constructor Details

    • VehicleTransmissionSettings

      public VehicleTransmissionSettings()
      Instantiate default settings.

    • VehicleTransmissionSettings

      public VehicleTransmissionSettings(ConstVehicleTransmissionSettings original)
      Instantiate a copy of the specified settings.
      Parameters:
      original - the settings to copy (not null, unaffected)

  • Method Details

    • restoreBinaryState

      public void restoreBinaryState(StreamIn stream)
      Load the settings from the specified binary stream.
      Parameters:
      stream - the stream to read from (not null)

    • setClutchReleaseTime

      public void setClutchReleaseTime(float latency)
      Alter how long it takes to release the clutch in Auto mode. (native attribute: mClutchReleaseTime)
      Parameters:
      latency - the desired latency (in seconds, default=0.3)

    • setClutchStrength

      public void setClutchStrength(float strength)
      Alter the total torque applied by the clutch when fully engaged. (native attribute: mClutchStrength)
      Parameters:
      strength - the desired strength (default=10)

    • setGearRatios

      public void setGearRatios(float... ratios)
      Alter the number of engine rotations per gearbox rotation for each forward gear. The first element is for 1st gear. (native attribute: mGearRatios)
      Parameters:
      ratios - the desired ratios (not null)

    • setMode

      public void setMode(ETransmissionMode mode)
      Alter the type of transmission. (native attribute: mMode)
      Parameters:
      mode - the desired mode (not null, default=Auto)

    • setReverseGearRatios

      public void setReverseGearRatios(float... ratios)
      Alter the number of engine rotations per gearbox rotation for each reverse gear. (native attribute: mReverseGearRatios)
      Parameters:
      ratios - the desired ratios (not null)

    • setShiftDownRpm

      public void setShiftDownRpm(float rpm)
      Alter the maximum engine RPMs for downshifting in Auto mode. (native attribute: mShiftDownRPM)
      Parameters:
      rpm - (default=2000)

    • setShiftUpRpm

      public void setShiftUpRpm(float rpm)
      Alter the minimum engine RPMs for upshifting in Auto mode. (native attribute: mShiftUpRPM)
      Parameters:
      rpm - (default=4000)

    • setSwitchLatency

      public void setSwitchLatency(float latency)
      Alter the minimum time between shifts in Auto mode. (native attribute: mSwitchLatency)
      Parameters:
      latency - the desired latency (in seconds)

    • setSwitchTime

      public void setSwitchTime(float latency)
      Alter how long it takes to shift gears in Auto mode. (native attribute: mSwitchTime)
      Parameters:
      latency - the desired latency (in seconds)

    • getClutchReleaseTime

      public float getClutchReleaseTime()
      Return how long it takes to release the clutch in Auto mode. The settings are unaffected. (native attribute: mClutchReleaseTime)
      Specified by:
      getClutchReleaseTime in interface ConstVehicleTransmissionSettings
      Returns:
      the latency (in seconds)

    • getClutchStrength

      public float getClutchStrength()
      Return the total torque applied by the clutch when fully engaged. The settings are unaffected. (native attribute: mClutchStrength)
      Specified by:
      getClutchStrength in interface ConstVehicleTransmissionSettings
      Returns:
      the strength

    • getGearRatios

      public float[] getGearRatios()
      Return the number of engine rotations per gearbox rotation for each forward gear. The first element is for 1st gear. The settings are unaffected. (native attribute: mGearRatios)
      Specified by:
      getGearRatios in interface ConstVehicleTransmissionSettings
      Returns:
      a new array

    • getMode

      public ETransmissionMode getMode()
      Return the type of transmission. The settings are unaffected. (native attribute: mMode)
      Specified by:
      getMode in interface ConstVehicleTransmissionSettings
      Returns:
      an enum value (not null)

    • getReverseGearRatios

      public float[] getReverseGearRatios()
      Return the number of engine rotations per gearbox rotation for each reverse gear. The settings are unaffected. (native attribute: mReverseGearRatios)
      Specified by:
      getReverseGearRatios in interface ConstVehicleTransmissionSettings
      Returns:
      a new array

    • getShiftDownRpm

      public float getShiftDownRpm()
      Return the maximum engine RPMs for downshifting in Auto mode. The settings are unaffected. (native attribute: mShiftDownRPM)
      Specified by:
      getShiftDownRpm in interface ConstVehicleTransmissionSettings
      Returns:
      the threshold rate (in revolutions per minute)

    • getShiftUpRpm

      public float getShiftUpRpm()
      Return the minimum engine RPMs for upshifting in Auto mode. The settings are unaffected. (native attribute: mShiftUpRPM)
      Specified by:
      getShiftUpRpm in interface ConstVehicleTransmissionSettings
      Returns:
      the threshold rate (in revolutions per minute)

    • getSwitchLatency

      public float getSwitchLatency()
      Return the minimum time between shifts in Auto mode. The settings are unaffected. (native attribute: mSwitchLatency)
      Specified by:
      getSwitchLatency in interface ConstVehicleTransmissionSettings
      Returns:
      the latency (in seconds)

    • getSwitchTime

      public float getSwitchTime()
      Return how long it takes to shift gears in Auto mode. The settings are unaffected. (native attribute: mSwitchTime)
      Specified by:
      getSwitchTime in interface ConstVehicleTransmissionSettings
      Returns:
      the latency (in seconds)

    • saveBinaryState

      public void saveBinaryState(StreamOut stream)
      Save the settings to the specified binary stream. The settings are unaffected.
      Specified by:
      saveBinaryState in interface ConstVehicleTransmissionSettings
      Parameters:
      stream - the stream to write to (not null)