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

Class Jolt

java.lang.Object
com.github.stephengold.joltjni.Jolt
public final class Jolt extends Object
Utility methods providing JNI access to Jolt Physics.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final float
    cDefaultConvexRadius
    default rounding of corners in convex shapes (in meters)
    static final int
    cEmptySubShapeId
    empty sub-shape ID
    static final int
    cInvalidBodyId
    invalid body ID
    static final int
    cMaxPhysicsBarriers
    standard 2nd argument to the JobSystemThreadPool constructor
    static final int
    cMaxPhysicsJobs
    standard first argument to the JobSystemThreadPool constructor
    static final float
    JPH_PI
    single-precision value of Pi
    static final Object
    nullptr
    generic null pointer (to expedite porting of C++ code)
    static final int
    SWIZZLE_X
    index of the X component, for swizzling
    static final int
    SWIZZLE_Y
    index of the Y component, for swizzling
    static final int
    SWIZZLE_Z
    index of the Z component, for swizzling

  • Method Summary

    Modifier and Type
    Method
    Description
    static float
    aCos(float ratio)
    Return the inverse cosine of the specified single-precision ratio.
    static float
    aTan(float ratio)
    Return the inverse tangent of the specified single-precision ratio.
    static float
    aTan2(float opposite, float adjacent)
    Return the angle of the specified single-precision right triangle.
    static String
    buildType()
    Return the Jolt-JNI build-type string that's hard-coded in the native library.
    static float
    cos(float angle)
    Return the cosine of the specified single-precision angle.
    static int
    countDeletes()
    Return the cumulative number of delete operations in glue code, in Debug native libraries.
    static int
    countNews()
    Return the cumulative number of new operations in glue code, in Debug native libraries, excluding ref targets.
    static float
    degreesToRadians(float degrees)
    Convert the specified angle from degrees to radians.
    static void
    destroyFactory()
    Destroy the factory used for collision dispatch and object-stream serialization.
    static void
    detLog(String message)
    Append a message to the determinism log.
    static void
    estimateCollisionResponse(ConstBody body1, ConstBody body2, ConstContactManifold manifold, CollisionEstimationResult storeResult, float combinedFriction, float combinedRestitution)
    Estimate the contact impulses and body velocity changes resulting from a collision.
    static void
    estimateCollisionResponse(ConstBody body1, ConstBody body2, ConstContactManifold manifold, CollisionEstimationResult storeResult, float combinedFriction, float combinedRestitution, float minVelocity)
    Estimate the contact impulses and body velocity changes resulting from a collision.
    static void
    estimateCollisionResponse(ConstBody body1, ConstBody body2, ConstContactManifold manifold, CollisionEstimationResult storeResult, float combinedFriction, float combinedRestitution, float minVelocity, int numIterations)
    Estimate the contact impulses and body velocity changes resulting from a collision.
    static long
    getAssertCallback()
    Return the installed assert callback.
    static String
    getConfigurationString()
    Return a string describing some important configuration settings of the native library.
    static long
    hashBytes(long dataVa, int inSize)
    Return a hash code for the specified data bytes.
    static long
    hashBytes(QuatArg quaternion, long oldHash)
    Combine the specified quaternion with the specified hash code.
    static long
    hashBytes(RVec3Arg vector, long oldHash)
    Combine the specified vector with the specified hash code.
    static long
    hashCombine(long oldHash, int iValue)
    Combine the specified 32-bit integer with the specified hash code.
    static long
    hashCombine(long oldHash, long lValue)
    Combine the specified 64-bit integer with the specified hash code.
    static long
    hashCombine(long oldHash, RVec3Arg vector)
    Combine the specified location vector with the specified hash code.
    static long
    hashCombine(long oldHash, Vec3Arg vector)
    Combine the specified vector with the specified hash code.
    static boolean
    implementsComputeCpu()
    Test whether the native library implements CPU-based compute systems, which are intended mainly for debugging.
    static boolean
    implementsComputeDx12()
    Test whether the native library implements compute systems based on Microsoft's DirectX 12 API.
    static boolean
    implementsComputeMtl()
    Test whether the native library implements compute systems based on Apple's Metal API.
    static boolean
    implementsComputeVk()
    Test whether the native library implements compute systems based on Khronos's Vulkan API.
    static boolean
    implementsDebugRendering()
    Test whether the native library implements debug rendering.
    static boolean
    implementsDeterminismLog()
    Test whether the native library implements extra logging to help debug determinism issues.
    static void
    installAssertCallback(long callbackVa)
    Install the specified assert callback.
    static void
    installCerrTraceCallback()
    Install an alternative trace callback that writes to cerr.
    static void
    installCrashAssertCallback()
    Install an alternative assert callback that crashes the JVM with an EXCEPTION_ACCESS_VIOLATION or SIGILL.
    static void
    installDefaultAssertCallback()
    Install the default assert callback, which writes to cout and triggers a native breakpoint.
    static void
    installDefaultTraceCallback()
    Install the default trace callback, which writes to cout.
    static void
    installIgnoreAssertCallback()
    Install an alternative assert callback that silently ignores assertions.
    static void
    installJavaTraceCallback(PrintStream stream)
    Install an alternative trace callback that writes to the specified PrintStream.
    static boolean
    isDoublePrecision()
    Test whether the native library uses double-precision location vectors.
    static Set<Class<?>>
    listClasses(String packageName)
    List all classes in the specified Jolt-JNI package.
    static ByteBuffer
    loadResourceAsBytes(String resourceName)
    Load raw bytes from the named classpath resource.
    static ByteBuffer
    newDirectByteBuffer(int numBytes)
    Create a direct ByteBuffer with native byte order and the specified capacity.
    static DoubleBuffer
    newDirectDoubleBuffer(int numDoubles)
    Create a direct DoubleBuffer with native byte order and the specified capacity.
    static FloatBuffer
    newDirectFloatBuffer(int numFloats)
    Create a direct FloatBuffer with native byte order and the specified capacity.
    static IntBuffer
    newDirectIntBuffer(int numInts)
    Create a direct IntBuffer with native byte order and the specified capacity.
    static LongBuffer
    newDirectLongBuffer(int numLongs)
    Create a direct LongBuffer with native byte order and the specified capacity.
    static ShortBuffer
    newDirectShortBuffer(int numShorts)
    Create a direct ShortBuffer with native byte order and the specified capacity.
    static boolean
    newFactory()
    Create a factory for collision dispatch and object-stream serialization.
    static float
    perlinNoise3(float x, float y, float z, int xWrap, int yWrap, int zWrap)
    Generate 3-D Perlin noise.
    static void
    profileDump(String message)
    Dump profiler data.
    static void
    profileEnd()
    Terminate the profiler.
    static void
    profileNextFrame()
    Increment the profiler's frame counter.
    static void
    profileStart(String name)
    Start an instrumented code section.
    static float
    radiansToDegrees(float radians)
    Convert the specified angle from radians to degrees.
    static float
    rayAaBox(Vec3Arg rayOrigin, RayInvDirection invDirection, Vec3Arg minimum, Vec3Arg maximum)
    Intersect the specified axis-aligned box with the specified ray.
    static boolean
    rayAaBoxHits(Vec3Arg startLocation, Vec3Arg offset, Vec3Arg minimum, Vec3Arg maximum)
    Intersect the specified axis-aligned box with the specified ray.
    static float
    rayCapsule(Vec3Arg rayOrigin, Vec3Arg rayDirection, float capsuleHalfHeight, float capsuleRadius)
    Intersect the specified capsule with the specified ray.
    static float
    rayCylinder(Vec3Arg rayOrigin, Vec3Arg rayDirection, float cylinderRadius)
    Intersect the specified infinite cylinder with the specified ray.
    static float
    rayCylinder(Vec3Arg rayOrigin, Vec3Arg rayDirection, float cylinderHalfHeight, float cylinderRadius)
    Intersect the specified finite cylinder with the specified ray.
    static float
    raySphere(Vec3Arg rayOrigin, Vec3Arg rayDirection, Vec3Arg sphereCenter, float sphereRadius)
    Intersect the specified sphere with the specified ray.
    static float
    rayTriangle(Vec3Arg rayOrigin, Vec3Arg rayDirection, Vec3Arg v0, Vec3Arg v1, Vec3Arg v2)
    Intersect the specified triangle with the specified ray.
    static void
    registerCustomAllocator(long allocateVa, long reallocateVa, long freeVa, long alignedAllocateVa, long alignedFreeVa)
    Register the allocation hook to use the specified functions.
    static void
    registerDefaultAllocator()
    Register the allocation hook to use malloc/free.
    static void
    registerHair()
    Register HairSettings with the factory.
    static void
    registerTypes()
    Register all physics types except HairSettings with the factory and install their collision handlers.
    static void
    setTraceAllocations(boolean setting)
    Enable or disable allocation tracing in Debug native libraries.
    static float
    sign(float input)
    Return the (binary) sign of the specified single-precision value.
    static float
    sin(float angle)
    Return the sine of the specified single-precision angle.
    static float
    square(float value)
    Return the square of the specified single-precision value.
    static int
    square(int value)
    Return the square of the specified integer value.
    static void
    sSetNextCharacterId()
    Set the next available character ID to 1.
    static void
    sSetNextCharacterId(int nextValue)
    Set the next available character ID to the specified value.
    static boolean
    supportsObjectStream()
    Test whether the native library supports the ObjectStream format.
    static float
    tan(float angle)
    Return the tangent ratio of the specified single-precision angle.
    static void
    test000(String... args)
    Execute a test written in native code.
    static void
    unregisterTypes()
    Unregister all physics types with the factory.
    static String
    versionString()
    Return the Jolt-JNI version string that's hard-coded into the native library.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • cDefaultConvexRadius

      public static final float cDefaultConvexRadius
      default rounding of corners in convex shapes (in meters)

      value should match Jolt/Physics/PhysicsSettings.h

      See Also:

    • JPH_PI

      public static final float JPH_PI
      single-precision value of Pi
      See Also:

    • cEmptySubShapeId

      public static final int cEmptySubShapeId
      empty sub-shape ID

      value should match Jolt/Physics/Collision/Shape/SubShapeID.h

      See Also:

    • cInvalidBodyId

      public static final int cInvalidBodyId
      invalid body ID

      value should match Jolt/Physics/Body/BodyID.h

      See Also:

    • cMaxPhysicsBarriers

      public static final int cMaxPhysicsBarriers
      standard 2nd argument to the JobSystemThreadPool constructor

      value should match Jolt/Physics/PhysicsSettings.h

      See Also:

    • cMaxPhysicsJobs

      public static final int cMaxPhysicsJobs
      standard first argument to the JobSystemThreadPool constructor

      value should match Jolt/Physics/PhysicsSettings.h

      See Also:

    • SWIZZLE_X

      public static final int SWIZZLE_X
      index of the X component, for swizzling
      See Also:

    • SWIZZLE_Y

      public static final int SWIZZLE_Y
      index of the Y component, for swizzling
      See Also:

    • SWIZZLE_Z

      public static final int SWIZZLE_Z
      index of the Z component, for swizzling
      See Also:

    • nullptr

      public static final Object nullptr
      generic null pointer (to expedite porting of C++ code)

  • Method Details

    • aCos

      public static float aCos(float ratio)
      Return the inverse cosine of the specified single-precision ratio. (see Jolt/Math/Trigonometry.h)
      Parameters:
      ratio - the input cosine ratio (≥-1, ≤1)
      Returns:
      the angle (in radians)

    • aTan

      public static float aTan(float ratio)
      Return the inverse tangent of the specified single-precision ratio. (see Jolt/Math/Trigonometry.h)
      Parameters:
      ratio - the input tangent ratio
      Returns:
      the angle (in radians)

    • aTan2

      public static float aTan2(float opposite, float adjacent)
      Return the angle of the specified single-precision right triangle. (see Jolt/Math/Trigonometry.h)
      Parameters:
      opposite - the signed length of the opposite side
      adjacent - the signed length of the adjacent side
      Returns:
      the angle (in radians)

    • buildType

      public static String buildType()
      Return the Jolt-JNI build-type string that's hard-coded in the native library.
      Returns:
      either "Debug" or "Release"

    • cos

      public static float cos(float angle)
      Return the cosine of the specified single-precision angle. (see Jolt/Math/Trigonometry.h)
      Parameters:
      angle - the input angle (in radians)
      Returns:
      the cosine ratio

    • countDeletes

      public static int countDeletes()
      Return the cumulative number of delete operations in glue code, in Debug native libraries.
      Returns:
      the count (≥0)

    • countNews

      public static int countNews()
      Return the cumulative number of new operations in glue code, in Debug native libraries, excluding ref targets.
      Returns:
      the count (≥0)

    • degreesToRadians

      public static float degreesToRadians(float degrees)
      Convert the specified angle from degrees to radians.
      Parameters:
      degrees - the angle to convert (in degrees)
      Returns:
      the converted angle (in radians)

    • destroyFactory

      public static void destroyFactory()
      Destroy the factory used for collision dispatch and object-stream serialization.
      See Also:

    • detLog

      public static void detLog(String message)
      Append a message to the determinism log. (native macro: JPH_DET_LOG)
      Parameters:
      message - (not null)

    • estimateCollisionResponse

      public static void estimateCollisionResponse(ConstBody body1, ConstBody body2, ConstContactManifold manifold, CollisionEstimationResult storeResult, float combinedFriction, float combinedRestitution)
      Estimate the contact impulses and body velocity changes resulting from a collision. (see Physics/Collision/EstimateCollisionResponse.cpp)
      Parameters:
      body1 - the first colliding body (not null, unaffected)
      body2 - the 2nd colliding body (not null, unaffected)
      manifold - the collision manifold (not null, unaffected)
      storeResult - storage for impulses and velocities (not null, modified)
      combinedFriction - the combined friction of the 2 bodies
      combinedRestitution - the combined restitution of the 2 bodies

    • estimateCollisionResponse

      public static void estimateCollisionResponse(ConstBody body1, ConstBody body2, ConstContactManifold manifold, CollisionEstimationResult storeResult, float combinedFriction, float combinedRestitution, float minVelocity)
      Estimate the contact impulses and body velocity changes resulting from a collision. (see Physics/Collision/EstimateCollisionResponse.cpp)
      Parameters:
      body1 - the first colliding body (not null, unaffected)
      body2 - the 2nd colliding body (not null, unaffected)
      manifold - the collision manifold (not null, unaffected)
      storeResult - storage for impulses and velocities (not null, modified)
      combinedFriction - the combined friction of the 2 bodies
      combinedRestitution - the combined restitution of the 2 bodies
      minVelocity - the minimum speed for restitution to be applied (in meters per second, default=1)

    • estimateCollisionResponse

      public static void estimateCollisionResponse(ConstBody body1, ConstBody body2, ConstContactManifold manifold, CollisionEstimationResult storeResult, float combinedFriction, float combinedRestitution, float minVelocity, int numIterations)
      Estimate the contact impulses and body velocity changes resulting from a collision. (see Physics/Collision/EstimateCollisionResponse.cpp)
      Parameters:
      body1 - the first colliding body (not null, unaffected)
      body2 - the 2nd colliding body (not null, unaffected)
      manifold - the collision manifold (not null, unaffected)
      storeResult - storage for impulses and velocities (not null, modified)
      combinedFriction - the combined friction of the 2 bodies
      combinedRestitution - the combined restitution of the 2 bodies
      minVelocity - the minimum speed for restitution to be applied (in meters per second, default=1)
      numIterations - the number of iterations the impulse solver to use (default=10)

    • getAssertCallback

      public static long getAssertCallback()
      Return the installed assert callback.
      Returns:
      the virtual address of the callback, or zero if none
      See Also:

    • getConfigurationString

      public static String getConfigurationString()
      Return a string describing some important configuration settings of the native library. (see Jolt/ConfigurationString.h)
      Returns:
      the string value

    • hashBytes

      public static long hashBytes(long dataVa, int inSize)
      Return a hash code for the specified data bytes. (see Jolt/Core/HashCombine.h)
      Parameters:
      dataVa - the virtual address of the data, or 0 for no data
      inSize - the number of data bytes, or 0 for no data
      Returns:
      the hash code

    • hashBytes

      public static long hashBytes(QuatArg quaternion, long oldHash)
      Combine the specified quaternion with the specified hash code.
      Parameters:
      quaternion - the quaternion to combine (not null, unaffected)
      oldHash - the old hash code
      Returns:
      the new hash code

    • hashBytes

      public static long hashBytes(RVec3Arg vector, long oldHash)
      Combine the specified vector with the specified hash code.
      Parameters:
      vector - the vector to combine (not null, unaffected)
      oldHash - the old hash code
      Returns:
      the new hash code

    • hashCombine

      public static long hashCombine(long oldHash, int iValue)
      Combine the specified 32-bit integer with the specified hash code. (see Jolt/Core/HashCombine.h)
      Parameters:
      oldHash - the old hash code
      iValue - the integer value to combine
      Returns:
      the new hash code

    • hashCombine

      public static long hashCombine(long oldHash, long lValue)
      Combine the specified 64-bit integer with the specified hash code.
      Parameters:
      oldHash - the old hash code
      lValue - the integer value to combine
      Returns:
      the new hash code

    • hashCombine

      public static long hashCombine(long oldHash, RVec3Arg vector)
      Combine the specified location vector with the specified hash code.
      Parameters:
      oldHash - the old hash code
      vector - the vector to combine (not null, unaffected)
      Returns:
      the new hash code

    • hashCombine

      public static long hashCombine(long oldHash, Vec3Arg vector)
      Combine the specified vector with the specified hash code.
      Parameters:
      oldHash - the old hash code
      vector - the vector to combine (not null, unaffected)
      Returns:
      the new hash code

    • implementsComputeCpu

      public static boolean implementsComputeCpu()
      Test whether the native library implements CPU-based compute systems, which are intended mainly for debugging. (native macro: JPH_USE_CPU_COMPUTE)
      Returns:
      true if implemented, otherwise false

    • implementsComputeDx12

      public static boolean implementsComputeDx12()
      Test whether the native library implements compute systems based on Microsoft's DirectX 12 API. (native macro: JPH_USE_DX12)
      Returns:
      true if implemented, otherwise false

    • implementsComputeMtl

      public static boolean implementsComputeMtl()
      Test whether the native library implements compute systems based on Apple's Metal API. (native macro: JPH_USE_MTL)
      Returns:
      true if implemented, otherwise false

    • implementsComputeVk

      public static boolean implementsComputeVk()
      Test whether the native library implements compute systems based on Khronos's Vulkan API. (native macro: JPH_USE_VK)
      Returns:
      true if implemented, otherwise false

    • implementsDebugRendering

      public static boolean implementsDebugRendering()
      Test whether the native library implements debug rendering. (native macro: JPH_DEBUG_RENDERER)
      Returns:
      true if implemented, otherwise false

    • implementsDeterminismLog

      public static boolean implementsDeterminismLog()
      Test whether the native library implements extra logging to help debug determinism issues. (native macro: JPH_ENABLE_DETERMINISM_LOG)
      Returns:
      true if implemented, otherwise false

    • installAssertCallback

      public static void installAssertCallback(long callbackVa)
      Install the specified assert callback.
      Parameters:
      callbackVa - the virtual address of the desired callback
      See Also:

    • installCerrTraceCallback

      public static void installCerrTraceCallback()
      Install an alternative trace callback that writes to cerr.

    • installCrashAssertCallback

      public static void installCrashAssertCallback()
      Install an alternative assert callback that crashes the JVM with an EXCEPTION_ACCESS_VIOLATION or SIGILL. Intended for testing only!

    • installDefaultAssertCallback

      public static void installDefaultAssertCallback()
      Install the default assert callback, which writes to cout and triggers a native breakpoint.

    • installDefaultTraceCallback

      public static void installDefaultTraceCallback()
      Install the default trace callback, which writes to cout.

    • installIgnoreAssertCallback

      public static void installIgnoreAssertCallback()
      Install an alternative assert callback that silently ignores assertions.

    • installJavaTraceCallback

      public static void installJavaTraceCallback(PrintStream stream)
      Install an alternative trace callback that writes to the specified PrintStream.
      Parameters:
      stream - where to send trace output (not null)

    • isDoublePrecision

      public static boolean isDoublePrecision()
      Test whether the native library uses double-precision location vectors. (native macro: JPH_DOUBLE_PRECISION)
      Returns:
      true if double-precision, otherwise false

    • listClasses

      public static Set<Class<?>> listClasses(String packageName)
      List all classes in the specified Jolt-JNI package.
      Parameters:
      packageName - the name of the package (must start with "com.github.stephengold.joltjni")
      Returns:
      a new collection

    • loadResourceAsBytes

      public static ByteBuffer loadResourceAsBytes(String resourceName)
      Load raw bytes from the named classpath resource.
      Parameters:
      resourceName - the name of the resource (not null)
      Returns:
      a new direct buffer

    • newDirectByteBuffer

      public static ByteBuffer newDirectByteBuffer(int numBytes)
      Create a direct ByteBuffer with native byte order and the specified capacity.
      Parameters:
      numBytes - the desired capacity (in bytes)
      Returns:
      a new direct buffer, zeroed and rewound but not flipped

    • newDirectDoubleBuffer

      public static DoubleBuffer newDirectDoubleBuffer(int numDoubles)
      Create a direct DoubleBuffer with native byte order and the specified capacity.
      Parameters:
      numDoubles - the desired capacity (in doubles)
      Returns:
      a new direct buffer, zeroed and rewound but not flipped

    • newDirectFloatBuffer

      public static FloatBuffer newDirectFloatBuffer(int numFloats)
      Create a direct FloatBuffer with native byte order and the specified capacity.
      Parameters:
      numFloats - the desired capacity (in floats)
      Returns:
      a new direct buffer, zeroed and rewound but not flipped

    • newDirectIntBuffer

      public static IntBuffer newDirectIntBuffer(int numInts)
      Create a direct IntBuffer with native byte order and the specified capacity.
      Parameters:
      numInts - the desired capacity (in ints)
      Returns:
      a new direct buffer, zeroed and rewound but not flipped

    • newDirectLongBuffer

      public static LongBuffer newDirectLongBuffer(int numLongs)
      Create a direct LongBuffer with native byte order and the specified capacity.
      Parameters:
      numLongs - the desired capacity (in longs)
      Returns:
      a new direct buffer, zeroed and rewound but not flipped

    • newDirectShortBuffer

      public static ShortBuffer newDirectShortBuffer(int numShorts)
      Create a direct ShortBuffer with native byte order and the specified capacity.
      Parameters:
      numShorts - the desired capacity (in shorts)
      Returns:
      a new direct buffer, zeroed and rewound but not flipped

    • newFactory

      public static boolean newFactory()
      Create a factory for collision dispatch and object-stream serialization.
      Returns:
      true if successful, otherwise false
      See Also:

    • perlinNoise3

      public static float perlinNoise3(float x, float y, float z, int xWrap, int yWrap, int zWrap)
      Generate 3-D Perlin noise. (see TestFramework/External/Perlin.cpp)
      Parameters:
      x - the X coordinate
      y - the Y coordinate
      z - the Z coordinate
      xWrap - the wraparound interval for the X coordinate (power of 2) or 0 for don't care
      yWrap - the wraparound interval for the Y coordinate (power of 2) or 0 for don't care
      zWrap - the wraparound interval for the Z coordinate (power of 2) or 0 for don't care
      Returns:
      a sample value

    • profileDump

      public static void profileDump(String message)
      Dump profiler data. (native macro: JPH_PROFILE_DUMP)
      Parameters:
      message - (not null)

    • profileEnd

      public static void profileEnd()
      Terminate the profiler. (native macro: JPH_PROFILE_END)

    • profileNextFrame

      public static void profileNextFrame()
      Increment the profiler's frame counter. (native macro: JPH_PROFILE_NEXTFRAME)

    • profileStart

      public static void profileStart(String name)
      Start an instrumented code section. (native macro: JPH_PROFILE_START)
      Parameters:
      name - the section name (not null)

    • radiansToDegrees

      public static float radiansToDegrees(float radians)
      Convert the specified angle from radians to degrees.
      Parameters:
      radians - the angle to convert (in radians)
      Returns:
      the converted angle (in degrees)

    • rayAaBox

      public static float rayAaBox(Vec3Arg rayOrigin, RayInvDirection invDirection, Vec3Arg minimum, Vec3Arg maximum)
      Intersect the specified axis-aligned box with the specified ray. (see Jolt/Geometry/RayAABox.h)
      Parameters:
      rayOrigin - the origin of the ray (not null, unaffected)
      invDirection - the inverse direction of the ray (not null, unaffected)
      minimum - the minimum coordinates of the box (not null, unaffected)
      maximum - the maximum coordinates of the box (not null, unaffected)
      Returns:
      the minimum distance along ray, or FLT_MAX if the ray misses the box

    • rayAaBoxHits

      public static boolean rayAaBoxHits(Vec3Arg startLocation, Vec3Arg offset, Vec3Arg minimum, Vec3Arg maximum)
      Intersect the specified axis-aligned box with the specified ray. (see Jolt/Geometry/RayAABox.h)
      Parameters:
      startLocation - the desired start location of the ray (not null, unaffected)
      offset - the desired end offset from the start location (not null, unaffected)
      minimum - the minimum coordinates of the box (not null, unaffected)
      maximum - the maximum coordinates of the box (not null, unaffected)
      Returns:
      true if there is a hit, otherwise false

    • rayCapsule

      public static float rayCapsule(Vec3Arg rayOrigin, Vec3Arg rayDirection, float capsuleHalfHeight, float capsuleRadius)
      Intersect the specified capsule with the specified ray. (see Jolt/Geometry/RayCapsule.h)
      Parameters:
      rayOrigin - the origin of the ray (not null, unaffected)
      rayDirection - the direction of the ray (not null, unaffected)
      capsuleHalfHeight - half the height of the capsule
      capsuleRadius - the radius of the capsule
      Returns:
      the minimum distance along ray, or FLT_MAX if the ray misses the capsule

    • rayCylinder

      public static float rayCylinder(Vec3Arg rayOrigin, Vec3Arg rayDirection, float cylinderRadius)
      Intersect the specified infinite cylinder with the specified ray. (see Jolt/Geometry/RayCylinder.h)
      Parameters:
      rayOrigin - the origin of the ray (not null, unaffected)
      rayDirection - the direction of the ray (not null, unaffected)
      cylinderRadius - the radius of the cylinder
      Returns:
      the minimum distance along ray, or FLT_MAX if the ray misses the cylinder

    • rayCylinder

      public static float rayCylinder(Vec3Arg rayOrigin, Vec3Arg rayDirection, float cylinderHalfHeight, float cylinderRadius)
      Intersect the specified finite cylinder with the specified ray. (see Jolt/Geometry/RayCylinder.h)
      Parameters:
      rayOrigin - the origin of the ray (not null, unaffected)
      rayDirection - the direction of the ray (not null, unaffected)
      cylinderHalfHeight - half of the height of the cylinder
      cylinderRadius - the radius of the cylinder
      Returns:
      the minimum distance along ray, or FLT_MAX if the ray misses the cylinder

    • raySphere

      public static float raySphere(Vec3Arg rayOrigin, Vec3Arg rayDirection, Vec3Arg sphereCenter, float sphereRadius)
      Intersect the specified sphere with the specified ray. (see Jolt/Geometry/RaySphere.h)
      Parameters:
      rayOrigin - the origin of the ray (not null, unaffected)
      rayDirection - the direction of the ray (not null, unaffected)
      sphereCenter - the center of the sphere (not null, unaffected)
      sphereRadius - the radius of the sphere
      Returns:
      the minimum distance along ray, or FLT_MAX if the ray misses the sphere

    • rayTriangle

      public static float rayTriangle(Vec3Arg rayOrigin, Vec3Arg rayDirection, Vec3Arg v0, Vec3Arg v1, Vec3Arg v2)
      Intersect the specified triangle with the specified ray. (see Jolt/Geometry/RayTriangle.h)
      Parameters:
      rayOrigin - the origin of the ray (not null, unaffected)
      rayDirection - the direction of the ray (not null, unaffected)
      v0 - the first vertex of the triangle (not null, unaffected)
      v1 - the 2nd vertex of the triangle (not null, unaffected)
      v2 - the 3rd vertex of the triangle (not null, unaffected)
      Returns:
      the minimum distance along ray, or FLT_MAX if the ray misses the triangle

    • registerCustomAllocator

      public static void registerCustomAllocator(long allocateVa, long reallocateVa, long freeVa, long alignedAllocateVa, long alignedFreeVa)
      Register the allocation hook to use the specified functions. This must be done before any other Jolt function is called.
      Parameters:
      allocateVa - the virtual address of the desired Allocate function
      reallocateVa - the virtual address of the desired Reallocate function
      freeVa - the virtual address of the desired Free function
      alignedAllocateVa - the virtual address of the desired AlignedAllocate function
      alignedFreeVa - the virtual address of the desired AlignedFree function

    • registerDefaultAllocator

      public static void registerDefaultAllocator()
      Register the allocation hook to use malloc/free. This must be done before any other Jolt function is called. (see Jolt/Core/Memory.cpp)

    • registerHair

      public static void registerHair()
      Register HairSettings with the factory. (see Jolt/RegisterTypes.h)
      See Also:

    • registerTypes

      public static void registerTypes()
      Register all physics types except HairSettings with the factory and install their collision handlers. (see Jolt/RegisterTypes.h)
      See Also:

    • setTraceAllocations

      public static void setTraceAllocations(boolean setting)
      Enable or disable allocation tracing in Debug native libraries.
      Parameters:
      setting - true to enable tracing, false to disable it (default=false)

    • sign

      public static float sign(float input)
      Return the (binary) sign of the specified single-precision value. (see Jolt/Math/Math.h)
      Parameters:
      input - the input value
      Returns:
      -1 if the input is negative, otherwise +1

    • sin

      public static float sin(float angle)
      Return the sine of the specified single-precision angle. (see Jolt/Math/Trigonometry.h)
      Parameters:
      angle - the input angle (in radians)
      Returns:
      the sine ratio

    • square

      public static float square(float value)
      Return the square of the specified single-precision value.
      Parameters:
      value - the input value
      Returns:
      the square

    • square

      public static int square(int value)
      Return the square of the specified integer value.
      Parameters:
      value - the input value
      Returns:
      the square

    • sSetNextCharacterId

      public static void sSetNextCharacterId()
      Set the next available character ID to 1. (see Jolt/Physics/Character/CharacterID.h)

    • sSetNextCharacterId

      public static void sSetNextCharacterId(int nextValue)
      Set the next available character ID to the specified value. (native function: CharacterID::sSetNextCharacterID)
      Parameters:
      nextValue - the desired next ID

    • supportsObjectStream

      public static boolean supportsObjectStream()
      Test whether the native library supports the ObjectStream format. (native macro: JPH_OBJECT_STREAM)
      Returns:
      true if supported, otherwise false

    • tan

      public static float tan(float angle)
      Return the tangent ratio of the specified single-precision angle. (see Jolt/Math/Trigonometry.h)
      Parameters:
      angle - the input angle (in radians)
      Returns:
      the tangent ratio

    • test000

      public static void test000(String... args)
      Execute a test written in native code. Intended for testing only.
      Parameters:
      args - command-line arguments

    • unregisterTypes

      public static void unregisterTypes()
      Unregister all physics types with the factory. (see Jolt/RegisterTypes.h)
      See Also:

    • versionString

      public static String versionString()
      Return the Jolt-JNI version string that's hard-coded into the native library.
      Returns:
      the version string (not null, not empty)