deploy: dbc9db2

javadoc/master/com/jme3/bullet/CollisionSpace.html

@@ -621,7 +621,7 @@ <h3>countSolvers</h3>
 <section class="detail" id="destroy()">
 <h3>destroy</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">destroy</span>()</div>
-<div class="block">Remove all collision objects and physics joints.</div>
+<div class="block">Remove all collision objects and physics joints. Meant to be overridden.</div>
 </section>
 </li>
 <li>

javadoc/master/com/jme3/bullet/collision/PhysicsCollisionObject.html

@@ -423,12 +423,12 @@ <h2>Method Summary</h2>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.jme3.math.Vector3f</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPhysicsLocation(com.jme3.math.Vector3f)" class="member-name-link">getPhysicsLocation</a><wbr>(com.jme3.math.Vector3f&nbsp;storeResult)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Copy the location of the collision object's center to a Vector3f.</div>
+<div class="block">Locate the collision object's center.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.simsilica.mathd.Vec3d</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPhysicsLocationDp(com.simsilica.mathd.Vec3d)" class="member-name-link">getPhysicsLocationDp</a><wbr>(com.simsilica.mathd.Vec3d&nbsp;storeResult)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Copy the location of the collision object's center to a Vec3d.</div>
+<div class="block">Locate the collision object's center in double precision.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.jme3.math.Quaternion</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPhysicsRotation(com.jme3.math.Quaternion)" class="member-name-link">getPhysicsRotation</a><wbr>(com.jme3.math.Quaternion&nbsp;storeResult)</code></div>
@@ -455,7 +455,7 @@ <h2>Method Summary</h2>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRestitution()" class="member-name-link">getRestitution</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Return this object's restitution (bounciness) (native field:
+<div class="block">Return the collision object's restitution (bounciness) (native field:
  m_restitution).</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
@@ -1466,7 +1466,7 @@ <h3>getPhysicsLocation</h3>
 <section class="detail" id="getPhysicsLocation(com.jme3.math.Vector3f)">
 <h3>getPhysicsLocation</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">com.jme3.math.Vector3f</span>&nbsp;<span class="element-name">getPhysicsLocation</span><wbr><span class="parameters">(com.jme3.math.Vector3f&nbsp;storeResult)</span></div>
-<div class="block">Copy the location of the collision object's center to a Vector3f.</div>
+<div class="block">Locate the collision object's center.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>storeResult</code> - storage for the result (modified if not null)</dd>
@@ -1480,7 +1480,7 @@ <h3>getPhysicsLocation</h3>
 <section class="detail" id="getPhysicsLocationDp(com.simsilica.mathd.Vec3d)">
 <h3>getPhysicsLocationDp</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">com.simsilica.mathd.Vec3d</span>&nbsp;<span class="element-name">getPhysicsLocationDp</span><wbr><span class="parameters">(com.simsilica.mathd.Vec3d&nbsp;storeResult)</span></div>
-<div class="block">Copy the location of the collision object's center to a Vec3d.</div>
+<div class="block">Locate the collision object's center in double precision.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>storeResult</code> - storage for the result (modified if not null)</dd>
@@ -1552,7 +1552,7 @@ <h3>getPhysicsRotationMatrixDp</h3>
 <section class="detail" id="getRestitution()">
 <h3>getRestitution</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name">getRestitution</span>()</div>
-<div class="block">Return this object's restitution (bounciness) (native field:
+<div class="block">Return the collision object's restitution (bounciness) (native field:
  m_restitution).
  <p>
  Restitution doesn't affect a PhysicsCharacter or PhysicsGhostObject.</div>

javadoc/master/com/jme3/bullet/collision/shapes/CapsuleCollisionShape.html

@@ -313,7 +313,7 @@ <h3>CapsuleCollisionShape</h3>
 <dd><code>height</code> - the desired height of the cylindrical portion (in shape
  units, &ge;0)</dd>
 <dd><code>axisIndex</code> - which local axis to use for the height: 0&rarr;X,
- 1&rarr;Y, 2&rarr;Z</dd>
+ 1&rarr;Y, 2&rarr;Z (default=1)</dd>
 </dl>
 </section>
 </li>

javadoc/master/com/jme3/bullet/collision/shapes/CollisionShape.html

@@ -221,7 +221,7 @@ <h2>Method Summary</h2>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMargin()" class="member-name-link">getMargin</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Return the collision margin for this shape.</div>
+<div class="block">Return the (copied) collision margin of the shape.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.jme3.math.Vector3f</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScale(com.jme3.math.Vector3f)" class="member-name-link">getScale</a><wbr>(com.jme3.math.Vector3f&nbsp;storeResult)</code></div>
@@ -565,7 +565,7 @@ <h3>getDefaultMargin</h3>
 <section class="detail" id="getMargin()">
 <h3>getMargin</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name">getMargin</span>()</div>
