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

Class VehicleTrackSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.VehicleTrackSettings
All Implemented Interfaces:
ConstJoltPhysicsObject, ConstVehicleTrackSettings, AutoCloseable, Comparable<JoltPhysicsObject>
public class VehicleTrackSettings extends JoltPhysicsObject implements ConstVehicleTrackSettings
Settings to configure one track in a TrackedVehicleController.

  • Constructor Details

    • VehicleTrackSettings

      public VehicleTrackSettings()
      Instantiate default settings.

    • VehicleTrackSettings

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

  • Method Details

    • addWheel

      public void addWheel(int wheelIndex)
      Add the specified wheel to the track.
      Parameters:
      wheelIndex - the index (among the vehicle's wheels) of the wheel to add (≥0)

    • set

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

    • setAngularDamping

      public void setAngularDamping(float factor)
      Alter the angular damping factor. (native attribute: mAngularDamping)
      Parameters:
      factor - the desired damping factor (per second, default=0.5)

    • setDifferentialRatio

      public void setDifferentialRatio(float ratio)
      Alter the number of gearbox rotations per driven-wheel rotation. (native attribute: mDifferentialRatio)
      Parameters:
      ratio - the desired ratio (default=6)

    • setDrivenWheel

      public void setDrivenWheel(int wheelIndex)
      Alter which wheel is powered by the engine. (native attribute: mDrivenWheel)
      Parameters:
      wheelIndex - the index of the desired wheel (≥0, default=0)

    • setInertia

      public void setInertia(float inertia)
      Alter the moment of inertia of the track and its wheels as seen on the driven wheel. (native attribute: mInertia)
      Parameters:
      inertia - the moment (in kilogram.meter^2, default=10)

    • getAngularDamping

      public float getAngularDamping()
      Return the angular damping factor. The settings are unaffected. (native attribute: mAngularDamping)
      Specified by:
      getAngularDamping in interface ConstVehicleTrackSettings
      Returns:
      the damping factor (per second)

    • getDifferentialRatio

      public float getDifferentialRatio()
      Return the number of gearbox rotations per driven-wheel rotation. The settings are unaffected. (native attribute: mDifferentialRatio)
      Specified by:
      getDifferentialRatio in interface ConstVehicleTrackSettings
      Returns:
      the ratio

    • getDrivenWheel

      public int getDrivenWheel()
      Return the index of the wheel powered by the engine. The settings are unaffected. (native attribute: mDrivenWheel)
      Specified by:
      getDrivenWheel in interface ConstVehicleTrackSettings
      Returns:
      the index of the driven wheel (≥0)

    • getInertia

      public float getInertia()
      Return the moment of inertia of the track and its wheels as seen on the driven wheel. The settings are unaffected. (native attribute: mInertia)
      Specified by:
      getInertia in interface ConstVehicleTrackSettings
      Returns:
      the moment (in kilogram.meter^2)

    • getNumWheels

      public int getNumWheels()
      Count the track's wheels. The settings are unaffected. (native attribute: mWheels)
      Specified by:
      getNumWheels in interface ConstVehicleTrackSettings
      Returns:
      the count (≥0)