123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8" />
- <base href="../../" />
- <script src="list.js"></script>
- <script src="page.js"></script>
- <link type="text/css" rel="stylesheet" href="page.css" />
- </head>
- <body>
- <h1>[name]</h1>
- <div class="desc">4D vector.</div>
- <h2>Constructor</h2>
- <h3>[name]( [page:Float x], [page:Float y], [page:Float z], [page:Float w] )</h3>
- <div>
- x -- [page:Float] <br />
- y -- [page:Float] <br />
- z -- [page:Float] <br />
- w -- [page:Float]
- </div>
- <h2>Properties</h2>
- <h3>[property:Float x]</h3>
- <h3>[property:Float y]</h3>
- <h3>[property:Float z]</h3>
- <h3>[property:Float w]</h3>
- <h2>Methods</h2>
- <h3>[method:Vector4 set]( [page:Float x], [page:Float y], [page:Float z], [page:Float w] ) [page:Vector4 this]</h3>
- <div>
- Sets value of this vector.
- </div>
- <h3>[method:Vector4 setX]( [page:Float x] ) [page:Vector4 this]</h3>
- <div>
- x -- [page:Float]
- </div>
- <div>
- Sets the x component of the vector.
- </div>
- <h3>[method:Vector4 setY]( [page:Float y] ) [page:Vector4 this]</h3>
- <div>
- y -- [page:Float]
- </div>
- <div>
- Sets the y component of the vector.
- </div>
- <h3>[method:Vector4 setZ]( [page:Float z] ) [page:Vector4 this]</h3>
- <div>
- z -- [page:Float]
- </div>
- <div>
- Sets the z component of the vector.
- </div>
- <h3>[method:Vector4 setW]( [page:Float w] ) [page:Vector4 this]</h3>
- <div>
- w -- [page:Float]
- </div>
- <div>
- Sets the w component of the vector.
- </div>
- <h3>[method:Vector4 setScalar]( [page:Float scalar] ) [page:Vector4 this]</h3>
- <div>
- scalar -- [page:Float]
- </div>
- <div>
- set all component values of this vector to *scalar*.
- </div>
- <h3>[method:Vector4 copy]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- Copies value of *v* to this vector.
- </div>
- <h3>[method:Vector4 fromArray]( [page:Array array] ) [page:Vector4 this]</h3>
- <div>
- array -- The source array in the form [x, y, z, w]. <br />
- offset -- An optional offset into the array.
- </div>
- <div>
- Sets the vector's components based on an array formatted like [x, y, z, w]
- </div>
- <h3>[method:Vector4 add]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- Adds *v* to this vector.
- </div>
- <h3>[method:Vector4 addVectors]( [page:Vector4 a], [page:Vector4 b] ) [page:Vector4 this]</h3>
- <div>
- Sets this vector to *a + b*.
- </div>
- <h3>[method:Vector4 addScaledVector]( [page:Vector4 v], [page:Float s] ) [page:Vector4 this]</h3>
- <div>
- Adds the multiple of v and s to this vector.
- </div>
- <h3>[method:Vector4 sub]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- Subtracts *v* from this vector.
- </div>
- <h3>[method:Vector4 subVectors]( [page:Vector4 a], [page:Vector4 b] ) [page:Vector4 this]</h3>
- <div>
- Sets this vector to *a - b*.
- </div>
- <h3>[method:Vector4 multiplyScalar]( [page:Float s] ) [page:Vector4 this]</h3>
- <div>
- Multiplies this vector by scalar *s*.
- </div>
- <h3>[method:Vector4 divideScalar]( [page:Float s] ) [page:Vector4 this]</h3>
- <div>
- Divides this vector by scalar *s*.<br />
- Set vector to *( 0, 0, 0 )* if *s == 0*.
- </div>
- <h3>[method:Vector4 negate]() [page:Vector4 this]</h3>
- <div>
- Inverts this vector.
- </div>
- <h3>[method:Float dot]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- Computes dot product of this vector and *v*.
- </div>
- <h3>[method:Float lengthSq]() [page:Vector4 this]</h3>
- <div>
- Computes the squared length of this vector.
- </div>
- <h3>[method:Float length]() [page:Vector4 this]</h3>
- <div>
- Computes the length of this vector.
- </div>
- <h3>[method:Float lengthManhattan]() [page:Vector4 this]</h3>
- <div>
- Computes the Manhattan length of this vector.<br />
- [link:http://en.wikipedia.org/wiki/Taxicab_geometry]
- </div>
- <h3>[method:Vector4 normalize]() [page:Vector4 this]</h3>
- <div>
- Normalizes this vector.
- </div>
- <h3>[method:Vector4 setLength]( [page:Float l] ) [page:Vector4 this]</h3>
- <div>
- Normalizes this vector and multiplies it by *l*.
- </div>
- <h3>[method:Vector4 lerp]( [page:Vector4 v], [page:Float alpha] ) [page:Vector4 this]</h3>
- <div>
- Linearly interpolate between this vector and *v* with *alpha* factor.
- </div>
- <h3>[method:Vector4 lerpVectors]( [page:Vector4 v1], [page:Vector4 v2], [page:Float alpha] ) [page:Vector4 this]</h3>
- <div>
- Sets this vector to be the vector linearly interpolated between *v1* and *v2* with *alpha* factor.
- </div>
- <h3>[method:Vector4 clamp]( [page:Vector4 min], [page:Vector4 max] ) [page:Vector4 this]</h3>
- <div>
- min -- [page:Vector4] <br />
- max -- [page:Vector4]
- </div>
- <div>
- If this vector's x, y, z, or w value is greater than the max vector's x, y, z, or w value, it is replaced by the corresponding value.<br/><br/>
- If this vector's x, y, z, or w value is less than the min vector's x, y, z, or w value, it is replaced by the corresponding value.
- </div>
- <h3>[method:Vector4 clampScalar]( [page:Float min], [page:Float max] ) [page:Vector4 this]</h3>
- <div>
- min -- [page:Float] the minimum value the components will be clamped to <br />
- max -- [page:Float] the maximum value the components will be clamped to
- </div>
- <div>
- If this vector's x, y, z or w values are greater than the max value, they are replaced by the max value. <br /><br />
- If this vector's x, y, z or w values are less than the min value, they are replaced by the min value.
- </div>
- <h3>[method:Vector4 floor]() [page:Vector4 this]</h3>
- <div>
- The components of the vector are rounded downwards (towards negative infinity) to an integer value.
- </div>
- <h3>[method:Vector4 ceil]() [page:Vector4 this]</h3>
- <div>
- The components of the vector are rounded upwards (towards positive infinity) to an integer value.
- </div>
- <h3>[method:Vector4 round]() [page:Vector4 this]</h3>
- <div>
- The components of the vector are rounded towards the nearest integer value.
- </div>
- <h3>[method:Vector4 roundToZero]() [page:Vector4 this]</h3>
- <div>
- The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.
- </div>
- <h3>[method:Vector4 applyMatrix4]( [page:Matrix4 m] ) [page:Vector4 this]</h3>
- <div>
- m -- [page:Matrix4]
- </div>
- <div>
- Transforms the vector by the matrix.
- </div>
- <h3>[method:Vector4 min]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- v -- [page:Vector4]
- </div>
- <div>
- If this vector's x, y, z, or w value is greater than vector v's x, y, z, or w value, that value is replaced by the corresponding vector v value.
- </div>
- <h3>[method:Vector4 max]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- v -- [page:Vector4]
- </div>
- <div>
- If this vector's x, y, z, or w value is less than vector v's x, y, z, or w value, that value is replaced by the corresponding vector v value.
- </div>
- <h3>[method:Vector4 addScalar]( [page:Float s] ) [page:Vector4 this]</h3>
- <div>
- s -- [page:Float]
- </div>
- <div>
- Adds a scalar value to all of the vector's components.
- </div>
- <h3>[method:Boolean equals]( [page:Vector4 v] ) [page:Vector4 this]</h3>
- <div>
- v -- [page:Vector4]
- </div>
- <div>
- Checks to see if this vector matches vector v.
- </div>
- <h3>[method:Vector4 setAxisAngleFromRotationMatrix]( [page:Matrix4 m] ) [page:Vector4 this]</h3>
- <div>
- m -- [page:Matrix4]
- </div>
- <div>
- Sets this Vector4 to the computed <a href='http://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation' target='_blank'>axis-angle representation</a> of the rotation defined by Matrix4 m. Assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).<br/><br/>
- The axis is stored in components (x, y, z) of the vector, and the rotation in radians is stored in component w
- </div>
- <h3>[method:Vector4 setAxisAngleFromQuaternion]( [page:Quaternion q] ) [page:Vector4 this]</h3>
- <div>
- q -- [page:Quaternion]
- </div>
- <div>
- Sets this Vector4 to the computed <a href='http://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation' target='_blank'>axis-angle representation</a> of the rotation defined by Quaternion q.<br/><br/>
- The axis is stored in components (x, y, z) of the vector, and the rotation in radians is stored in component w
- </div>
- <h3>[method:Float getComponent]( [page:Integer index] ) [page:Vector4 this]</h3>
- <div>
- index -- [page:Integer] 0, 1, 2, or 3
- </div>
- <div>
- Returns the value of the vector component x, y, or z by an index.<br/><br/>
- Index 0: x<br/>
- Index 1: y<br/>
- Index 2: z<br/>
- Index 3: w<br/>
- </div>
- <h3>[method:null setComponent]( [page:Integer index], [page:Float value] ) [page:Vector4 this]</h3>
- <div>
- index -- [page:Integer] 0 - 3 <br />
- value -- [page:Float]
- </div>
- <div>
- Sets the value of the vector component x, y, or z by an index.<br/><br/>
- Index 0: x<br/>
- Index 1: y<br/>
- Index 2: z<br/>
- Index 3: w<br/>
- </div>
- <h3>[method:Vector4 clone]() [page:Vector4 this]</h3>
- <div>
- Clones this vector.
- </div>
- <h3>[method:Array toArray]( [page:Array array], [page:Integer offset] ) [page:Vector4 this]</h3>
- <div>
- array -- An optional array to store the vector.
- offset -- An optional offset into the array.
- </div>
- <div>
- Returns an array in the format [x, y, z, w]
- </div>
- <h2>Source</h2>
- [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
- </body>
- </html>
|