mirror of
https://github.com/Doodle3D/Doodle3D-Slicer.git
synced 2024-11-04 21:53:25 +01:00
316 lines
8.4 KiB
HTML
Executable File
316 lines
8.4 KiB
HTML
Executable File
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<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 copy]( [page:Vector4 v] ) [page:Vector4 this]</h3>
|
|
<div>
|
|
Copies value of *v* to this vector.
|
|
</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 sub]( [page:Vector4 v] )</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] )</h3>
|
|
<div>
|
|
Computes dot product of this vector and *v*.
|
|
</div>
|
|
|
|
<h3>[method:Float lengthSq]()</h3>
|
|
<div>
|
|
Computes squared length of this vector.
|
|
</div>
|
|
|
|
<h3>[method:Float length]()</h3>
|
|
<div>
|
|
Computes length of this vector.
|
|
</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 clone]()</h3>
|
|
<div>
|
|
Clones this vector.
|
|
</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 replace 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 />
|
|
If this vector's x, y, z or w values are less than the min value, they are replace by the min value.
|
|
</div>
|
|
|
|
<h3>[method:Vector4 floor]()</h3>
|
|
<div>
|
|
The components of the vector are rounded downwards (towards negative infinity) to an integer value.
|
|
</div>
|
|
|
|
<h3>[method:Vector4 ceil]()</h3>
|
|
<div>
|
|
The components of the vector are rounded upwards (towards positive infinity) to an integer value.
|
|
</div>
|
|
|
|
<h3>[method:Vector4 round]()</h3>
|
|
<div>
|
|
The components of the vector are rounded towards the nearest integer value.
|
|
</div>
|
|
|
|
<h3>[method:Vector4 roundToZero]()</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 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 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 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 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])</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])</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])</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 fromArray]([page:Array array]) [page:Vector4 this]</h3>
|
|
<div>
|
|
array -- [page:Array] An array formatted [x, y, z, w]
|
|
</div>
|
|
<div>
|
|
Sets the vector's components based on an array formatted like [x, y, z, w]
|
|
</div>
|
|
|
|
<h3>[method:Array toArray]( [page:Array array] )</h3>
|
|
<div>
|
|
array -- Optional array to store the vector.
|
|
</div>
|
|
<div>
|
|
Returns an array in the format [x, y, z, w]
|
|
</div>
|
|
|
|
<h3>[method:Float lengthManhattan]()</h3>
|
|
<div>
|
|
Computes Manhattan length of this vector.<br />
|
|
[link:http://en.wikipedia.org/wiki/Taxicab_geometry]
|
|
</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>
|
|
|
|
<h2>Source</h2>
|
|
|
|
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
|
|
</body>
|
|
</html>
|