Class Vector3

用以保存表示 (x, y, z) 向量数据的类。 Vector3 是三维图像中的主要对象，它既可以表示一个空间内的点，也可以表示一个方向。

一个三维向量

Note: Diva 使用左手坐标系。

Hierarchy

Vector3

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
根据给定的 x, y, z 坐标创建一个三位向量。
Parameters
- x: number = 0
  
  x 轴坐标
- y: number = 0
  
  y 轴坐标
- z: number = 0
  
  z 轴坐标
Returns Vector3

Accessors

length

get length(): number
获取向量长度（模）

Returns number

tuple

get tuple(): Vector3Tuple
获取元组形式的向量数组。

Returns
[x:number, y:number, z:number]

Returns Vector3Tuple

x

get x(): number
获取 x 坐标

Returns number
set x(value: number): void
设置 x 坐标
Parameters
- value: number
Returns void

y

get y(): number
获取 y 坐标

Returns number
set y(value: number): void
设置 y 坐标
Parameters
- value: number
Returns void

z

get z(): number
获取 z 坐标

Returns number
set z(value: number): void
设置 z 坐标
Parameters
- value: number
Returns void

Methods

add

add(vector: Vector3): Vector3
获取一个新的向量，表示当前向量与另一个向量的和。

Returns
新的向量
Parameters
- vector: Vector3
  
  加和向量
Returns Vector3

addInPlace

addInPlace(vector: Vector3): Vector3
使当前向量与另一个向量求和。

Returns
当前计算更新后的向量
Parameters
- vector: Vector3
  
  加和向量
Returns Vector3

addToRef

addToRef(vector: Vector3, result: Vector3): void
使当前向量与另一个向量求和，并将结果保存到结果向量中。

Returns
Parameters
- vector: Vector3
  
  加和向量
- result: Vector3
  
  结果向量
Returns void

angleTo

angleTo(vector: Vector3): number
计算当前向量与另一个向量夹角的内角弧度。

Returns
夹角的内角弧度
Parameters
- vector: Vector3
  
  所要计算夹角的向量
Returns number

clone

clone(): Vector3
从当前向量克隆创建新向量。

Returns
新的向量

Returns Vector3

copyFrom

copyFrom(source: Vector3Tuple): Vector3
从源向量复制更新当前向量。

Returns
当前更新后的向量
Parameters
- source: Vector3Tuple
  
  复制源向量坐标元组
Returns Vector3
copyFrom(source: Vector3): Vector3
从源向量复制更新当前向量。

Returns
当前更新后的向量
Parameters
- source: Vector3
  
  复制源向量
Returns Vector3
copyFrom(x: number, y: number, z: number): Vector3
从数值分量复制更新当前向量。

Returns
当前更新后的向量
Parameters
- x: number
  
  第一个坐标
- y: number
  
  第二个坐标
- z: number
  
  第三个坐标
Returns Vector3

cross

cross(vector: Vector3): Vector3
计算当前向量与另一个向量的叉乘乘积。

Returns
两向量的叉乘乘积向量。
Parameters
- vector: Vector3
  
  计算叉乘的另一个向量。
Returns Vector3

crossInPlace

crossInPlace(vector: Vector3): Vector3
计算当前向量与另一个向量的叉乘乘积，并将结果更新至自身。

Returns
更新计算过的当前向量
Parameters
- vector: Vector3
  
  计算叉乘的另一个向量。
Returns Vector3

crossProduct

crossProduct(vector: Vector3): Vector3
计算当前向量与另一个向量的叉乘乘积。

Returns
两向量的叉乘乘积向量。

Deprecated
已弃用，请使用替代 cross 方法
Parameters
- vector: Vector3
  
  计算叉乘的另一个向量。
Returns Vector3

crossToRef

crossToRef(vector: Vector3, result: Vector3): void
计算当前向量与另一个向量的叉乘乘积，并将结果保存到结果向量中。
Parameters
- vector: Vector3
  
  计算叉乘的另一个向量
- result: Vector3
  
  计算叉乘的结果向量
Returns void

distanceFrom

distanceFrom(target: Vector3): number
计算距离目标向量的距离值。
Parameters
- target: Vector3
  
  目标向量
Returns number

divide

divide(vector: Vector3): Vector3
返回一个新向量，其值是当前向量与指定向量中的每对元素的商。

Returns
新的结果向量
Parameters
- vector: Vector3
  
  除数向量
Returns Vector3

divideInPlace

divideInPlace(vector: Vector3): Vector3
使当前向量与指定向量中的每个元素相除，并将计算结果更新至当前向量中。

Returns
当前计算更新后的向量
Parameters
- vector: Vector3
  
  除数向量
Returns Vector3

divideToRef

divideToRef(vector: Vector3, result: Vector3): void
使当前向量与指定向量中的每个元素相除，并将计算结果保存到结果向量中。
Parameters
- vector: Vector3
  
  除数向量
- result: Vector3
  
  结果向量
Returns void

dot

dot(vector: Vector3): number
计算当前向量与另一个向量的点乘乘积。

Returns
点乘结果
Parameters
- vector: Vector3
  
  计算点乘的另一个向量。
