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

Class WheelSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.SerializableObject
com.github.stephengold.joltjni.WheelSettings
All Implemented Interfaces:
ConstJoltPhysicsObject, ConstSerializableObject, ConstWheelSettings, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>
Direct Known Subclasses:
WheelSettingsTv, WheelSettingsWv
public abstract class WheelSettings extends SerializableObject implements ConstWheelSettings
Settings used to construct a Wheel.

  • Method Details

    • restoreBinaryState

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

    • setEnableSuspensionForcePoint

      public WheelSettings setEnableSuspensionForcePoint(boolean enable)
      Alter where to apply tire forces. (native attribute: mEnableSuspensionForcePoint)
      Parameters:
      enable - true to apply at the configured suspension-force point, false to apply at the wheel's point of contact (default=false)
      Returns:
      the modified settings, for chaining

    • setPosition

      public WheelSettings setPosition(Vec3Arg position)
      Relocate the attachment point. (native attribute: mPosition)
      Parameters:
      position - the location of the attachment point (in the body's local coordinates, not null, unaffected, default=(0,0,0))
      Returns:
      the modified settings, for chaining

    • setRadius

      public WheelSettings setRadius(float radius)
      Alter the radius of the wheel. (native attribute: mRadius)
      Parameters:
      radius - the desired radius (in meters, default=0.3)
      Returns:
      the modified settings, for chaining

    • setSteeringAxis

      public WheelSettings setSteeringAxis(Vec3Arg direction)
      Alter the steering axis (upward direction). (native attribute: mSteeringAxis)
      Parameters:
      direction - the desired direction (not null, unaffected, default=(0,1,0))
      Returns:
      the modified settings, for chaining

    • setSuspensionDirection

      public WheelSettings setSuspensionDirection(Vec3Arg direction)
      Alter the downward direction of the suspension. (native attribute: mSuspensionDirection)
      Parameters:
      direction - the desired direction (not null, unaffected, default=(0,-1,0))
      Returns:
      the modified settings, for chaining

    • setSuspensionForcePoint

      public WheelSettings setSuspensionForcePoint(Vec3Arg location)
      Alter the location where tire forces will be applied if the force-point option is enabled. (native attribute: mSuspensionForcePoint)
      Parameters:
      location - the desired location (in the body coordinates, not null, unaffected, default=(0,0,0))
      Returns:
      the modified settings, for chaining

    • setSuspensionMaxLength

      public WheelSettings setSuspensionMaxLength(float length)
      Alter the maximum displacement from the attachment point. (native attribute: mSuspensionMaxLength)
      Parameters:
      length - the desired limit (in meters, default=0.5)
      Returns:
      the modified settings, for chaining

    • setSuspensionMinLength

      public WheelSettings setSuspensionMinLength(float length)
      Alter the minimum displacement from the attachment point. (native attribute: mSuspensionMinLength)
      Parameters:
      length - the desired limit (in meters, default=0.3)
      Returns:
      the modified settings, for chaining

    • setSuspensionPreloadLength

      public WheelSettings setSuspensionPreloadLength(float length)
      Alter the suspension preload length. (native attribute: mSuspensionPreloadLength)
      Parameters:
      length - the desired offset (in meters, default=0)
      Returns:
      the modified settings, for chaining

    • setWheelForward

      public WheelSettings setWheelForward(Vec3Arg direction)
      Alter the forward direction when steering is neutral. (native attribute: mWheelForward)
      Parameters:
      direction - the desired direction (not null, unaffected, default=(0,0,1))
      Returns:
      the modified settings, for chaining

    • setWheelUp

      public WheelSettings setWheelUp(Vec3Arg direction)
      Alter the "up" direction when steering is neutral. (native attribute: mWheelUp)
      Parameters:
      direction - the desired direction (not null, unaffected, default=(0,1,0))
      Returns:
      the modified settings, for chaining

    • setWidth

      public WheelSettings setWidth(float width)
      Alter the width of the wheel. (native attribute: mWidth)
      Parameters:
      width - the desired width (in meters, default=0.1)
      Returns:
      the modified settings, for chaining

    • getEnableSuspensionForcePoint

      public boolean getEnableSuspensionForcePoint()
      Determine where to apply tire forces. The settings are unaffected. (native attribute: mEnableSuspensionForcePoint)
      Specified by:
      getEnableSuspensionForcePoint in interface ConstWheelSettings
      Returns:
      true if applied at the configured suspension-force point, false if applied at the wheel's point of contact

    • getPosition

      public Vec3 getPosition()
      Copy the location of the attachment point. The settings are unaffected. (native attribute: mPosition)
      Specified by:
      getPosition in interface ConstWheelSettings
      Returns:
      a new location vector (in the body's local coordinates)

    • getRadius

      public float getRadius()
      Return the radius of the wheel. The settings are unaffected. (native attribute: mRadius)
      Specified by:
      getRadius in interface ConstWheelSettings
      Returns:
      the radius (in meters)

    • getSteeringAxis

      public Vec3 getSteeringAxis()
      Copy the steering axis (upward direction). The settings are unaffected. (native attribute: mSteeringAxis)
      Specified by:
      getSteeringAxis in interface ConstWheelSettings
      Returns:
      a new direction vector

    • getSuspensionDirection

      public Vec3 getSuspensionDirection()
      Copy the downward direction of the suspension. The settings are unaffected. (native attribute: mSuspensionDirection)
      Specified by:
      getSuspensionDirection in interface ConstWheelSettings
      Returns:
      a new direction vector

    • getSuspensionForcePoint

      public Vec3 getSuspensionForcePoint()
      Copy the location where tire forces will be applied if the force-point option is enabled. The settings are unaffected. (native attribute: mSuspensionForcePoint)
      Specified by:
      getSuspensionForcePoint in interface ConstWheelSettings
      Returns:
      a new location vector (in body coordinates)

    • getSuspensionMaxLength

      public float getSuspensionMaxLength()
      Return the maximum displacement from the attachment point. The settings are unaffected. (native attribute: mSuspensionMaxLength)
      Specified by:
      getSuspensionMaxLength in interface ConstWheelSettings
      Returns:
      the distance (in meters)

    • getSuspensionMinLength

      public float getSuspensionMinLength()
      Return the minimum displacement from the attachment point. The settings are unaffected. (native attribute: mSuspensionMinLength)
      Specified by:
      getSuspensionMinLength in interface ConstWheelSettings
      Returns:
      the distance (in meters)

    • getSuspensionPreloadLength

      public float getSuspensionPreloadLength()
      Return the suspension preload length. The settings are unaffected. (native attribute: mSuspensionPreloadLength)
      Specified by:
      getSuspensionPreloadLength in interface ConstWheelSettings
      Returns:
      the offset (in meters)

    • getSuspensionSpring

      public SpringSettings getSuspensionSpring()
      Access the settings for the suspension spring. (native attribute: mSuspensionSpring)
      Specified by:
      getSuspensionSpring in interface ConstWheelSettings
      Returns:
      a new JVM object with the pre-existing native object assigned

    • getWheelForward

      public Vec3 getWheelForward()
      Copy the forward direction when steering is neutral. The settings are unaffected. (native attribute: mWheelForward)
      Specified by:
      getWheelForward in interface ConstWheelSettings
      Returns:
      a new direction vector

    • getWheelUp

      public Vec3 getWheelUp()
      Copy the "up" direction when steering is neutral. The settings are unaffected. (native attribute: mWheelUp)
      Specified by:
      getWheelUp in interface ConstWheelSettings
      Returns:
      a new direction vector

    • getWidth

      public float getWidth()
      Return the width of the wheel. The settings are unaffected. (native attribute: mWidth)
      Specified by:
      getWidth in interface ConstWheelSettings
      Returns:
      the width (in meters)

    • saveBinaryState

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

    • getRefCount

      public abstract int getRefCount()
      Count the active references to the native WheelSettings. The settings are unaffected.
      Specified by:
      getRefCount in interface RefTarget
      Returns:
      the count (≥0)

    • setEmbedded

      public abstract void setEmbedded()
      Mark the native WheelSettings as embedded.
      Specified by:
      setEmbedded in interface RefTarget

    • toRef

      public abstract Ref toRef()
      Create a counted reference to the native WheelSettings.
      Specified by:
      toRef in interface RefTarget
      Returns:
      a new JVM object with a new native object assigned