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

Class HingeConstraintSettings

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.HingeConstraintSettings
All Implemented Interfaces:
ConstConstraintSettings, ConstJoltPhysicsObject, ConstSerializableObject, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>
public class HingeConstraintSettings extends TwoBodyConstraintSettings
Settings used to construct a HingeConstraint.

  • Constructor Details

    • HingeConstraintSettings

      public HingeConstraintSettings()
      Instantiate default settings.

    • HingeConstraintSettings

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

  • Method Details

    • getHingeAxis1

      public Vec3 getHingeAxis1()
      Copy the hinge axis of body 1. The settings are unaffected. (native attribute: mHingeAxis1)
      Returns:
      a new direction vector

    • getHingeAxis1

      public void getHingeAxis1(Vec3 storeResult)
      Copy the hinge axis of body 1. The settings are unaffected. (native attribute: mHingeAxis1)
      Parameters:
      storeResult - storage for the direction (not null, modified)

    • getHingeAxis2

      public Vec3 getHingeAxis2()
      Copy the hinge axis of body 2. The settings are unaffected. (native attribute: mHingeAxis2)
      Returns:
      a new direction vector

    • getHingeAxis2

      public void getHingeAxis2(Vec3 storeResult)
      Copy the hinge axis of body 2. The settings are unaffected. (native attribute: mHingeAxis2)
      Parameters:
      storeResult - storage for the direction (not null, modified)

    • getLimitsMax

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

    • getLimitsMin

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

    • getLimitsSpringSettings

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

    • getMaxFrictionTorque

      public float getMaxFrictionTorque()
      Return the maximum friction torque when not driven by a motor. The settings are unaffected. (native attribute: mMaxFrictionTorque)
      Returns:
      the torque (in Newton meters)

    • 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

    • getNormalAxis1

      public void getNormalAxis1(Vec3 storeResult)
      Copy the normal axis of body 1. The settings are unaffected. (native attribute: mNormalAxis1)
      Parameters:
      storeResult - storage for the direction (not null, modified)

    • getNormalAxis2

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

    • getNormalAxis2

      public void getNormalAxis2(Vec3 storeResult)
      Copy the normal axis of body 2. The settings are unaffected. (native attribute: mNormalAxis2)
      Parameters:
      storeResult - storage for the direction (not null, modified)

    • getPoint1

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

    • getPoint1

      public void getPoint1(RVec3 storeResult)
      Copy the constraint location for body 1. The settings are unaffected. (native attribute: mPoint1)
      Parameters:
      storeResult - storage for the location (not null, modified)

    • getPoint2

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

    • getPoint2

      public void getPoint2(RVec3 storeResult)
      Copy the constraint location for body 2. The settings are unaffected. (native attribute: mPoint2)
      Parameters:
      storeResult - storage for the location (not null, modified)

    • 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)

    • set

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

    • setHingeAxis1

      public void setHingeAxis1(float x, float y, float z)
      Alter the hinge axis of body 1. (native attribute: mHingeAxis1)
      Parameters:
      x - the desired X component of the axis direction (default=0)
      y - the desired Y component of the axis direction (default=1)
      z - the desired Z component of the axis direction (default=0)

    • setHingeAxis1

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

    • setHingeAxis2

      public void setHingeAxis2(float x, float y, float z)
      Alter the hinge axis of body 2. (native attribute: mHingeAxis2)
      Parameters:
      x - the desired X component of the axis direction (default=0)
      y - the desired Y component of the axis direction (default=1)
      z - the desired Z component of the axis direction (default=0)

    • setHingeAxis2

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

    • setLimitsMax

      public void setLimitsMax(float limit)
      Alter the upper limit of rotation. (native attribute: mLimitsMax)
      Parameters:
      limit - the desired upper limit (in radians, default=Pi)

    • setLimitsMin

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

    • setMaxFrictionTorque

      public void setMaxFrictionTorque(float torque)
      Alter the maximum friction torque when not driven by a motor. (native attribute: mMaxFrictionTorque)
      Parameters:
      torque - the desired torque (in Newton meters, default=0)

    • setMotorSettings

      public void setMotorSettings(MotorSettings settings)
      Alter the constraint's motor settings. (native attribute: mMotorSettings)
      Parameters:
      settings - the motor settings to copy (not null, unaffected)

    • setNormalAxis1

      public void setNormalAxis1(float x, float y, float z)
      Alter the normal axis of body 1. (native attribute: mNormalAxis1)
      Parameters:
      x - the desired X component of the axis direction (default=0)
      y - the desired Y component of the axis direction (default=1)
      z - the desired Z component of the axis direction (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 void setNormalAxis2(float x, float y, float z)
      Alter the normal axis of body 2. (native attribute: mNormalAxis2)
      Parameters:
      x - the desired X component of the axis direction (default=0)
      y - the desired Y component of the axis direction (default=1)
      z - the desired Z component of the axis direction (default=0)

    • 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 void setPoint1(double x, double y, double z)
      Alter the constraint location for body 1. (native attribute: mPoint1)
      Parameters:
      x - the desired X coordinate (default=0)
      y - the desired Y coordinate (default=0)
      z - the desired Z coordinate (default=0)

    • 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 void setPoint2(double x, double y, double z)
      Alter the constraint location for body 2. (native attribute: mPoint2)
      Parameters:
      x - the desired X coordinate (default=0)
      y - the desired Y coordinate (default=0)
      z - the desired Z coordinate (default=0)

    • 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

    • 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)