javadoc

Author: stephengold

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

@@ -517,7 +517,8 @@ public float getHitReductionCosMaxAngle() {
     }
 
     /**
-     * Return the character's ID. The character is unaffected.
+     * Return the character's ID. The character is unaffected. (native method:
+     * GetID)
      *
      * @return a {@code CharacterId} value
      */

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

@@ -518,7 +518,8 @@ public float getHitReductionCosMaxAngle() {
     }
 
     /**
-     * Return the character's ID. The character is unaffected.
+     * Return the character's ID. The character is unaffected. (native method:
+     * GetID)
      *
      * @return a {@code CharacterId} value
      */
@@ -531,7 +532,8 @@ public int getId() {
     }
 
     /**
-     * Return the ID of the inner body. The character is unaffected.
+     * Return the ID of the inner body. The character is unaffected. (native
+     * method: GetInnerBodyID)
      *
      * @return the {@code BodyID} value
      */

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

@@ -107,7 +107,7 @@ public void setGroupFilter(GroupFilter filter) {
     }
 
     /**
-     * Alter the main group ID.
+     * Alter the main group ID. (native method: SetGroupID)
      *
      * @param id the desired ID (default=cInvalidGroup)
      */
@@ -117,7 +117,7 @@ public void setGroupId(int id) {
     }
 
     /**
-     * Alter the sub-group ID.
+     * Alter the sub-group ID. (native method: SetSubGroupID)
      *
      * @param id the desired ID (default=cInvalidSubGroup)
      */
@@ -149,9 +149,10 @@ public ConstGroupFilter getGroupFilter() {
     }
 
     /**
-     * Return the main group ID. The group is unaffected.
+     * Return the main group ID. The group is unaffected. (native method:
+     * GetGroupID)
      *
-     * @return the ID value or {@code cInvalidGroup}
+     * @return the {@code GroupID} value
      */
     @Override
     public int getGroupId() {
@@ -162,9 +163,10 @@ public int getGroupId() {
     }
 
     /**
-     * Return the sub-group ID. The group is unaffected.
+     * Return the sub-group ID. The group is unaffected. (native method:
+     * GetSubGroupID)
      *
-     * @return the ID value or {@code cInvalidSubGroup}
+     * @return the {@code SubGroupID} value
      */
     @Override
     public int getSubGroupId() {

src/main/java/com/github/stephengold/joltjni/readonly/ConstBody.java

@@ -141,7 +141,7 @@ public interface ConstBody extends ConstJoltPhysicsObject {
      * Return the body's ID for use with {@code BodyInterface}. The body is
      * unaffected.
      *
-     * @return the ID value
+     * @return the {@code BodyID} value
      */
     int getId();
 

src/main/java/com/github/stephengold/joltjni/readonly/ConstCharacter.java

@@ -41,7 +41,7 @@ public interface ConstCharacter extends ConstCharacterBase {
      * Return the ID of the body associated with this character. The character
      * is unaffected.
      *
-     * @return the ID value
+     * @return the {@code BodyID} value
      */
     int getBodyId();
 
@@ -118,20 +118,20 @@ public interface ConstCharacter extends ConstCharacterBase {
      * Copy the position of the associated body using the locking body
      * interface. The character is unaffected.
      *
-     * @param storeLocation the desired location (in system coordinates, not
-     * null, unaffected)
-     * @param storeOrientation the desired orientation (in system coordinates,
-     * not null, unaffected)
+     * @param storeLocation storage for the location (in system coordinates, not
+     * null, modified)
+     * @param storeOrientation storage for the orientation (in system
+     * coordinates, not null, modified)
      */
     void getPositionAndRotation(RVec3 storeLocation, Quat storeOrientation);
 
     /**
      * Copy the position of the associated body. The character is unaffected.
      *
-     * @param storeLocation the desired location (in system coordinates, not
-     * null, unaffected)
-     * @param storeOrientation the desired orientation (in system coordinates,
-     * not null, unaffected)
+     * @param storeLocation storage for the location (in system coordinates, not
+     * null, modified)
+     * @param storeOrientation storage for the orientation (in system
+     * coordinates, not null, modified)
      * @param lockBodies {@code true} → use the locking body interface,
      * {@code false} → use the non-locking body interface (default=true)
      */

src/main/java/com/github/stephengold/joltjni/readonly/ConstCharacterVirtual.java

@@ -116,7 +116,7 @@ public interface ConstCharacterVirtual extends ConstCharacterBase {
     /**
      * Return the ID of the inner body. The character is unaffected.
      *
-     * @return the ID value
+     * @return the {@code BodyID} value
      */
     int getInnerBodyId();
 

src/main/java/com/github/stephengold/joltjni/readonly/ConstCollisionGroup.java

@@ -41,14 +41,14 @@ public interface ConstCollisionGroup extends ConstJoltPhysicsObject {
     /**
      * Return the main group ID. The group is unaffected.
      *
-     * @return the ID value or {@code cInvalidGroup}
+     * @return the {@code GroupID} value
      */
     int getGroupId();
 
     /**
      * Return the sub-group ID. The group is unaffected.
      *
-     * @return the ID value or {@code cInvalidSubGroup}
+     * @return the {@code SubGroupID} value
      */
     int getSubGroupId();
 }