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

Interface ConstConstraint

All Superinterfaces:
AutoCloseable, Comparable<JoltPhysicsObject>, ConstJoltPhysicsObject
All Known Subinterfaces:
ConstTwoBodyConstraint, ConstVehicleConstraint
All Known Implementing Classes:
ConeConstraint, Constraint, ConstraintRef, DistanceConstraint, FixedConstraint, GearConstraint, HingeConstraint, PathConstraint, PointConstraint, PulleyConstraint, RackAndPinionConstraint, SixDofConstraint, SliderConstraint, SwingTwistConstraint, TwoBodyConstraint, TwoBodyConstraintRef, VehicleConstraint, VehicleConstraintRef
public interface ConstConstraint extends ConstJoltPhysicsObject
Read-only access to a Constraint. (native type: const Constraint)

  • Method Details

    • getConstraintPriority

      int getConstraintPriority()
      Return the constraint's priority when solving. The constraint is unaffected.
      Returns:
      the priority level

    • getConstraintSettings

      ConstraintSettingsRef getConstraintSettings()
      Generate settings to reconstruct the constraint. The constraint is unaffected.
      Returns:
      a new counted reference to a new settings object

    • getEnabled

      boolean getEnabled()
      Test whether the constraint is enabled. The constraint is unaffected.
      Returns:
      true if enabled, otherwise false

    • getNumPositionStepsOverride

      int getNumPositionStepsOverride()
      Return the override for the number of position iterations used in the solver. The constraint is unaffected.
      Returns:
      the number of iterations, or 0 to use the default in PhysicsSettings

    • getNumVelocityStepsOverride

      int getNumVelocityStepsOverride()
      Return the override for the number of velocity iterations used in the solver. The constraint is unaffected.
      Returns:
      the number of iterations, or 0 to use the default in PhysicsSettings

    • getSubType

      EConstraintSubType getSubType()
      Return the constraint's subtype. The constraint is unaffected.
      Returns:
      an enum value (not null)

    • getType

      EConstraintType getType()
      Return the constraint's type. The constraint is unaffected.
      Returns:
      an enum value (not null)

    • isActive

      boolean isActive()
      Test whether the constraint is active. The constraint is unaffected.
      Returns:
      true if active, otherwise false

    • saveState

      void saveState(StateRecorder recorder)
      Save the state of the constraint, for possible replay. The constraint is unaffected.
      Parameters:
      recorder - the recorder to write to (not null)