Browse Source

Merge pull request #19048 from EthanHermsey/vector-doc

'The vector', 'This vector', 'A vector'
Mr.doob 5 years ago
parent
commit
3117260a22

+ 11 - 11
docs/api/en/math/Vector2.html

@@ -53,8 +53,8 @@
 
 		<h3>[name]( [param:Float x], [param:Float y] )</h3>
 		<p>
-		[page:Float x] - the x value of the vector. Default is *0*.<br />
-		[page:Float y] -  the y value of the vector. Default is *0*.<br /><br />
+		[page:Float x] - the x value of this vector. Default is *0*.<br />
+		[page:Float y] -  the y value of this vector. Default is *0*.<br /><br />
 
 		Creates a new [name].
 		</p>
@@ -99,7 +99,7 @@
 
 		<h3>[method:this ceil]()</h3>
 		<p>
-		The [page:.x x] and [page:.y y] components of the vector are rounded up to the nearest integer value.
+		The [page:.x x] and [page:.y y] components of this vector are rounded up to the nearest integer value.
 		</p>
 
 		<h3>[method:this clamp]( [param:Vector2 min], [param:Vector2 max] )</h3>
@@ -180,7 +180,7 @@
 		<p>Checks for strict equality of this vector and [page:Vector2 v].</p>
 
 		<h3>[method:this floor]()</h3>
-		<p>The components of the vector are rounded down to the nearest integer value.</p>
+		<p>The components of this vector are rounded down to the nearest integer value.</p>
 
 		<h3>[method:this fromArray]( [param:Array array], [param:Integer offset] )</h3>
 		<p>
@@ -247,7 +247,7 @@
 
 		<h3>[method:this normalize]()</h3>
 		<p>
