二维向量([name])

表示2D [link:https://en.wikipedia.org/wiki/Vector_space vector](二维向量)的类。 一个二维向量是一对有顺序的数字(标记为x和y),可用来表示很多事物,例如:

其他的一些事物也可以使用二维向量进行表示,比如说动量矢量、复数等等;但以上这些是它在Verge3D中的常用用途。

示例

var a = new v3d.Vector2(0, 1); //no arguments; will be initialised to (0, 0) var b = new v3d.Vector2(); var d = a.distanceTo(b);

构造函数

[name]([param:Float x], [param:Float y])

[page:Float x] - 向量的x值,默认为*0*。
[page:Float y] - 向量的y值,默认为*0*。

创建一个新的[name]。

属性

[property:Boolean isVector2]

用于测试这个类或者派生类是否为Vector2,默认为*true*。

你不应当对这个属性进行改变,因为它在内部使用,以用于优化。

[property:Float height]

[page:.y y]的别名。

[property:Float width]

[page:.x x]的别名。

[property:Float x]

[property:Float y]

方法

[method:this add]([param:Vector2 v])

将传入的向量[page:Vector2 v]和这个向量相加。

[method:this addScalar]([param:Float s])

将传入的标量[page:Float s]和这个向量的[page:.x x]值、[page:.y y]值相加。

[method:this addScaledVector]([param:Vector2 v], [param:Float s])

将所传入的[page:Vector2 v]与[page:Float s]相乘所得乘积和这个向量相加。

[method:this addVectors]([param:Vector2 a], [param:Vector2 b])

将该向量设置为 [page:Vector2 a] + [page:Vector2 b]。

[method:Float angle]()

计算该向量相对于x轴正方向的弧度角度。

[method:this applyMatrix3]([param:Matrix3 m])

将该向量乘以三阶矩阵m(第三个值隐式地为1)。

[method:this ceil]()

向量中的[page:.x x]分量和[page:.y y]分量向上取整为最接近的整数值。

[method:this clamp]([param:Vector2 min], [param:Vector2 max])

[page:Vector2 min] - 在限制范围内,x和y的最小值。
[page:Vector2 max] - 在限制范围内,x和y的最大值。

如果该向量的x值或y值大于限制范围内最大x值或y值,则该值将会被所对应的值取代。

如果该向量的x值或y值小于限制范围内最小x值或y值,则该值将会被所对应的值取代。

[method:this clampLength]([param:Float min], [param:Float max])

[page:Float min] - 长度将被限制为的最小值
[page:Float max] - 长度将被限制为的最大值

如果向量长度大于最大值,则它将会被最大值所取代。

如果向量长度小于最小值,则它将会被最小值所取代。

[method:this clampScalar]([param:Float min], [param:Float max])

[page:Float min] - 分量将被限制为的最小值
[page:Float max] - 分量将被限制为的最大值

如果该向量的x值或y值大于最大值,则它们将被最大值所取代。

如果该向量的x值或y值小于最小值,则它们将被最小值所取代。

[method:Vector2 clone]()

返回一个新的Vector2,其具有和当前这个向量相同的[page:.x x]和[page:.y y]。

[method:this copy]([param:Vector2 v])

将所传入Vector2的[page:.x x]和[page:.y y]属性复制给这一Vector2。

[method:Float distanceTo]([param:Vector2 v])

计算该vector到传入的[page:Vector2 v]的距离。

[method:Float manhattanDistanceTo]([param:Vector2 v])

计算该vector到传入的[page:Vector2 v]的曼哈顿距离([link:https://en.wikipedia.org/wiki/Taxicab_geometry Manhattan distance])。

[method:Float distanceToSquared]([param:Vector2 v])

计算该向量到传入的[page:Vector2 v]的平方距离。 如果你只是将该距离和另一个距离进行比较,则应当比较的是距离的平方, 因为它的计算效率会更高一些。

[method:this divide]([param:Vector2 v])

将该向量除以向量[page:Vector2 v]。

[method:this divideScalar]([param:Float s])

将该向量除以标量[page:Float s]。
如果传入的[page:Float s] = 0,则向量将被设置为*(0, 0)*。

[method:Float dot]([param:Vector2 v])

计算该vector和所传入[page:Vector2 v]的点积([link:https://en.wikipedia.org/wiki/Dot_product dot product])。

[method:Float cross]([param:Vector2 v])

计算该vector和所传入[page:Vector2 v]的叉积([link:https://en.wikipedia.org/wiki/Cross_product cross product])。 请注意,“叉积”在2D中并没有被明确定义。该函数计算的是2D图形中经常使用的几何叉积。

[method:Boolean equals]([param:Vector2 v])

检查该向量和[page:Vector2 v]的严格相等性。

[method:this floor]()

向量中的[page:.x x]分量和[page:.y y]分量向下取整为最接近的整数值。

[method:this fromArray]([param:Array array], [param:Integer offset])

[page:Array array] - 来源的数组。
[page:Integer offset] - (可选)在数组中的元素偏移量,默认值为0。

设置向量中的[page:.x x]值为array[offset],[page:.y y]值为array[offset + 1]。

[method:this fromBufferAttribute]([param:BufferAttribute attribute], [param:Integer index])

[page:BufferAttribute attribute] - 来源的attribute。
[page:Integer index] - 在attribute中的索引。

从[page:BufferAttribute attribute]中设置向量的[page:.x x]值和[page:.y y]值。 、

[method:Float getComponent]([param:Integer index])

[page:Integer index] - 0 或 1

如果index值为0则返回[page:.x x]值。
如果index值为1则返回[page:.y y]值。

[method:Float length]()

计算从(0, 0)到(x, y)的欧几里得长度 ([link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length],即直线长度)。

[method:Float manhattanLength]()

计算该向量的曼哈顿长度([link:http://en.wikipedia.org/wiki/Taxicab_geometry Manhattan length])。

[method:Float lengthSq]()

计算从(0, 0)到(x, y)的欧几里得长度 ([link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length],即直线长度)的平方。 如果你正在比较向量的长度,应当比较的是长度的平方,因为它的计算效率更高一些。

[method:this lerp]([param:Vector2 v], [param:Float alpha])

[page:Vector2 v] - 朝着进行插值的[page:Vector2]。
alpha - 插值因数,其范围在[0, 1]闭区间。

在该向量与传入的向量[page:Vector2 v]之间的线性插值,alpha是沿着线的距离长度。 —— alpha = 0 时表示的是当前向量,alpha = 1 时表示的是所传入的向量[page:Vector2 v]。

[method:this lerpVectors]([param:Vector2 v1], [param:Vector2 v2], [param:Float alpha])

[page:Vector2 v1] - 起始的[page:Vector2]。
[page:Vector2 v2] - 朝着进行插值的[page:Vector2]。
[page:Float alpha] - 插值因数,其范围在[0, 1]闭区间。

将此向量设置为在[page:Vector2 v1]和[page:Vector2 v2]之间进行线性插值的向量, 其中alpha为两个向量之间连线的距离长度。 —— alpha = 0 时表示的是[page:Vector2 v1],alpha = 1 时表示的是[page:Vector2 v2]。

[method:this negate]()

向量取反,即: x = -x , y = -y。

[method:this normalize]()

将该向量转换为单位向量([link:https://en.wikipedia.org/wiki/Unit_vector unit vector]), 也就是说,将该向量的方向设置为和原向量相同,但是其长度([page:.length length])为1。

[method:this max]([param:Vector2 v])

如果该向量的x值或y值小于所传入[page:Vector2 v]的x值或y值,则将该值替换为对应的最大值。

[method:this min]([param:Vector2 v])

如果该向量的x值或y值大于所传入[page:Vector2 v]的x值或y值,则将该值替换为对应的最小值。

[method:this multiply]([param:Vector2 v])

将该向量与所传入的向量[page:Vector2 v]进行相乘。

[method:this multiplyScalar]([param:Float s])

将该向量与所传入的标量[page:Float s]进行相乘。

[method:this rotateAround]([param:Vector2 center], [param:float angle])

[page:Vector2 center] - 将被围绕旋转的点。
[page:float angle] - 将要旋转的角度,以弧度来表示。

将向量围绕着[page:Vector2 center]旋转[page:float angle]弧度。

[method:this round]()

向量中的[page:.x x]分量和[page:.y y]分量四舍五入取整为最接近的整数值。

[method:this roundToZero]()

向量中的分量朝向0取整数(若分量为负数则向上取整,若为正数则向下取整)。

[method:this set]([param:Float x], [param:Float y])

设置该向量的[page:.x x]和[page:.y y]分量。

[method:null setComponent]([param:Integer index], [param:Float value])

[page:Integer index] - 0 或 1
[page:Float value] - [page:Float]

如果index值为0则将[page:.x x]值设置为[page:Float value]。
如果index值为1则将[page:.y y]值设置为[page:Float value]

[method:this setLength]([param:Float l])

将该向量的方向设置为和原向量相同,但是长度([page:.length length])为[page:Float l]。

[method:this setScalar]([param:Float scalar])

将该向量的[page:.x x]、[page:.y y]值同时设置为等于传入的[page:Float scalar]。

[method:this setX]([param:Float x])

将向量中的[page:.x x]值替换为[page:Float x]。

[method:this setY]([param:Float y])

将向量中的[page:.y y]值替换为[page:Float y]。

[method:this sub]([param:Vector2 v])

从该向量减去向量[page:Vector2 v]。

[method:this subScalar]([param:Float s])

从该向量的[page:.x x]和[page:.y y]中减去标量[page:Float s]。

[method:this subVectors]([param:Vector2 a], [param:Vector2 b])

将该向量设置为[page:Vector2 a] - [page:Vector2 b]。

[method:Array toArray]([param:Array array], [param:Integer offset])

[page:Array array] - (可选)被用于存储向量的数组。如果这个值没有传入,则将创建一个新的数组。
[page:Integer offset] - (可选) 数组中元素的偏移量。

返回一个数组[x, y],或者将x和y复制到所传入的[page:Array array]中。

源代码

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]