-<div class="block">Return the collision margin for this shape.</div>
+<div class="block">Return the (copied) collision margin of the shape.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the margin thickness (in physics-space units, &ge;0)</dd>

javadoc/master/com/jme3/bullet/collision/shapes/CompoundCollisionShape.html

@@ -254,7 +254,7 @@ <h2>Method Summary</h2>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeChildShape(com.jme3.bullet.collision.shapes.CollisionShape)" class="member-name-link">removeChildShape</a><wbr>(<a href="CollisionShape.html" title="class in com.jme3.bullet.collision.shapes">CollisionShape</a>&nbsp;childShape)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Remove a child CollisionShape from this shape.</div>
+<div class="block">Purge all references to the specified child shape from this shape.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rotate(com.jme3.math.Matrix3f)" class="member-name-link">rotate</a><wbr>(com.jme3.math.Matrix3f&nbsp;rotation)</code></div>
@@ -380,35 +380,35 @@ <h3>addChildShape</h3>
 </section>
 </li>
 <li>
-<section class="detail" id="addChildShape(com.jme3.bullet.collision.shapes.CollisionShape,com.jme3.math.Vector3f)">
+<section class="detail" id="addChildShape(com.jme3.bullet.collision.shapes.CollisionShape,float,float,float)">
 <h3>addChildShape</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addChildShape</span><wbr><span class="parameters">(<a href="CollisionShape.html" title="class in com.jme3.bullet.collision.shapes">CollisionShape</a>&nbsp;childShape,
- com.jme3.math.Vector3f&nbsp;offset)</span></div>
+ float&nbsp;offsetX,
+ float&nbsp;offsetY,
+ float&nbsp;offsetZ)</span></div>
 <div class="block">Add a child shape with the specified local translation.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>childShape</code> - the child shape to add (not null, not a compound shape,
  alias created)</dd>
-<dd><code>offset</code> - the local coordinates of the child shape's origin (not
- null, unaffected)</dd>
+<dd><code>offsetX</code> - the local X coordinate of the child shape's origin</dd>
+<dd><code>offsetY</code> - the local Y coordinate of the child shape's origin</dd>
+<dd><code>offsetZ</code> - the local Z coordinate of the child shape's origin</dd>
 </dl>
 </section>
 </li>
 <li>
-<section class="detail" id="addChildShape(com.jme3.bullet.collision.shapes.CollisionShape,float,float,float)">
+<section class="detail" id="addChildShape(com.jme3.bullet.collision.shapes.CollisionShape,com.jme3.math.Vector3f)">
 <h3>addChildShape</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addChildShape</span><wbr><span class="parameters">(<a href="CollisionShape.html" title="class in com.jme3.bullet.collision.shapes">CollisionShape</a>&nbsp;childShape,
- float&nbsp;offsetX,
- float&nbsp;offsetY,
- float&nbsp;offsetZ)</span></div>
+ com.jme3.math.Vector3f&nbsp;offset)</span></div>
 <div class="block">Add a child shape with the specified local translation.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>childShape</code> - the child shape to add (not null, not a compound shape,
  alias created)</dd>
-<dd><code>offsetX</code> - the local X coordinate of the child shape's origin</dd>
-<dd><code>offsetY</code> - the local Y coordinate of the child shape's origin</dd>
-<dd><code>offsetZ</code> - the local Z coordinate of the child shape's origin</dd>
+<dd><code>offset</code> - the local coordinates of the child shape's origin (not
+ null, unaffected)</dd>
 </dl>
 </section>
 </li>
@@ -557,7 +557,7 @@ <h3>principalAxes</h3>
 <section class="detail" id="removeChildShape(com.jme3.bullet.collision.shapes.CollisionShape)">
 <h3>removeChildShape</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeChildShape</span><wbr><span class="parameters">(<a href="CollisionShape.html" title="class in com.jme3.bullet.collision.shapes">CollisionShape</a>&nbsp;childShape)</span></div>
-<div class="block">Remove a child CollisionShape from this shape.</div>
+<div class="block">Purge all references to the specified child shape from this shape.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>childShape</code> - the collision shape to remove (not null)</dd>

javadoc/master/com/jme3/bullet/collision/shapes/CylinderCollisionShape.html

@@ -148,7 +148,7 @@ <h2>Constructor Summary</h2>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.jme3.math.Vector3f,int)" class="member-name-link">CylinderCollisionShape</a><wbr>(com.jme3.math.Vector3f&nbsp;halfExtents,
  int&nbsp;axisIndex)</code></div>
 <div class="col-last odd-row-color">
