Update several math documentation pages.

Added some info regarding the quaternion object, its applications and the purpose of its functions. Added some info regarding the box2 object and its functions.

Update several math documentation pages.
Added some info regarding the quaternion object, its applications and the purpose of its functions. Added some info regarding the box2 object and its functions.
fcff3438 · Dave Kushner · Dave Kushner · 8034a544 · fcff3438 · fcff3438
隐藏空白更改
内联并排

Showing with 106 addition and 89 deletion

docs/api/math/Box2.html docs/api/math/Box2.html +86 -73

docs/api/math/Quaternion.html docs/api/math/Quaternion.html +20 -16

未找到文件。
--- a/docs/api/math/Box2.html
+++ b/docs/api/math/Box2.html
@@ -9,19 +9,19 @@
 	<body>
 		<h1>[name]</h1>

-		<div class="desc">todo</div>
+		<div class="desc">Represents a boundary box in 2D space.</div>


 		<h2>Constructor</h2>


-		<h3>[name]([page:todo min], [page:todo max])</h3>
+		<h3>[name]([page:Vector2 min], [page:Vector2 max])</h3>
 		<div>
-		min -- todo <br />
-		max -- todo
+		min -- Lower (x, y) boundary of the box.<br />
+		max -- Upper (x, y) boundary of the box.
 		</div>
 		<div>
-		todo
+		Creates a box bounded by min and max. 
 		</div>


@@ -31,186 +31,199 @@

 		<h3>.[page:Vector2 max]</h3>
 		<div>
-		todo
+		Upper (x, y) boundary of this box.
 		</div> 

 		<h3>.[page:Vector2 min]</h3>
 		<div>
-		todo
+		Lower (x, y) boundary of this box.
 		</div> 

 		<h2>Methods</h2>



-		<h3>.set([page:todo min], [page:todo max]) [page:todo]</h3>
+		<h3>.set([page:Vector2 min], [page:Vector2 max]) [page:todo]</h3>
 		<div>
-		min -- todo <br />
-		max -- todo
+		min -- Lower (x, y) boundary of the box. <br />
+		max -- Upper (x, y) boundary of the box.
 		</div>
 		<div>
-		todo
+		Sets the lower and upper (x, y) boundaries of this box.
 		</div>

-		<h3>.expandByPoint([page:todo point]) [page:todo]</h3>
+		<h3>.expandByPoint([page:Vector2 point]) [page:Box2]</h3>
 		<div>
-		point -- todo
+		point -- Point that should be included in the box.
 		</div>
 		<div>
-		todo
+		Expands the boundaries of this box to include *point*.
 		</div>

-		<h3>.clampPoint([page:todo point], [page:todo optionalTarget]) [page:todo]</h3>
+		<h3>.clampPoint([page:Vector2 point], [page:Vector2 optionalTarget]) [page:Vector2]</h3>
 		<div>
-		point -- todo <br />
-		optionalTarget -- todo
+		point -- Position to clamp. <br />
+		optionalTarget -- If specified, the clamped result will be copied here.
 		</div>
 		<div>
-		todo
+		Clamps *point* within the bounds of this box.
 		</div>

-		<h3>.isIntersectionBox([page:todo box]) [page:todo]</h3>
+		<h3>.isIntersectionBox([page:Box2 box]) [page:Boolean]</h3>
 		<div>
-		box -- todo
+		box -- Box to check for intersection against.
 		</div>
 		<div>
-		todo
+		Determines whether or not this box intersects *box*.
 		</div>

-		<h3>.setFromPoints([page:todo points]) [page:todo]</h3>
+		<h3>.setFromPoints([page:Array points]) [page:Box2]</h3>
 		<div>
-		points -- todo
+		points -- Set of points that the resulting box will envelop.
 		</div>
 		<div>
-		todo
+		Sets the upper and lower bounds of this box to include all of the points in *points*.
 		</div>

-		<h3>.size([page:todo optionalTarget]) [page:todo]</h3>
+		<h3>.size([page:Vector2 optionalTarget]) [page:Vector2]</h3>
 		<div>
-		optionalTarget -- todo
+		optionalTarget -- If specified, the result will be copied here.
 		</div>
 		<div>
-		todo
+		Returns the width and height of this box.
 		</div>

