Skip to content

Commit

Permalink
PhysicsCollisionEvent: correct the javadoc per issue #45
Browse files Browse the repository at this point in the history
  • Loading branch information
stephengold committed Jan 13, 2025
1 parent 73fac5b commit aaf778b
Showing 1 changed file with 18 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -259,12 +259,14 @@ public int getFlags() {
}

/**
* Return the triangle index in the shape of object A at the point of
* contact (native field: m_index0).
* Return the triangle index in the shape of object 0 at the point of
* contact (native field: m_index0). Object 0 could be object A, or it could
* be object B.
* <p>
* If shape is convex, the index is undefined.
* If the shape is convex, the index is undefined.
* <p>
* If shape is a CompoundCollisionShape, the index identifies a child shape.
* If the shape is a CompoundCollisionShape, the index identifies a child
* shape.
* <p>
* If the shape is a GImpactCollisionShape or MeshCollisionShape, the index
* identifies a triangle in an IndexedMesh.
Expand All @@ -283,12 +285,14 @@ public int getIndex0() {
}

/**
* Return the triangle index in the shape of object B at the point of
* contact (native field: m_index1).
* Return the triangle index in the shape of object 1 at the point of
* contact (native field: m_index1). Object 1 could be object A, or it could
* be object B.
* <p>
* If shape is convex, the index is undefined.
* If the shape is convex, the index is undefined.
* <p>
* If shape is a CompoundCollisionShape, the index identifies a child shape.
* If the shape is a CompoundCollisionShape, the index identifies a child
* shape.
* <p>
* If the shape is a GImpactCollisionShape or MeshCollisionShape, the index
* identifies a triangle in an IndexedMesh.
Expand Down Expand Up @@ -409,8 +413,9 @@ public Vector3f getNormalWorldOnB(Vector3f storeResult) {
}

/**
* Return the part index in the shape of object A at the point of contact
* (native field: m_partId0).
* Return the part index in the shape of object 0 at the point of contact
* (native field: m_partId0). Object 0 could be object A, or it could be
* object B.
* <p>
* If the shape is compound or convex, the index is undefined.
* <p>
Expand All @@ -430,8 +435,9 @@ public int getPartId0() {
}

/**
* Return the part index in the shape of object B at the point of contact
* (native field: m_partId1).
* Return the part index in the shape of object 1 at the point of contact
* (native field: m_partId1). Object 1 could be object A, or it could be
* object B.
* <p>
* If the shape is compound or convex, the index is undefined.
* <p>
Expand Down

0 comments on commit aaf778b

Please sign in to comment.