-		Converts this vector to a [link:https://en.wikipedia.org/wiki/Unit_vector unit vector] - that is, sets it equal to the vector with the same direction
+		Converts this vector to a [link:https://en.wikipedia.org/wiki/Unit_vector unit vector] - that is, sets it equal to a vector with the same direction
 		as this one, but [page:.length length] 1.
 		</p>
 
@@ -275,15 +275,15 @@
 			[page:Vector2 center] - the point around which to rotate.<br />
 			[page:float angle] - the angle to rotate, in radians.<br /><br />
 
-			Rotates the vector around [page:Vector2 center] by [page:float angle] radians.
+			Rotates this vector around [page:Vector2 center] by [page:float angle] radians.
 		</p>
 
 		<h3>[method:this round]()</h3>
-		<p>The components of the vector are rounded to the nearest integer value.</p>
+		<p>The components of this vector are rounded to the nearest integer value.</p>
 
 		<h3>[method:this roundToZero]()</h3>
 		<p>
-		The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.
+		The components of this vector are rounded towards zero (up if negative, down if positive) to an integer value.
 		</p>
 
 		<h3>[method:this set]( [param:Float x], [param:Float y] )</h3>
@@ -300,7 +300,7 @@
 
 		<h3>[method:this setLength]( [param:Float l] )</h3>
 		<p>
-		Sets this vector to the vector with the same direction as this one, but [page:.length length]
+		Sets this vector to a vector with the same direction as this one, but [page:.length length]
 		[page:Float l].
 		</p>
 
@@ -326,7 +326,7 @@
 
 		<h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
 		<p>
-		[page:Array array] - (optional) array to store the vector to. If this is not provided, a new array will be created.<br />
+		[page:Array array] - (optional) array to store this vector to. If this is not provided, a new array will be created.<br />
 		[page:Integer offset] - (optional) optional offset into the array.<br /><br />
 
 		Returns an array [x, y], or copies x and y into the provided [page:Array array].
@@ -334,7 +334,7 @@
 
 		<h3>[method:this random]()</h3>
 		<p>
-			Sets the x and y components of the vector to a random value [0-1].
+			Sets the x and y components of this vector to a random value [0-1].
 		</p>
 
 		<h2>Source</h2>

+ 12 - 12
docs/api/en/math/Vector3.html

@@ -53,9 +53,9 @@
 
 		<h3>[name]( [param:Float x], [param:Float y], [param:Float z] )</h3>
 		<p>
-		[page:Float x] - the x value of the vector. Default is *0*.<br />
-		[page:Float y] -  the y value of the vector. Default is *0*.<br />
-		[page:Float z] - the z value of the vector. Default is *0*.<br /><br />
+		[page:Float x] - the x value of this vector. Default is *0*.<br />
+		[page:Float y] -  the y value of this vector. Default is *0*.<br />
+		[page:Float z] - the z value of this vector. Default is *0*.<br /><br />
 
 		Creates a new [name].
 		</p>
@@ -122,7 +122,7 @@
 
 		<h3>[method:this ceil]()</h3>
 		<p>
-		The [page:.x x], [page:.y y] and [page:.z z] components of the vector are rounded up to the nearest integer value.
+		The [page:.x x], [page:.y y] and [page:.z z] components of this vector are rounded up to the nearest integer value.
 		</p>
 
 		<h3>[method:this clamp]( [param:Vector3 min], [param:Vector3 max] )</h3>
@@ -207,7 +207,7 @@
 		<p>Checks for strict equality of this vector and [page:Vector3 v].</p>
 
 		<h3>[method:this floor]()</h3>
-		<p>The components of the vector are rounded down to the nearest integer value.</p>
+		<p>The components of this vector are rounded down to the nearest integer value.</p>
 
 		<h3>[method:this fromArray]( [param:Array array], [param:Integer offset] )</h3>
 		<p>
@@ -297,7 +297,7 @@
 
 		<h3>[method:this normalize]()</h3>
 		<p>
-		Convert this vector to a [link:https://en.wikipedia.org/wiki/Unit_vector unit vector] - that is, sets it equal to the vector with the same direction
+		Convert this vector to a [link:https://en.wikipedia.org/wiki/Unit_vector unit vector] - that is, sets it equal to a vector with the same direction
 		as this one, but [page:.length length] 1.
 		</p>
 
@@ -323,16 +323,16 @@
 		<p>
 		[page:Vector3 normal] - the normal to the reflecting plane<br /><br />
 
-		Reflect the vector off of plane orthogonal to [page:Vector3 normal]. Normal is assumed to
+		Reflect this vector off of plane orthogonal to [page:Vector3 normal]. Normal is assumed to
 		have unit length.
 		</p>
 
 		<h3>[method:this round]()</h3>
-		<p>The components of the vector are rounded to the nearest integer value.</p>
+		<p>The components of this vector are rounded to the nearest integer value.</p>
 
 		<h3>[method:this roundToZero]()</h3>
 		<p>
-		The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.
+		The components of this vector are rounded towards zero (up if negative, down if positive) to an integer value.
 		</p>
 
 		<h3>[method:this set]( [param:Float x], [param:Float y], [param:Float z] )</h3>
@@ -388,7 +388,7 @@
 
 		<h3>[method:this setLength]( [param:Float l] )</h3>
 		<p>
-		Set this vector to the vector with the same direction as this one, but [page:.length length]
+		Set this vector to a vector with the same direction as this one, but [page:.length length]
 		[page:Float l].
 		</p>
 
@@ -417,7 +417,7 @@
 
 		<h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
 		<p>
-		[page:Array array] - (optional) array to store the vector to. If this is not provided
+		[page:Array array] - (optional) array to store this vector to. If this is not provided
 		a new array will be created.<br />
 		[page:Integer offset] - (optional) optional offset into the array.<br /><br />
 
@@ -439,7 +439,7 @@
 
 		<h3>[method:this random]()</h3>
 		<p>
-			Sets the x, y and z components of the vector to a random value [0-1].
+			Sets the x, y and z components of this vector to a random value [0-1].
 		</p>
 
 		<h2>Source</h2>

+ 12 - 12
docs/api/en/math/Vector4.html

@@ -52,10 +52,10 @@
 
 		<h3>[name]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
 		<p>
-		[page:Float x] - the x value of the vector. Default is *0*.<br />
-		[page:Float y] -  the y value of the vector. Default is *0*.<br />
-		[page:Float z] - the z value of the vector. Default is *0*.<br />
-		[page:Float w] - the w value of the vector. Default is *1*.<br /><br />
+		[page:Float x] - the x value of this vector. Default is *0*.<br />
+		[page:Float y] -  the y value of this vector. Default is *0*.<br />
+		[page:Float z] - the z value of this vector. Default is *0*.<br />
+		[page:Float w] - the w value of this vector. Default is *1*.<br /><br />
 
 		Creates a new [name].
 		</p>
@@ -99,7 +99,7 @@
 
 		<h3>[method:this ceil]()</h3>
 		<p>
-		The [page:.x x], [page:.y y], [page:.z z] and [page:.w w] components of the vector are rounded up to the nearest integer value.
+		The [page:.x x], [page:.y y], [page:.z z] and [page:.w w] components of this vector are rounded up to the nearest integer value.
 		</p>
 
 		<h3>[method:this clamp]( [param:Vector4 min], [param:Vector4 max] )</h3>
@@ -156,7 +156,7 @@
 		<p>Checks for strict equality of this vector and [page:Vector4 v].</p>
 
 		<h3>[method:this floor]()</h3>
-		<p>The components of the vector are rounded down to the nearest integer value.</p>
+		<p>The components of this vector are rounded down to the nearest integer value.</p>
 
 		<h3>[method:this fromArray]( [param:Array array], [param:Integer offset] )</h3>
 		<p>
@@ -226,7 +226,7 @@
 
 		<h3>[method:this normalize]()</h3>
 		<p>
-		Converts this vector to a [link:https://en.wikipedia.org/wiki/Unit_vector unit vector] - that is, sets it equal to the vector with the same direction
+		Converts this vector to a [link:https://en.wikipedia.org/wiki/Unit_vector unit vector] - that is, sets it equal to a vector with the same direction
 		as this one, but [page:.length length] 1.
 		</p>
 
@@ -246,11 +246,11 @@
 		<p>Multiplies this vector by scalar [page:Float s].</p>
 
 		<h3>[method:this round]()</h3>
-		<p>The components of the vector are rounded to the nearest integer value.</p>
+		<p>The components of this vector are rounded to the nearest integer value.</p>
 
 		<h3>[method:this roundToZero]()</h3>
 		<p>
-		The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.
+		The components of this vector are rounded towards zero (up if negative, down if positive) to an integer value.
 		</p>
 
 		<h3>[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
@@ -285,7 +285,7 @@
 
 		<h3>[method:this setLength]( [param:Float l] )</h3>
 		<p>
-		Sets this vector to the vector with the same direction as this one, but [page:.length length]
+		Sets this vector to a vector with the same direction as this one, but [page:.length length]
 		[page:Float l].
 		</p>
 
@@ -317,7 +317,7 @@
 
 		<h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
 		<p>
-		[page:Array array] - (optional) array to store the vector to. If this is not provided, a new array will be created.<br />
+		[page:Array array] - (optional) array to store this vector to. If this is not provided, a new array will be created.<br />
 		[page:Integer offset] - (optional) optional offset into the array.<br /><br />
 
 		Returns an array [x, y, z, w], or copies x, y, z and w into the provided [page:Array array].
@@ -325,7 +325,7 @@
 
 		<h3>[method:this random]()</h3>
 		<p>
-			Sets the x, y, z and w components of the vector to a random value [0-1].
+			Sets the x, y, z and w components of this vector to a random value [0-1].
 		</p>
 
 		<h2>Source</h2>

+ 1 - 1
docs/api/zh/math/Vector2.html

@@ -335,7 +335,7 @@
 
 		<h3>[method:this random]()</h3>
 		<p>
-			Sets the x and y components of the vector to a random value [0-1].
+			Sets the x and y components of this vector to a random value [0-1].
 		</p>
 
 		<h2>源代码</h2>

+ 2 - 2
docs/api/zh/math/Vector3.html

@@ -318,7 +318,7 @@
 		<p>
 		[page:Vector3 normal] - the normal to the reflecting plane<br /><br />
 
-		Reflect the vector off of plane orthogonal to [page:Vector3 normal]. Normal is assumed to
+		Reflect this vector off of plane orthogonal to [page:Vector3 normal]. Normal is assumed to
 		have unit length.
 		</p>
 
@@ -428,7 +428,7 @@
 
 		<h3>[method:this random]()</h3>
 		<p>
-			Sets the x, y and z components of the vector to a random value [0-1].
+			Sets the x, y and z components of this vector to a random value [0-1].
 		</p>
 
 		<h2>源代码</h2>

+ 1 - 1
docs/api/zh/math/Vector4.html

@@ -324,7 +324,7 @@
 
 		<h3>[method:this random]()</h3>
 		<p>
-			Sets the x, y, z and w components of the vector to a random value [0-1].
+			Sets the x, y, z and w components of this vector to a random value [0-1].
 		</p>
 
 		<h2>源代码</h2>