-<div class="block">Instantiate a cylinder shape around the specified axis.</div>
+<div class="block">Instantiate a cylinder shape around the specified main (height) axis.</div>
 </div>
 <div class="col-first even-row-color"><code>&nbsp;</code></div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.nio.FloatBuffer,int,int,int)" class="member-name-link">CylinderCollisionShape</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/FloatBuffer.html" title="class or interface in java.nio" class="external-link">FloatBuffer</a>&nbsp;buffer,
@@ -285,8 +285,8 @@ <h3>CylinderCollisionShape</h3>
 <div class="block">Instantiate a cylinder shape around the specified main (height) axis.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
-<dd><code>radius</code> - the desired unscaled radius (&ge;0)</dd>
-<dd><code>height</code> - the desired unscaled height (&ge;0)</dd>
+<dd><code>radius</code> - the desired unscaled radius (in shape units, &ge;0)</dd>
+<dd><code>height</code> - the desired unscaled height (in shape units, &ge;0)</dd>
 <dd><code>axisIndex</code> - which local axis to use for the height: 0&rarr;X,
  1&rarr;Y, 2&rarr;Z (default=2)</dd>
 </dl>
@@ -331,13 +331,13 @@ <h3>CylinderCollisionShape</h3>
 <h3>CylinderCollisionShape</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CylinderCollisionShape</span><wbr><span class="parameters">(com.jme3.math.Vector3f&nbsp;halfExtents,
  int&nbsp;axisIndex)</span></div>
-<div class="block">Instantiate a cylinder shape around the specified axis.</div>
+<div class="block">Instantiate a cylinder shape around the specified main (height) axis.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>halfExtents</code> - the desired unscaled half extents (not null, no
  negative component, unaffected)</dd>
 <dd><code>axisIndex</code> - which local axis to use for the height: 0&rarr;X,
- 1&rarr;Y, 2&rarr;Z</dd>
+ 1&rarr;Y, 2&rarr;Z (default=2)</dd>
 </dl>
 </section>
 </li>
@@ -401,7 +401,8 @@ <h3>unscaledVolume</h3>
 <h3>canScale</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">canScale</span><wbr><span class="parameters">(com.jme3.math.Vector3f&nbsp;scale)</span></div>
 <div class="block">Test whether the specified scale factors can be applied to this shape.
- For cylinder shapes, radial scaling must be uniform.</div>
+ For cylinder shapes, radial scaling must be uniform. The shape is
+ unaffected.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="CollisionShape.html#canScale(com.jme3.math.Vector3f)">canScale</a></code>&nbsp;in class&nbsp;<code><a href="CollisionShape.html" title="class in com.jme3.bullet.collision.shapes">CollisionShape</a></code></dd>

javadoc/master/com/jme3/bullet/collision/shapes/HeightfieldCollisionShape.html

@@ -134,7 +134,7 @@ <h2>Constructor Summary</h2>
 <div class="col-first odd-row-color"><code>&nbsp;</code></div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(float%5B%5D)" class="member-name-link">HeightfieldCollisionShape</a><wbr>(float[]&nbsp;heightmap)</code></div>
 <div class="col-last odd-row-color">
-<div class="block">Instantiate a square shape for the specified height map.</div>
+<div class="block">Instantiate a square shape for the specified array of heights.</div>
 </div>
 <div class="col-first even-row-color"><code>&nbsp;</code></div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(float%5B%5D,com.jme3.math.Vector3f)" class="member-name-link">HeightfieldCollisionShape</a><wbr>(float[]&nbsp;heightmap,
@@ -196,7 +196,7 @@ <h2>Method Summary</h2>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#countMeshVertices()" class="member-name-link">countMeshVertices</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Count how many data points are in the heightfield.</div>
+<div class="block">Count how many heights are in the heightfield.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#countRows()" class="member-name-link">countRows</a>()</code></div>
@@ -274,7 +274,7 @@ <h3>HeightfieldCollisionShape</h3>
 <section class="detail" id="&lt;init&gt;(float[])">
 <h3>HeightfieldCollisionShape</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">HeightfieldCollisionShape</span><wbr><span class="parameters">(float[]&nbsp;heightmap)</span></div>
-<div class="block">Instantiate a square shape for the specified height map.</div>
+<div class="block">Instantiate a square shape for the specified array of heights.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>heightmap</code> - (not null, length&ge;4, length a perfect square,
@@ -379,7 +379,7 @@ <h3>countColumns</h3>
 <section class="detail" id="countMeshVertices()">
 <h3>countMeshVertices</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">countMeshVertices</span>()</div>
-<div class="block">Count how many data points are in the heightfield.</div>
+<div class="block">Count how many heights are in the heightfield.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the count (&ge;4)</dd>