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

Class SpringSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.SpringSettings
All Implemented Interfaces:
ConstJoltPhysicsObject, ConstSpringSettings, AutoCloseable, Comparable<JoltPhysicsObject>
public final class SpringSettings extends JoltPhysicsObject implements ConstSpringSettings
Settings used to construct a spring.

  • Constructor Details

    • SpringSettings

      public SpringSettings()
      Instantiate default settings.

    • SpringSettings

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

  • Method Details

    • restoreBinaryState

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

    • setDamping

      public SpringSettings setDamping(float damping)
      Alter the spring's damping. (native attribute: mDamping)

      When the mode is FrequencyAndDamping, this is the damping ratio (0 = no damping, 1 = critical damping). When the mode is StiffnessAndDamping, this is the damping coefficient c in the spring equation: F = -k * x - c * v for a linear spring or T = -k * theta - c * w for an angular spring.

      Parameters:
      damping - the desired damping (default=0)
      Returns:
      the modified settings, for chaining

    • setFrequency

      public SpringSettings setFrequency(float frequency)
      Alter the spring's frequency. (native attribute: mFrequency)

      Effective only when the mode is FrequencyAndDamping. If positive, the constraint will have soft limits, and mFrequency specifies the oscillation frequency in Hz. Otherwise, the constraint will have hard limits.

      Parameters:
      frequency - the desired frequency (default=0)
      Returns:
      the modified settings, for chaining

    • setMode

      public SpringSettings setMode(ESpringMode mode)
      Alter how the spring is specified. (native attribute: mMode)
      Parameters:
      mode - the desired mode (not null, default=FrequencyAndDamping)
      Returns:
      the modified settings, for chaining

    • setStiffness

      public SpringSettings setStiffness(float stiffness)
      Alter the stiffness of the spring. (native attribute: mStiffness)

      Effective only when the mode is StiffnessAndDamping. If positive, the constraint will have soft limits, and mStiffness specifies the stiffness k in the spring equation: F = -k * x - c * v for a linear spring or T = -k * theta - c * w for an angular spring.

      If negative, the constraint will have hard limits.

      Parameters:
      stiffness - (default=0)
      Returns:
      the modified settings, for chaining

    • getConstraint

      public Constraint getConstraint()
      Access the underlying Constraint, if any.
      Specified by:
      getConstraint in interface ConstSpringSettings
      Returns:
      the pre-existing instance, or null if none

    • getConstraintSettings

      public ConstraintSettings getConstraintSettings()
      Access the underlying ConstraintSettings, if any.
      Specified by:
      getConstraintSettings in interface ConstSpringSettings
      Returns:
      the pre-existing instance, or null if none

    • getDamping

      public float getDamping()
      Return the spring's damping. The settings are unaffected. (native attribute: mDamping)

      When the mode is FrequencyAndDamping, this is the damping ratio (0 = no damping, 1 = critical damping). When the mode is StiffnessAndDamping, this is the damping coefficient c in the spring equation: F = -k * x - c * v for a linear spring or T = -k * theta - c * w for an angular spring.

      Specified by:
      getDamping in interface ConstSpringSettings
      Returns:
      the damping value

    • getFrequency

      public float getFrequency()
      Return the spring's frequency. The settings are unaffected. (native attribute: mFrequency)

      Effective only when the mode is FrequencyAndDamping. If positive, the constraint will have soft limits, and mFrequency specifies the oscillation frequency in Hz. If negative, the constraint will have hard limits.

      Specified by:
      getFrequency in interface ConstSpringSettings
      Returns:
      the frequency value

    • getMode

      public ESpringMode getMode()
      Return how the spring is specified. The settings are unaffected. (native attribute: mMode)
      Specified by:
      getMode in interface ConstSpringSettings
      Returns:
      an enum value (not null)

    • getStiffness

      public float getStiffness()
      Return the spring's stiffness. The settings are unaffected. (native attribute: mStiffness)

      Effective only when the mode is StiffnessAndDamping. If positive, the constraint will have soft limits, and mStiffness specifies the stiffness k in the spring equation: F = -k * x - c * v for a linear spring or T = -k * theta - c * w for an angular spring.

      If negative, the constraint will have hard limits.

      Specified by:
      getStiffness in interface ConstSpringSettings
      Returns:
      the stiffness value

    • hasStiffness

      public boolean hasStiffness()
      Test for valid frequency/stiffness. The settings are unaffected.
      Specified by:
      hasStiffness in interface ConstSpringSettings
      Returns:
      true if valid (the constraint will have soft limits), otherwise false (hard limits)

    • saveBinaryState

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