Returns number

equals

equals(vector: Vector3): boolean
判断当前向量与指定向量是否严格相等。

Returns
判断结果
Parameters
- vector: Vector3
  
  指定相比较的向量
Returns boolean

equalsWithEpsilon

equalsWithEpsilon(vector: Vector3, epsilon?: number): boolean
判断当前向量与指定向量是否在机械极小值（默认 0.001）误差范围内相等。

Returns
判断结果
Parameters
- vector: Vector3
  
  指定相比较的向量
- epsilon: number = EPSILON
  
  机械极小值（默认 0.001）
Returns boolean

isZero

isZero(): boolean
判断当前向量是否为零向量。

Returns
是否为零向量

Returns boolean

lerpTo

lerpTo(end: Vector3, gradient: number): Vector3
以自身为起点位置，参数传入的向量为终点位置，按指定浮点梯度进行线性插值。

Returns
新的插值向量
Parameters
- end: Vector3
  
  终点位置的向量
- gradient: number
  
  渐变系数，插值梯度，取值 0~1
Returns Vector3

max

max(vector: Vector3): Vector3
将当前向量与对指定向量执行在各分量上做最大操作，并返回新结果向量。

Returns
执行逐元素最大操作后的新向量
Parameters
- vector: Vector3
  
  指定向量
Returns Vector3

maxInPlace

maxInPlace(vector: Vector3): Vector3
将当前向量与指定向量执行在各分量上做最大操作，并将结果更新到当前向量中。

Returns
当前向量
Parameters
- vector: Vector3
  
  指定向量
Returns Vector3

min

min(vector: Vector3): Vector3
将当前向量与对指定向量执行在各分量上做最小操作，并返回新结果向量。

Returns
执行逐元素最小操作后的新向量
Parameters
- vector: Vector3
  
  指定向量
Returns Vector3

minInPlace

minInPlace(vector: Vector3): Vector3
将当前向量与指定向量执行在各分量上做最小操作，并将结果更新到当前向量中。

Returns
当前向量
Parameters
- vector: Vector3
  
  指定向量
Returns Vector3

multiply

multiply(vector: Vector3): Vector3
返回一个新向量，其值是当前向量与指定向量中的每对元素的乘积。

Returns
逐元素乘积向量
Parameters
- vector: Vector3
  
  与当前向量逐元素相乘的向量
Returns Vector3

multiplyInPlace

multiplyInPlace(vector: Vector3): Vector3
返回一个新向量，其值是当前向量与指定向量中的每对元素的乘积。

Returns
逐元素乘积向量
Parameters
- vector: Vector3
  
  与当前向量逐元素相乘的向量
Returns Vector3

multiplyToRef

multiplyToRef(vector: Vector3, result: Vector3): void
使当前向量与指定向量中的每个元素相乘，并将计算结果保存到结果向量中。
Parameters
- vector: Vector3
  
  与当前向量逐元素相乘的向量
- result: Vector3
  
  结果向量
Returns void

normalize

normalize(): Vector3
获取当前向量标准化的单位向量。

Returns
一个标准化的新向量

Returns Vector3

normalizeInPlace

normalizeInPlace(): Vector3
将当前向量标准化（归一化）。

Returns
当前更新后的向量

Returns Vector3

normalizeToRef

normalizeToRef(result: Vector3): void
对当前向量进行标准化（归一化），并将结果保存在传入的结果向量中。
Parameters
- result: Vector3
  
  需要保存标准化计算结果的向量
Returns void

scale

scale(scalar: number): Vector3
将当前向量按照指定标量将其缩放，并将结果作为新的向量。

Returns
一个缩放后新的向量
Parameters
- scalar: number
  
  缩放比例
Returns Vector3

scaleInPlace

scaleInPlace(scalar: number): Vector3
将当前向量按照指定标量将其缩放，并将结果更新至当前向量中。

Returns
当前计算更新后的向量
Parameters
- scalar: number
  
  缩放比例
Returns Vector3

scaleToRef

scaleToRef(scalar: number, result: Vector3): void
将当前向量按照指定标量将其缩放，并将结果保存到结果向量中。
Parameters
- scalar: number
  
  缩放比例
- result: Vector3
  
  结果向量
Returns void

subtract

subtract(vector: Vector3): Vector3
获取一个新的向量，表示当前向量与另一个向量的差。

Returns
结果差向量
Parameters
- vector: Vector3
  
  做差向量
Returns Vector3

subtractInPlace

subtractInPlace(vector: Vector3): Vector3
当前向量与另一个向量的做差，并将结果更新至当前向量中。

Returns
当前计算更新后的向量
Parameters
- vector: Vector3
  
  做差向量
Returns Vector3

subtractToRef

subtractToRef(vector: Vector3, result: Vector3): void
使当前向量与另一个向量做差，并将结果保存到结果向量中。
Parameters
- vector: Vector3
  
  做差向量坐标
- result: Vector3
  
  结果向量
Returns void

`Static` Add

Add(left: Vector3, right: Vector3): Vector3
将两个向量相加。

Returns
总和向量
Parameters
- left: Vector3
  
  要相加的第一个向量
