Skip to content

Commit b49251b

Browse files
yaustarsteveny-sc
andauthored
Updated JS Docs for bounding box and sphere (playcanvas#3387)
Co-authored-by: Steven Yau <syau@snapchat.com>
1 parent 70d5a11 commit b49251b

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

src/shape/bounding-box.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const tmpVecE = new Vec3();
1212
* @description Create a new axis-aligned bounding box.
1313
* @classdesc Axis-Aligned Bounding Box.
1414
* @param {Vec3} [center] - Center of box. The constructor takes a reference of this parameter.
15-
* @param {Vec3} [halfExtents] - Half the distance across the box in each axis. The constructor takes a reference of this parameter.
15+
* @param {Vec3} [halfExtents] - Half the distance across the box in each axis. The constructor takes a reference of this parameter. Defaults to 0.5 on each axis.
1616
* @property {Vec3} center Center of box.
1717
* @property {Vec3} halfExtents Half the distance across the box in each axis.
1818
*/

src/shape/bounding-sphere.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ const tmpVecB = new Vec3();
1313
* var sphere = new pc.BoundingSphere();
1414
* @param {Vec3} [center] - The world space coordinate marking the center of the sphere. The constructor takes a reference of this parameter.
1515
* @param {number} [radius] - The radius of the bounding sphere. Defaults to 0.5.
16+
* @property {Vec3} center Center of sphere.
17+
* @property {number} radius The radius of the bounding sphere.
1618
*/
1719
class BoundingSphere {
1820
constructor(center = new Vec3(), radius = 0.5) {

0 commit comments

Comments
 (0)