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

Class SliderConstraintSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.SerializableObject
com.github.stephengold.joltjni.ConstraintSettings
com.github.stephengold.joltjni.TwoBodyConstraintSettings
com.github.stephengold.joltjni.SliderConstraintSettings
All Implemented Interfaces:
ConstConstraintSettings, ConstJoltPhysicsObject, ConstSerializableObject, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>
public class SliderConstraintSettings extends TwoBodyConstraintSettings
Settings used to construct a SliderConstraint.

  • Constructor Details

    • SliderConstraintSettings

      public SliderConstraintSettings()
      Instantiate default settings.

    • SliderConstraintSettings

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

  • Method Details

    • getAutoDetectPoint

      public boolean getAutoDetectPoint()
      Test whether to configure the attachment points based on the positions of the bodies when the constraint is created. The settings are unaffected. (native attribute: mAutoDetectPoint)
      Returns:
      true to use body positions, false for explicit configuration

    • getLimitsMax

      public float getLimitsMax()
      Return the upper limit of translation. The settings are unaffected. (native attribute: mLimitsMax)
      Returns:
      the upper limit

    • getLimitsMin

      public float getLimitsMin()
      Return the lower limit of translation. The settings are unaffected. (native attribute: mLimitsMin)
      Returns:
      the lower limit

    • getLimitsSpringSettings

      public SpringSettings getLimitsSpringSettings()
      Access the spring settings. (native attribute: mLimitsSpringSettings)
      Returns:
      a new JVM object with the pre-existing native object assigned

    • getMaxFrictionForce

      public float getMaxFrictionForce()
      Return the maximum friction force when not driven by a motor. The settings are unaffected. (native attribute: mMaxFrictionForce)
      Returns:
      the force (in Newtons)

    • getMotorSettings

      public MotorSettings getMotorSettings()
      Access the motor settings. (native attribute: mMotorSettings)
      Returns:
      a new JVM object with the pre-existing native object assigned

    • getNormalAxis1

      public Vec3 getNormalAxis1()
      Copy the normal axis of body 1. The settings are unaffected. (native attribute: mNormalAxis1)
      Returns:
      a new direction vector

    • getNormalAxis2

      public Vec3 getNormalAxis2()
      Copy the normal axis of body 2. The settings are unaffected. (native attribute: mNormalAxis2)
      Returns:
      a new direction vector

    • getPoint1

      public RVec3 getPoint1()
      Copy the constraint location for body 1. The settings are unaffected. (native attribute: mPoint1)
      Returns:
      a new location vector

    • getPoint2

      public RVec3 getPoint2()
      Copy the constraint location for body 2. The settings are unaffected. (native attribute: mPoint2)
      Returns:
      a new location vector

    • getSliderAxis1

      public Vec3 getSliderAxis1()
      Copy the slider axis of body 1. The settings are unaffected. (native attribute: mSliderAxis1)
      Returns:
      a new direction vector

    • getSliderAxis2

      public Vec3 getSliderAxis2()
      Copy the slider axis of body 2. The settings are unaffected. (native attribute: mSliderAxis2)
      Returns:
      a new direction vector

    • getSpace

      public EConstraintSpace getSpace()
      Return which space the other properties are specified in. The settings are unaffected. (native attribute: mSpace)
      Returns:
      an enum value (not null)

    • setAutoDetectPoint

      public void setAutoDetectPoint(boolean setting)
      Alter whether to configure the attachment points based on the positions of the bodies when the constraint is created. (native attribute: mAutoDetectPoint)
      Parameters:
      setting - true to use body positions, false for explicit configuration (default=false)

    • setLimitsMax

      public void setLimitsMax(float limit)
      Alter the upper limit of translation. (native attribute: mLimitsMax)
      Parameters:
      limit - the desired upper limit (default=MAX_VALUE)

    • setLimitsMin

      public void setLimitsMin(float limit)
      Alter the lower limit of translation. (native attribute: mLimitsMin)
      Parameters:
      limit - the desired lower limit (default=-MAX_VALUE)

    • setMaxFrictionForce

      public void setMaxFrictionForce(float force)
      Alter the maximum friction force when not driven by a motor. (native attribute: mMaxFrictionForce)
      Parameters:
      force - the desired force (in Newtons, default=0)

    • setNormalAxis1

      public Vec3Arg setNormalAxis1(Vec3Arg direction)
      Alter the normal axis of body 1. (native attribute: mNormalAxis1)
      Parameters:
      direction - the desired axis direction (not null, unaffected, default=(0,1,0))
      Returns:
      the argument, for chaining

    • setNormalAxis2

      public Vec3Arg setNormalAxis2(Vec3Arg direction)
      Alter the normal axis of body 2. (native attribute: mNormalAxis2)
      Parameters:
      direction - the desired axis direction (not null, unaffected, default=(0,1,0))
      Returns:
      the argument, for chaining

    • setPoint1

      public RVec3Arg setPoint1(RVec3Arg location)
      Alter the constraint location for body 1. (native attribute: mPoint1)
      Parameters:
      location - the desired location (not null, unaffected, default=(0,0,0))
      Returns:
      the argument, for chaining

    • setPoint2

      public RVec3Arg setPoint2(RVec3Arg location)
      Alter the constraint location for body 2. (native attribute: mPoint2)
      Parameters:
      location - the desired location (not null, unaffected, default=(0,0,0))
      Returns:
      the argument, for chaining

    • setSliderAxis

      public void setSliderAxis(Vec3Arg sliderAxis)
      Alter the slider and normal axes, assuming the bodies are correctly oriented.
      Parameters:
      sliderAxis - the desired slider axis direction (in system coordinates, not null, unaffected)

    • setSliderAxis1

      public Vec3Arg setSliderAxis1(Vec3Arg direction)
      Alter the slider axis of body 1. (native attribute: mSliderAxis1)
      Parameters:
      direction - the desired axis direction (not null, unaffected, default=(1,0,0))
      Returns:
      the argument, for chaining

    • setSliderAxis2

      public Vec3Arg setSliderAxis2(Vec3Arg direction)
      Alter the slider axis of body 2. (native attribute: mSliderAxis2)
      Parameters:
      direction - the desired axis direction (not null, unaffected, default=(1,0,0))
      Returns:
      the argument, for chaining

    • setSpace

      public void setSpace(EConstraintSpace space)
      Alter which space the other properties are specified in. (native attribute: mSpace)
      Parameters:
      space - enum value (not null, default=WorldSpace)