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

Class WheeledVehicleControllerSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.SerializableObject
com.github.stephengold.joltjni.VehicleControllerSettings
com.github.stephengold.joltjni.WheeledVehicleControllerSettings
All Implemented Interfaces:
ConstJoltPhysicsObject, ConstSerializableObject, ConstVehicleControllerSettings, ConstWheeledVehicleControllerSettings, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>
Direct Known Subclasses:
MotorcycleControllerSettings
public class WheeledVehicleControllerSettings extends VehicleControllerSettings implements ConstWheeledVehicleControllerSettings
Settings used to construct a WheeledVehicleController.

  • Constructor Details

    • WheeledVehicleControllerSettings

      public WheeledVehicleControllerSettings()
      Instantiate default settings.

    • WheeledVehicleControllerSettings

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

  • Method Details

    • set

      public void set(ConstWheeledVehicleControllerSettings source)
      Copy the argument to the current settings.
      Parameters:
      source - the settings to copy (not null, unaffected)

    • setDifferentialLimitedSlipRatio

      public void setDifferentialLimitedSlipRatio(float ratio)
      Alter the ratio of the max/min average wheel speed for each differential. (native field: mDifferentialLimitedSlipRatio)
      Parameters:
      ratio - the desired ratio (>1, default=1.4)

    • setNumDifferentials

      public void setNumDifferentials(int count)
      Alter the number of differentials. (native attribute: mDifferentials)
      Parameters:
      count - the desired number (≥0, default=0)

    • getDifferential

      public VehicleDifferentialSettings getDifferential(int index)
      Access the settings for the specified differential. (native field: mDifferentials)
      Specified by:
      getDifferential in interface ConstWheeledVehicleControllerSettings
      Parameters:
      index - the index of the differential to access (≥0)
      Returns:
      a new JVM object with the pre-existing native object assigned

    • getDifferentialLimitedSlipRatio

      public float getDifferentialLimitedSlipRatio()
      Return the ratio of the max/min average wheel speed for each differential. The settings are unaffected. (native field: mDifferentialLimitedSlipRatio)
      Specified by:
      getDifferentialLimitedSlipRatio in interface ConstWheeledVehicleControllerSettings
      Returns:
      the ratio

    • getEngine

      public VehicleEngineSettings getEngine()
      Access the engine settings. (native field: mEngine)
      Specified by:
      getEngine in interface ConstWheeledVehicleControllerSettings
      Returns:
      a new JVM object with the pre-existing native object assigned

    • getNumDifferentials

      public int getNumDifferentials()
      Count how many differentials the vehicle will have. The settings are unaffected. (native attribute: mDifferentials)
      Specified by:
      getNumDifferentials in interface ConstWheeledVehicleControllerSettings
      Returns:
      the count (≥0)

    • getTransmission

      public VehicleTransmissionSettings getTransmission()
      Access the transmission (gearbox) settings. (native attribute: mTransmission)
      Specified by:
      getTransmission in interface ConstWheeledVehicleControllerSettings
      Returns:
      a new JVM object with the pre-existing native object assigned