- right: Vector3
  
  要相加的第二个向量
Returns Vector3

`Static` AngleBetween

AngleBetween(left: Vector3, right: Vector3): number
获取两个向量夹角的内角弧度。

Returns
夹角的内角弧度
Parameters
- left: Vector3
  
  内角左向量
- right: Vector3
  
  内角右向量
Returns number

`Static` Clamp

Clamp(value: Vector3, min: Vector3, max: Vector3): Vector3
如果向量值在向量 "min" 和 "max"定义的立方体中，则返回与其值相同的新向量。如果向量值的任意坐标小于 "min" 向量值的坐标，则将其设置为 "min" 坐标值。如果向量值的任意坐标大于 "max" 向量值的坐标，则将其设置为 "max" 坐标值。

Returns
钳制后返回的新向量
Parameters
- value: Vector3
  
  需要进行钳制操作的向量值
- min: Vector3
  
  要钳制到的最小向量
- max: Vector3
  
  要钳制到的最大向量
Returns Vector3

`Static` Cross

Cross(left: Vector3, right: Vector3): Vector3
计算量个向量的叉乘，并返回保存计算结果的新向量。

Returns
保存计算结果的新向量
Parameters
- left: Vector3
  
  叉乘左值
- right: Vector3
  
  叉乘右值
Returns Vector3

`Static` CrossToRef

CrossToRef(left: Vector3, right: Vector3, result: Vector3): void
计算两个向量的叉乘，并将乘积结果放入结果向量中。
Parameters
- left: Vector3
  
  叉乘左值
- right: Vector3
  
  叉乘右值
- result: Vector3
  
  保存计算结果的向量
Returns void

`Static` Divide

Divide(left: Vector3, right: Vector3): Vector3
将第一个向量除以第二个向量

Returns
除法计算产生的向量
Parameters
- left: Vector3
  
  第一个向量
- right: Vector3
  
  第二个向量
Returns Vector3

`Static` Dot

Dot(left: Vector3, right: Vector3): number
计算两个向量的点乘乘积。

Returns
点乘结果
Parameters
- left: Vector3
  
  点乘左值
- right: Vector3
  
  点乘右值
Returns number

`Static` FromArray

FromArray(array: number[], offset?: number): Vector3
根据指定的数据源数组与偏移量创建结果向量。

Returns
目标向量
Parameters
- array: number[]
  
  数据源
- offset: number = 0
  
  数据源中的偏移量，默认为 0
Returns Vector3

`Static` FromTuple

FromTuple(tuple: Vector3Tuple): Vector3
根据三元组创建三维向量。

Returns
创建的新向量
Parameters
- tuple: Vector3Tuple
  
  表示向量的三元组
Returns Vector3

`Static` Lerp

Lerp(start: Vector3, end: Vector3, gradient: number): Vector3
返回位于起点向量与终点向量之间，并按指定浮点梯度进行线性插值的新 Vector3 对象。
Parameters
- start: Vector3
  
  起点向量
- end: Vector3
  
  终点向量
- gradient: number
  
  渐变系数，插值梯度，取值 0~1
Returns Vector3

`Static` Max

Max(vec1: Vector3, vec2: Vector3): Vector3
对给定的向量执行在各分量上做最大操作，并返回新结果向量。

Returns
最大操作结果向量
Parameters
- vec1: Vector3
  
  向量1
- vec2: Vector3
  
  向量2
Returns Vector3

`Static` Min

Min(vec1: Vector3, vec2: Vector3): Vector3
对给定的向量执行在各分量上做最小操作，并返回新结果向量。

Returns
最小操作结果向量
Parameters
- vec1: Vector3
  
  向量1
- vec2: Vector3
  
  向量2
Returns Vector3

`Static` Multiply

Multiply(left: Vector3, right: Vector3): Vector3
返回一个新向量，其值是两个指定向量中的每对元素的乘积。

Returns
逐元素乘积向量
Parameters
- left: Vector3
  
  第一个向量
- right: Vector3
  
  第二个向量
Returns Vector3

`Static` Normalize

Normalize(vector: Vector3): Vector3
获取指定向量的标准化向量。

Returns
一个标准化的新向量
Parameters
- vector: Vector3
  
  需要计算的向量
Returns Vector3

`Static` NormalizeToRef

NormalizeToRef(vector: Vector3, result: Vector3): void
对指定向量进行标准化，并将结果保存在传入的结果向量中。
Parameters
- vector: Vector3
  
  需要计算的向量
- result: Vector3
  
  需要保存标准化计算结果的向量
Returns void

`Static` One

One(): Vector3
创建一个设置为 (1.0, 1.0, 1.0) 的三维向量对象。

Returns
创建的新向量

Returns Vector3

`Static` Subtract

Subtract(left: Vector3, right: Vector3): Vector3
从第一个向量中减去第二个向量。

Returns
差向量
Parameters
- left: Vector3
  
  第一个向量
- right: Vector3
  
  第二个向量
Returns Vector3

`Static` Zero

Zero(): Vector3
创建一个设置为 (0.0, 0.0, 0.0) 的三维向量对象。

Returns
创建的新向量

Returns Vector3