-		<h3>.union([page:todo box]) [page:todo]</h3>
+		<h3>.union([page:Box2 box]) [page:Box2]</h3>
 		<div>
-		box -- todo
+		box -- Box that will be unioned with this box.
 		</div>
 		<div>
-		todo
+		Unions this box with *box* setting the upper bound of this box to the greater of the 
+		two boxes' upper bounds and the lower bound of this box to the lesser of the two boxes'
+		lower bounds.
 		</div>

-		<h3>.getParameter([page:todo point]) [page:todo]</h3>
+		<h3>.getParameter([page:Vector2 point]) [page:Vector2]</h3>
 		<div>
-		point -- todo
+		point -- Point to parametrize.
 		</div>
 		<div>
-		todo
+		Returns point as a proportion of this box's width and height.
 		</div>

-		<h3>.expandByScalar([page:todo scalar]) [page:todo]</h3>
+		<h3>.expandByScalar([page:float scalar]) [page:Box2]</h3>
 		<div>
-		scalar -- todo
+		scalar -- Distance to expand.
 		</div>
 		<div>
-		todo
+		Expands each dimension of the box by *scalar*. If negative, the dimensions of the box </br>
+		will be contracted.
 		</div>

-		<h3>.intersect([page:todo box]) [page:todo]</h3>
+		<h3>.intersect([page:Box2 box]) [page:Box2]</h3>
 		<div>
-		box -- todo
+		box -- Box to intersect with.
 		</div>
 		<div>
-		todo
+		Returns the intersection of this and *box*, setting the upper bound of this box to the lesser </br>
+		of the two boxes' upper bounds and the lower bound of this box to the greater of the two boxes' </br>
+		lower bounds.
 		</div>

-		<h3>.containsBox([page:todo box]) [page:todo]</h3>
+		<h3>.containsBox([page:Box2 box]) [page:Boolean]</h3>
 		<div>
-		box -- todo
+		box -- Box to test for inclusion.
 		</div>
 		<div>
-		todo
+		Returns true if this box includes the entirety of *box*. If this and *box* overlap exactly,</br>
+		this function also returns true. 
 		</div>

-		<h3>.translate([page:todo offset]) [page:todo]</h3>
+		<h3>.translate([page:Vector2 offset]) [page:Box2]</h3>
 		<div>
-		offset -- todo
+		offset -- Direction and distance of offset.
 		</div>
 		<div>
-		todo
+		Adds *offset* to both the upper and lower bounds of this box, effectively moving this box </br>
+		*offset* units in 2D space.
 		</div>

-		<h3>.empty() [page:todo]</h3>
+		<h3>.empty() [page:Boolean]</h3>
 		<div>
-		todo
+		Returns true if this box includes zero points within its bounds.</br>
+		Note that a box with equal lower and upper bounds still includes one point, the
+		one both bounds share.
 		</div>

-		<h3>.clone() [page:todo]</h3>
+		<h3>.clone() [page:Box2]</h3>
 		<div>
-		todo
+		Returns a copy of this box.
 		</div>

-		<h3>.equals([page:todo box]) [page:todo]</h3>
+		<h3>.equals([page:Box2 box]) [page:Boolean]</h3>
 		<div>
-		box -- todo
+		box -- Box to compare.
 		</div>
 		<div>
-		todo
+		Returns true if this box and *box* share the same lower and upper bounds.
 		</div>

-		<h3>.expandByVector([page:todo vector]) [page:todo]</h3>
+		<h3>.expandByVector([page:Vector2 vector]) [page:Box2]</h3>
 		<div>
-		vector -- todo
+		vector -- Amount to expand this box in each dimension.
 		</div>
 		<div>
-		todo
+		Expands this box equilaterally by *vector*. The width of this box will be
+		expanded by the x component of *vector* in both directions. The height of 
+		this box will be expanded by the y component of *vector* in both directions.
 		</div>

-		<h3>.copy([page:todo box]) [page:todo]</h3>
+		<h3>.copy([page:Box2 box]) [page:Box2]</h3>
 		<div>
-		box -- todo
+		box -- Box to copy.
 		</div>
 		<div>
-		todo
+		Copies the values of *box* to this box.
 		</div>

