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

Interface ConstCharacterVirtualSettings

All Superinterfaces:
Comparable<JoltPhysicsObject>, ConstCharacterBaseSettings, ConstJoltPhysicsObject
All Known Implementing Classes:
CharacterVirtualSettings
public interface ConstCharacterVirtualSettings extends ConstCharacterBaseSettings
Read-only access to a CharacterVirtualSettings object. (native type: const CharacterVirtualSettings)

  • Method Details

    • getBackFaceMode

      EBackFaceMode getBackFaceMode()
      Determine whether the character will move through back-facing triangles. The settings are unaffected.
      Returns:
      an enum value (not null)

    • getCharacterPadding

      float getCharacterPadding()
      Return how far the character tries to stay away from the geometry. The settings are unaffected.
      Returns:
      the desired distance (in meters)

    • getCollisionTolerance

      float getCollisionTolerance()
      Return the collision tolerance. The settings are unaffected.
      Returns:
      the allowed penetration distance (in meters)

    • getHitReductionCosMaxAngle

      float getHitReductionCosMaxAngle()
      Return the maximum angle for merging during hit reduction. The settings are unaffected.
      Returns:
      the cosine of the maximum angle, or -1 if hit reduction is disabled

    • getInnerBodyLayer

      int getInnerBodyLayer()
      Return the object layer that the inner rigid body will be added to. The settings are unaffected.
      Returns:
      the index of the object layer

    • getInnerBodyShape

      ConstShape getInnerBodyShape()
      Return the shape of the inner rigid body. The settings are unaffected.
      Returns:
      the shape, or null for no inner body

    • getMass

      float getMass()
      Return the character's mass. The settings are unaffected.
      Returns:
      the mass (in kilograms)

    • getMaxCollisionIterations

      int getMaxCollisionIterations()
      Return the maximum number of collision iterations. The settings are unaffected.
      Returns:
      the number of iterations (≥0)

    • getMaxConstraintIterations

      int getMaxConstraintIterations()
      Return how often to try stepping in the constraint solver. The settings are unaffected.
      Returns:
      the number of iterations (≥0)

    • getMaxNumHits

      int getMaxNumHits()
      Return the maximum number of hits to be collected. The settings are unaffected.
      Returns:
      the limit (≥0)

    • getMaxStrength

      float getMaxStrength()
      Return the maximum force applied to other bodies. The settings are unaffected.
      Returns:
      the force (in Newtons)

    • getMinTimeRemaining

      float getMinTimeRemaining()
      Return the early out threshold. The settings are unaffected.
      Returns:
      the simulation time interval (in seconds)

    • getPenetrationRecoverySpeed

      float getPenetrationRecoverySpeed()
      Return how quickly penetration is resolved. The settings are unaffected.
      Returns:
      the resolution fraction (0=never resolved, 1=all in one update)

    • getPredictiveContactDistance

      float getPredictiveContactDistance()
      Return the maximum range of predictive contacts. The settings are unaffected.
      Returns:
      the distance (in meters)

    • getShapeOffset

      Vec3 getShapeOffset()
      Copy the local offset applied to the shape. The settings are unaffected.
      Returns:
      a new offset vector (in local coordinates)