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

Class JoltPhysicsObject

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
All Implemented Interfaces:
ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>
Direct Known Subclasses:
AaBox, AaBoxCast, AddConvexRadiusSupport, AddConvexRadiusTab, AdditionalConstraint, Array, BodyActivationListener, BodyCreationSettings, BodyIdArray, BodyIdVector, BodyManagerDrawSettings, BroadPhaseCastResult, CastRayCollector, CastShapeBodyCollector, CastShapeCollector, CharacterBaseSettings, CharacterContactSettings, CharacterRefC, CharacterVirtualRefC, CollidePointCollector, CollidePointResult, CollideSettingsBase, CollideShapeBodyCollector, CollideShapeCollector, CollideShapeResult, CollisionEstimationResult, CollisionGroup, CombineFunction, Contact, ContactListener, ContactManifold, ContactSettings, ConvexHull, CustomCharacterContactListener, CustomPhysicsStepListener, Decomposer, DefaultRandomEngine, Edge, EpaPenetrationDepth, ExtendedUpdateSettings, Face, Geometry, GetTrianglesContext, GroupFilterToIdMap, IdToGroupFilterMap, IdToMaterialMap, IdToShapeMap, IdToSharedSettingsMap, Impulse, IndexedTriangleNoMaterial, InvBind, Joint, JointState, Lod, MassProperties, Mat44, Mat44Array, MaterialToIdMap, MotionProperties, MotorSettings, Mt19937, Mutex, NarrowPhaseStat, NonCopyable, OfStream, OrientedBox, Parameters, PhysicsMaterialRefC, PhysicsScene, PhysicsSettings, PhysicsStepListenerContext, PointConvexSupport, RagdollSettings, RayCast, RayCastBodyCollector, RayCastSettings, RayInvDirection, Ref, Result, RMat44, RodBendTwist, RodStretchShear, RRayCast, RShapeCast, Rtti, SerializableObject, ShapeRefC, ShapeSettingsRefC, ShapeToIdMap, SharedMutexBase, SharedSettingsToIdMap, SkeletalAnimation, Skeleton, SkeletonMapper, SkeletonPose, SkeletonPoseDrawSettings, Skinned, SkinWeight, SoftBodyContactListener, SoftBodyContactSettings, SoftBodyCreationSettings, SoftBodyManifold, SoftBodySharedSettings, SoftBodyVertex, Sphere, SpringSettings, StateRecorderFilter, Stats, StringStream, SubShape, SubShapeIdCreator, SubShapeIdPair, Support, SupportBuffer, TransformedConvexObject, TransformedShape, TransformedShapeCollector, Triangle, TriangleConvexSupport, UniformFloatDistribution, UniformIntDistribution, VehicleAntiRollBar, VehicleDifferentialSettings, VehicleEngineSettings, VehicleStepListener, VehicleTrackSettings, VehicleTransmissionSettings, Vertex, VertexArray, VertexAttributes, Volume
public abstract class JoltPhysicsObject extends Object implements AutoCloseable, ConstJoltPhysicsObject
An abstract class to represent a (native) Jolt Physics object.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    JoltPhysicsObject()
    Instantiate with no containing object and no native object assigned.
    protected
    JoltPhysicsObject(JoltPhysicsObject container, long va)
    Instantiate with the specified container and native object.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Free and unassign the native object if the JVM object owns it.
    int
    compareTo(JoltPhysicsObject other)
    Compare (by virtual address) with another physics object.
    boolean
    equals(Object otherObject)
    Test for type and virtual-address equality with another object.
    protected final JoltPhysicsObject
    getContainingObject()
    Access the containing object, if any.
    final boolean
    hasAssignedNativeObject()
    Test whether a native object is assigned.
    int
    hashCode()
    Return the hash code of the physics object.
    static boolean
    isCleanerStarted()
    Test whether a daemon thread to invoke freeing actions has been started.
    final boolean
    ownsNativeObject()
    Test whether the JVM object owns (is responsible for freeing) its assigned native object.
    protected final void
    setVirtualAddress(long va)
    Assign a native object, assuming there's none already assigned.
    protected final void
    setVirtualAddress(long va, Runnable action)
    Assign a native object (assuming there's none already assigned) and a freeing action.
    static void
    startCleaner()
    Start a daemon thread to process the phantom-reachable objects and invoke freeing actions, unless one has already been started.
    long
    targetVa()
    Return the address of the native object, assuming this is not a counted reference.
    String
    toString()
    Represent the physics object as a String.
    final long
    va()
    Return the virtual address of the assigned native object, assuming one is assigned.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JoltPhysicsObject

      protected JoltPhysicsObject()
      Instantiate with no containing object and no native object assigned.

    • JoltPhysicsObject

      protected JoltPhysicsObject(JoltPhysicsObject container, long va)
      Instantiate with the specified container and native object.
      Parameters:
      container - the containing object, or null if none
      va - the virtual address of the native object to assign (not zero)

  • Method Details

    • isCleanerStarted

      public static boolean isCleanerStarted()
      Test whether a daemon thread to invoke freeing actions has been started.
      Returns:
      true if a thread has been started, otherwise false

    • startCleaner

      public static void startCleaner()
      Start a daemon thread to process the phantom-reachable objects and invoke freeing actions, unless one has already been started.

    • va

      public final long va()
      Return the virtual address of the assigned native object, assuming one is assigned. Both objects are unaffected.
      Returns:
      the virtual address (not zero)

    • getContainingObject

      protected final JoltPhysicsObject getContainingObject()
      Access the containing object, if any.
      Returns:
      the pre-existing instance, or null if none

    • setVirtualAddress

      protected final void setVirtualAddress(long va)
      Assign a native object, assuming there's none already assigned.
      Parameters:
      va - the virtual address of the native object to assign (not zero)

    • setVirtualAddress

      protected final void setVirtualAddress(long va, Runnable action)
      Assign a native object (assuming there's none already assigned) and a freeing action.
      Parameters:
      va - the virtual address of the native object to assign (not zero)
      action - freeing action if the JVM object will own (be responsible for freeing) the native object, or null if not responsible

    • close

      public void close()
      Free and unassign the native object if the JVM object owns it. This can be invoked explicitly or by exiting a try-with-resources block.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface ConstJoltPhysicsObject

    • compareTo

      public int compareTo(JoltPhysicsObject other)
      Compare (by virtual address) with another physics object. The current instance is unaffected.
      Specified by:
      compareTo in interface Comparable<JoltPhysicsObject>
      Parameters:
      other - (not null, unaffected)
      Returns:
      0 if the objects have the same virtual address; negative if this comes before other; positive if this comes after other

    • hasAssignedNativeObject

      public final boolean hasAssignedNativeObject()
      Test whether a native object is assigned. Both objects are unaffected.
      Specified by:
      hasAssignedNativeObject in interface ConstJoltPhysicsObject
      Returns:
      true if one is assigned, otherwise false

    • ownsNativeObject

      public final boolean ownsNativeObject()
      Test whether the JVM object owns (is responsible for freeing) its assigned native object. Both objects are unaffected.
      Specified by:
      ownsNativeObject in interface ConstJoltPhysicsObject
      Returns:
      true if owner, otherwise false

    • targetVa

      public long targetVa()
      Return the address of the native object, assuming this is not a counted reference. No objects are affected.
      Specified by:
      targetVa in interface ConstJoltPhysicsObject
      Returns:
      a virtual address (not zero)

    • equals

      public boolean equals(Object otherObject)
      Test for type and virtual-address equality with another object. The current instance is unaffected.
      Overrides:
      equals in class Object
      Parameters:
      otherObject - the object to compare (unaffected) or null
      Returns:
      true if this and otherObject have the same type and virtual address, otherwise false

    • hashCode

      public int hashCode()
      Return the hash code of the physics object. The object is unaffected.

      Note: operations that alter the virtual address are likely to affect the hash code as well!

      Overrides:
      hashCode in class Object
      Returns:
      a 32-bit value for use in hashing

    • toString

      public String toString()
      Represent the physics object as a String. The physics object is unaffected.
      Overrides:
      toString in class Object
      Returns:
      a descriptive string of text (not null, not empty)