-		<h3>.makeEmpty() [page:todo]</h3>
+		<h3>.makeEmpty() [page:Box2]</h3>
 		<div>
-		todo
+		Makes this box empty.
 		</div>

-		<h3>.center([page:todo optionalTarget]) [page:todo]</h3>
+		<h3>.center([page:Vector2 optionalTarget]) [page:Vector2]</h3>
 		<div>
-		optionalTarget -- todo
+		optionalTarget -- If specified, the result will be copied here.
 		</div>
 		<div>
-		todo
+		Returns the center point of this box.
 		</div>

-		<h3>.distanceToPoint([page:todo point]) [page:todo]</h3>
+		<h3>.distanceToPoint([page:Vector2 point]) [page:Float]</h3>
 		<div>
-		point -- todo
+		point -- Point to measure distance to.
 		</div>
 		<div>
-		todo
+		Returns the distance from any edge of this box to the specified point. </br>
+		If the point lies inside of this box, the distance will be 0.
 		</div>

-		<h3>.containsPoint([page:todo point]) [page:todo]</h3>
+		<h3>.containsPoint([page:Vector2 point]) [page:Boolean]</h3>
 		<div>
-		point -- todo
+		point -- Point to check for inclusion.
 		</div>
 		<div>
-		todo
+		Returns true if the specified point lies within the boundaries of this box.
 		</div>

-		<h3>.setFromCenterAndSize([page:todo center], [page:todo size]) [page:todo]</h3>
+		<h3>.setFromCenterAndSize([page:Vector2 center], [page:Vector2 size]) [page:Box2]</h3>
 		<div>
-		center -- todo <br />
-		size -- todo
+		center -- Desired center position of the box. <br />
+		size -- Desired x and y dimensions of the box. 
 		</div>
 		<div>
-		todo
+		Centers this box on *center* and sets this box's width and height to the values specified
+		in *size*.
 		</div>

 		<h2>Source</h2>

--- a/docs/api/math/Quaternion.html
+++ b/docs/api/math/Quaternion.html
@@ -121,44 +121,48 @@
 		</div>


-		<h3>.slerp([page:todo qb], [page:todo t]) [page:todo]</h3>
+		<h3>.slerp([page:Quaternion qb], [page:float t]) [page:Quaternion]</h3>
 		<div>
-		qb -- todo <br />
-		t -- todo
+		qb -- Target quaternion rotation.<br />
+		t -- Normalized [0..1] interpolation factor. 
 		</div>
 		<div>
-		todo
+		Handles the spherical linear interpolation between this quaternion's configuration
+		and that of *qb*. *t* represents how close to the current (0) or target (1) rotation the 
+		result should be. 
 		</div>

-		<h3>.toArray() [page:todo]</h3>
+		<h3>.toArray() [page: Array]</h3>
 		<div>
-		todo
+		Returns the numerical elements of this quaternion in an array of format (x, y, z, w).
 		</div>

-		<h3>.equals([page:todo v]) [page:todo]</h3>
+		<h3>.equals([page:Quaternion v]) [page:Boolean]</h3>
 		<div>
-		v -- todo
+		v -- Quaternion that this quaternion will be compared to.
 		</div>
 		<div>
-		todo
+		Compares each component of *v* to each component of this quaternion to determine if they
+		represent the same rotation.
 		</div>

-		<h3>.lengthSq() [page:todo]</h3>
+		<h3>.lengthSq() [page:Float]</h3>
 		<div>
-		todo
+		Calculates the squared length of the quaternion. 
 		</div>

-		<h3>.fromArray([page:todo array]) [page:todo]</h3>
+		<h3>.fromArray([page:Array array]) [page:Quaternion]</h3>
 		<div>
-		array -- todo
+		array -- Array of format (x, y, z, w) used to construct the quaternion.
 		</div>
 		<div>
-		todo
+		Sets this quaternion's component values from an array.
 		</div>

-		<h3>.conjugate() [page:todo]</h3>
+		<h3>.conjugate() [page:Quaternion]</h3>
 		<div>
-		todo
+		Returns the rotational conjugate of this quaternion. The conjugate of a quaternion
+		represents the same rotation in the opposite direction about the rotational axis.
 		</div>

 		<h2>Source</h2>