javadoc

src/main/java/com/github/stephengold/joltjni/AaBox.java

@@ -25,7 +25,7 @@ of this software and associated documentation files (the "Software"), to deal
 import com.github.stephengold.joltjni.readonly.Vec3Arg;
 
 /**
- * An axis-aligned box.
+ * An axis-aligned box. (native class: AABox)
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/Body.java

@@ -43,6 +43,8 @@ public class Body extends NonCopyable implements ConstBody {
     /**
      * Instantiate a body with the specified native object assigned but not
      * owned.
+     * <p>
+     * For use in custom contact listeners.
      *
      * @param bodyVa the virtual address of the native object to assign (not
      * zero)

src/main/java/com/github/stephengold/joltjni/BodyId.java

@@ -24,7 +24,8 @@ of this software and associated documentation files (the "Software"), to deal
 import com.github.stephengold.joltjni.readonly.ConstBodyId;
 
 /**
- * Identify a particular {@code Body} to a {@code BodyInterface}.
+ * Identify a particular {@code Body} to a {@code BodyInterface}. (native class:
+ * BodyID)
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/CastRayCollector.java

@@ -22,7 +22,7 @@ of this software and associated documentation files (the "Software"), to deal
 package com.github.stephengold.joltjni;
 
 /**
- * Collect results from a narrowphase raycast.
+ * Collect results from a narrow-phase raycast.
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/CharacterRef.java

@@ -21,10 +21,12 @@ of this software and associated documentation files (the "Software"), to deal
  */
 package com.github.stephengold.joltjni;
 
+import com.github.stephengold.joltjni.Character;
 import com.github.stephengold.joltjni.template.Ref;
 
 /**
- * A counted reference to a {@code Character}.
+ * A counted reference to a {@code Character}. (native class:
+ * {@code Ref<Character>})
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/PhysicsSystem.java

@@ -223,7 +223,8 @@ public AaBox getBounds() {
     }
 
     /**
-     * Access the system's {@code BroadPhaseLayerInterface}.
+     * Access the (application-provided) interface for mapping object layers to
+     * broadphase layers.
      *
      * @return the pre-existing instance, or {@code null} if none
      */
@@ -386,7 +387,8 @@ public int getNumBodies() {
     }
 
     /**
-     * Access the {@code ObjectLayerPairFilter}.
+     * Access the (application-provided) interface for testing whether an object
+     * can collide with a broad-phase layer.
      *
      * @return the pre-existing instance, or {@code null} if none
      */
@@ -395,7 +397,8 @@ public ConstObjectVsBroadPhaseLayerFilter getOvbFilter() {
     }
 
     /**
-     * Access the {@code ObjectLayerPairFilter}.
+     * Access the (application-provided) interface for testing whether 2 objects
+     * can collide, based on their object layers.
      *
      * @return the pre-existing instance, or {@code null} if none
      */

src/main/java/com/github/stephengold/joltjni/RayCastResult.java

@@ -40,6 +40,8 @@ public RayCastResult() {
 
     /**
      * Instantiate with the specified native object assigned but not owned.
+     * <p>
+     * For use in custom collectors.
      *
      * @param castResultVa the virtual address of the native object to assign
      * (not zero)

src/main/java/com/github/stephengold/joltjni/ShapeRef.java

@@ -24,7 +24,7 @@ of this software and associated documentation files (the "Software"), to deal
 import com.github.stephengold.joltjni.template.Ref;
 
 /**
- * A counted reference to a {@code Shape}.
+ * A counted reference to a {@code Shape}. (native class: {@code Ref<Shape>})
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/ShapeResult.java

@@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
 package com.github.stephengold.joltjni;
 
 /**
- * Either an error or a {@code ShapeRefC}.
+ * Either an error or a {@code ShapeRefC}. (native class:
+ * {@code Result<Ref<Shape>>})
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/ShapeSettingsRef.java

@@ -24,7 +24,8 @@ of this software and associated documentation files (the "Software"), to deal
 import com.github.stephengold.joltjni.template.Ref;
 
 /**
- * A counted reference to a {@code ShapeSettings}.
+ * A counted reference to a {@code ShapeSettings}. (native class:
+ * {@code Ref<ShapeSettings>})
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/SkeletonRef.java

@@ -24,7 +24,8 @@ of this software and associated documentation files (the "Software"), to deal
 import com.github.stephengold.joltjni.template.Ref;
 
 /**
- * A counted reference to a {@code Skeleton}.
+ * A counted reference to a {@code Skeleton}. (native class:
+ * {@code Ref<Skeleton>})
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/SubShapeId.java

@@ -25,7 +25,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * Identify an element (typically a triangle or other primitive type) in a
- * compound shape.
+ * compound shape. (native class: SubShapeID)
  *
  * @author Stephen Gold [email protected]
  */