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

Class ExtendedUpdateSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.ExtendedUpdateSettings
All Implemented Interfaces:
ConstExtendedUpdateSettings, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>
public class ExtendedUpdateSettings extends JoltPhysicsObject implements ConstExtendedUpdateSettings
Settings for extended update of a virtual character. (native type: CharacterVirtual::ExtendedUpdateSettings)

  • Constructor Details

    • ExtendedUpdateSettings

      public ExtendedUpdateSettings()
      Instantiate default settings.

    • ExtendedUpdateSettings

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

  • Method Details

    • setStickToFloorStepDown

      public ExtendedUpdateSettings setStickToFloorStepDown(Vec3Arg offset)
      Alter the StickToFloor inStepDown parameter. (native attribute: mStickToFloorStepDown)
      Parameters:
      offset - the desired offset (not null, unaffected, zero=off, default=(0, -0.5, 0))
      Returns:
      the modified settings, for chaining

    • setWalkStairsCosAngleForwardContact

      public ExtendedUpdateSettings setWalkStairsCosAngleForwardContact(float cosine)
      Alter the cosine of the maximum angle between the ground normal and the horizontal for adjusting the step-forward test. (native attribute: mWalkStairsCosAngleForwardContact)
      Parameters:
      cosine - the cosine of the maximum angle (default=cos(75 degrees))
      Returns:
      the modified settings, for chaining

    • setWalkStairsMinStepForward

      public ExtendedUpdateSettings setWalkStairsMinStepForward(float distance)
      Alter the StickToFloor inStepForward parameter. (native attribute: mWalkStairsMinStepForward)
      Parameters:
      distance - the desired distance (default=0.02f)
      Returns:
      the modified settings, for chaining

    • setWalkStairsStepForwardTest

      public ExtendedUpdateSettings setWalkStairsStepForwardTest(float distance)
      Alter the StickToFloor inStepForwardTest parameter. (native attribute: mWalkStairsStepForwardTest)
      Parameters:
      distance - the desired distance (default=0.15f)
      Returns:
      the modified settings, for chaining

    • setWalkStairsStepUp

      public ExtendedUpdateSettings setWalkStairsStepUp(Vec3Arg offset)
      Alter the StickToFloor inStepUp parameter. (native attribute: mWalkStairsStepUp)
      Parameters:
      offset - the desired offset (not null, unaffected, zero=off, default=(0, 0.4, 0))
      Returns:
      the modified settings, for chaining

    • getStickToFloorStepDown

      public Vec3 getStickToFloorStepDown()
      Copy the StickToFloor inStepDown parameter. The settings are unaffected. (native attribute: mStickToFloorStepDown)
      Specified by:
      getStickToFloorStepDown in interface ConstExtendedUpdateSettings
      Returns:
      a new offset vector

    • getWalkStairsCosAngleForwardContact

      public float getWalkStairsCosAngleForwardContact()
      Return the cosine of the maximum angle between the ground normal and the horizontal for adjusting the step-forward test. The settings are unaffected. (native attribute: mWalkStairsCosAngleForwardContact)
      Specified by:
      getWalkStairsCosAngleForwardContact in interface ConstExtendedUpdateSettings
      Returns:
      the cosine of the maximum angle

    • getWalkStairsMinStepForward

      public float getWalkStairsMinStepForward()
      Return the StickToFloor inStepForward parameter. The settings are unaffected. (native attribute: mWalkStairsMinStepForward)
      Specified by:
      getWalkStairsMinStepForward in interface ConstExtendedUpdateSettings
      Returns:
      the distance

    • getWalkStairsStepForwardTest

      public float getWalkStairsStepForwardTest()
      Return the StickToFloor inStepForwardTest parameter. The settings are unaffected. (native attribute: mWalkStairsStepForwardTest)
      Specified by:
      getWalkStairsStepForwardTest in interface ConstExtendedUpdateSettings
      Returns:
      the distance

    • getWalkStairsStepUp

      public Vec3 getWalkStairsStepUp()
      Copy the StickToFloor inStepUp parameter. The settings are unaffected. (native attribute: mWalkStairsStepUp)
      Specified by:
      getWalkStairsStepUp in interface ConstExtendedUpdateSettings
      Returns:
      a new offset vector