Vec3 | CocosCreatorAPI

三维向量。

Hierarchy

ValueType
- Vec3

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

newVec3(v: Vec3): Vec3
newVec3(x?: undefined | number, y?: undefined | number, z?: undefined | number): Vec3

- Defined in cocos/core/math/vec3.ts:690
Parameters
- v: Vec3
Returns Vec3
- Defined in cocos/core/math/vec3.ts:692
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
Returns Vec3

Properties

x

x: number

x 分量。

y

y: number

y 分量。

z

z: number

z 分量。

Static FORWARD

FORWARD: Readonly<Vec3> = Object.freeze(new Vec3(0, 0, -1))

Static NEG_ONE

NEG_ONE: Readonly<Vec3> = Object.freeze(new Vec3(-1, -1, -1))

Static ONE

ONE: Readonly<Vec3> = Object.freeze(new Vec3(1, 1, 1))

Static RIGHT

RIGHT: Readonly<Vec3> = Object.freeze(new Vec3(1, 0, 0))

Static UNIT_X

UNIT_X: Readonly<Vec3> = Object.freeze(new Vec3(1, 0, 0))

Static UNIT_Y

UNIT_Y: Readonly<Vec3> = Object.freeze(new Vec3(0, 1, 0))

Static UNIT_Z

UNIT_Z: Readonly<Vec3> = Object.freeze(new Vec3(0, 0, 1))

Static UP

UP: Readonly<Vec3> = Object.freeze(new Vec3(0, 1, 0))

Static ZERO

ZERO: Readonly<Vec3> = Object.freeze(new Vec3(0, 0, 0))

Methods

add

add(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:835
向量加法。将当前向量与指定向量的相加

Parameters
- other: Vec3
  
  specified vector
Returns this

add3f

add3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:849
向量加法。将当前向量与指定分量的向量相加

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

clampf

clampf(minInclusive: Vec3, maxInclusive: Vec3): this

- Defined in cocos/core/math/vec3.ts:966
设置当前向量的值，使其各个分量都处于指定的范围内。

Parameters
- minInclusive: Vec3
  
  Minimum value allowed
- maxInclusive: Vec3
  
  Maximum value allowed
Returns this

this

clone

clone(): Vec3

Overrides ValueType.clone
- Defined in cocos/core/math/vec3.ts:713
克隆当前向量。

Returns Vec3

cross

cross(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:988
向量叉乘。将当前向量左叉乘指定向量

Parameters
- other: Vec3
  
  specified vector
Returns this

divide

divide(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:927
向量逐元素相除。将当前向量与指定分量的向量相除的结果赋值给当前向量。

Parameters
- other: Vec3
  
  specified vector
Returns this

divide3f

divide3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:941
向量逐元素相除。将当前向量与指定分量的向量相除的结果赋值给当前向量。

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

dot

dot(other: Vec3): number

- Defined in cocos/core/math/vec3.ts:979
向量点乘。

Parameters
- other: Vec3
  
  specified vector
Returns number

The result of calculates the dot product with another vector

equals

equals(other: Vec3, epsilon?: number): boolean

Overrides ValueType.equals
- Defined in cocos/core/math/vec3.ts:755
判断当前向量是否在误差范围内与指定向量相等。

Parameters
- other: Vec3
  
  Specified vector
- Default value epsilon: number = EPSILON
  
  The error allowed. It`s should be a non-negative number.
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

equals3f

equals3f(x: number, y: number, z: number, epsilon?: number): boolean

- Defined in cocos/core/math/vec3.ts:775
判断当前向量是否在误差范围内与指定分量的向量相等。

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
- Default value epsilon: number = EPSILON
  
  The error allowed. It`s should be a non-negative number.
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

length

length(): number

- Defined in cocos/core/math/vec3.ts:1003
计算向量的长度（模）。

Returns number

Length of vector

lengthSqr

lengthSqr(): number

- Defined in cocos/core/math/vec3.ts:1012
计算向量长度（模）的平方。

Returns number

the squared length of this vector

lerp

lerp(to: Vec3, ratio: number): this

- Defined in cocos/core/math/vec3.ts:823
根据指定的插值比率，从当前向量到目标向量之间做插值。

Parameters
- to: Vec3
  
  Target vector
- ratio: number
  
  The interpolation coefficient.The range is [0,1].
Returns this

multiply

multiply(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:900
向量乘法。将当前向量乘以与指定向量的结果赋值给当前向量。

Parameters
- other: Vec3
  
  specified vector
Returns this

multiply3f

multiply3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:915
向量乘法。将当前向量与指定分量的向量相乘的结果赋值给当前向量。

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

multiplyScalar

multiplyScalar(scalar: number): this

- Defined in cocos/core/math/vec3.ts:887
向量数乘。将当前向量数乘指定标量

Parameters
- scalar: number
  
  scalar number
Returns this

negative

negative(): this

- Defined in cocos/core/math/vec3.ts:952
将当前向量的各个分量取反

Returns this

normalize

normalize(): this

- Defined in cocos/core/math/vec3.ts:1020
将当前向量归一化

Returns this

set

set(other: Vec3): any
set(x?: undefined | number, y?: undefined | number, z?: undefined | number): any

Overrides ValueType.set
- Defined in cocos/core/math/vec3.ts:723
设置当前向量使其与指定向量相等。

Parameters
- other: Vec3
  
  Specified vector
Returns any

this
Overrides ValueType.set
- Defined in cocos/core/math/vec3.ts:733
设置当前向量的具体分量值。

Parameters
- Optional x: undefined | number
  
  x value
- Optional y: undefined | number
  
  y value
- Optional z: undefined | number
  
  z value
Returns any

this

strictEquals

strictEquals(other: Vec3): boolean

- Defined in cocos/core/math/vec3.ts:792
判断当前向量是否与指定向量相等。

Parameters
- other: Vec3
  
  specified vector
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

strictEquals3f

strictEquals3f(x: number, y: number, z: number): boolean

- Defined in cocos/core/math/vec3.ts:804
判断当前向量是否与指定分量的向量相等。

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

subtract

subtract(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:861
向量减法。将当前向量减去指定向量的结果。

Parameters
- other: Vec3
  
  specified vector
Returns this

subtract3f

subtract3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:875
向量减法。将当前向量减去指定分量的向量

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

toString

toString(): string

Overrides ValueType.toString
- Defined in cocos/core/math/vec3.ts:813
返回当前向量的字符串表示。

Returns string

The string with vector information

transformMat4

transformMat4(matrix: Mat4): this

- Defined in cocos/core/math/vec3.ts:1040
将当前向量视为 w 分量为 1 的四维向量，应用四维矩阵变换到当前矩阵

Parameters
- matrix: Mat4
  
  matrix to transform with
Returns this

Static add

add<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:100
逐元素向量加法

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static angle

angle(a: IVec3Like, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:636
求两向量夹角弧度

Parameters
- a: IVec3Like
- b: IVec3Like
Returns number

Static ceil

ceil<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:144
逐元素向量向上取整

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static clone

clone<Out>(a: Out): Vec3

- Defined in cocos/core/math/vec3.ts:70
获得指定向量的拷贝

Type parameters
- Out: IVec3Like
Parameters
- a: Out
Returns Vec3

Static copy

copy<Out, Vec3Like>(out: Out, a: Vec3Like): Out

- Defined in cocos/core/math/vec3.ts:78
复制目标向量

Type parameters
- Out: IVec3Like
- Vec3Like: IVec3Like
Parameters
- out: Out
- a: Vec3Like
Returns Out

Static cross

cross<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:344
向量叉积（向量积）

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static distance

distance(a: IVec3Like, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:221
求两向量的欧氏距离

Parameters
- a: IVec3Like
- b: IVec3Like
Returns number

Static divide

divide<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:133
逐元素向量除法

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static dot

dot<Out>(a: Out, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:336
向量点积（数量积）

Type parameters
- Out: IVec3Like
Parameters
- a: Out
- b: IVec3Like
Returns number

Static equals

equals(a: IVec3Like, b: IVec3Like, epsilon?: number): boolean

- Defined in cocos/core/math/vec3.ts:619
排除浮点数误差的向量近似等价判断

Parameters
- a: IVec3Like
- b: IVec3Like
- Default value epsilon: number = EPSILON
Returns boolean

Static floor

floor<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:155
逐元素向量向下取整

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static fromArray

fromArray<Out>(out: Out, arr: IWritableArrayLike<number>, ofs?: number): Out

- Defined in cocos/core/math/vec3.ts:600
数组转向量

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- arr: IWritableArrayLike<number>
- Default value ofs: number = 0
  
  Array Start Offset
Returns Out

Static invert

invert<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:276
逐元素向量取倒数，接近 0 时返回 Infinity

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static invertSafe

invertSafe<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:287
逐元素向量取倒数，接近 0 时返回 0

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static len

len(a: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:243
求向量长度

Parameters
- a: IVec3Like
Returns number

Static lengthSqr

lengthSqr(a: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:254
求向量长度平方

Parameters
- a: IVec3Like
Returns number

Static lerp

lerp<Out>(out: Out, a: IVec3Like, b: IVec3Like, t: number): Out

- Defined in cocos/core/math/vec3.ts:357
逐元素向量线性插值： A + t * (B - A)

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
- t: number
Returns Out

Static max

max<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:177
逐元素向量最大值

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static min

min<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:166
逐元素向量最小值

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static multiply

multiply<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:122
逐元素向量乘法 (分量积)

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static multiplyScalar

multiplyScalar<Out, Vec3Like>(out: Out, a: Vec3Like, b: number): Out

- Defined in cocos/core/math/vec3.ts:199
向量标量乘法

Type parameters
- Out: IVec3Like
- Vec3Like: IVec3Like
Parameters
- out: Out
- a: Vec3Like
- b: number
Returns Out

Static negate

negate<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:265
逐元素向量取负

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static normalize

normalize<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:317
归一化向量

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static project

project<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:665
计算向量在指定向量上的投影

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
  
  projection vector
- b: IVec3Like
Returns Out

Static projectOnPlane

projectOnPlane<Out>(out: Out, a: IVec3Like, n: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:655
计算向量在指定平面上的投影

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
  
  projection vector
- n: IVec3Like
  
  the normal line of specified plane
Returns Out

Static random

random<Out>(out: Out, scale?: undefined | number): Out

- Defined in cocos/core/math/vec3.ts:369
生成一个在单位球体上均匀分布的随机向量

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- Optional scale: undefined | number
  
  vector length
Returns Out

Static rotateX

rotateX<Out>(out: Out, v: IVec3Like, o: IVec3Like, a: number): Out

- Defined in cocos/core/math/vec3.ts:505
绕 X 轴旋转向量指定弧度

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
  
  rotation vector
- o: IVec3Like
  
  center of rotation
- a: number
  
  radius of rotation
Returns Out

Static rotateY

rotateY<Out>(out: Out, v: IVec3Like, o: IVec3Like, a: number): Out

- Defined in cocos/core/math/vec3.ts:533
绕 Y 轴旋转向量指定弧度

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
  
  rotation vector
- o: IVec3Like
  
  center of rotation
- a: number
  
  radius of rotation
Returns Out

Static rotateZ

rotateZ<Out>(out: Out, v: IVec3Like, o: IVec3Like, a: number): Out

- Defined in cocos/core/math/vec3.ts:561
绕 Z 轴旋转向量指定弧度

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
  
  rotation vector
- o: IVec3Like
  
  center of rotation
- a: number
  
  radius of rotation
Returns Out

Static round

round<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:188
逐元素向量四舍五入取整

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static scaleAndAdd

scaleAndAdd<Out>(out: Out, a: IVec3Like, b: IVec3Like, scale: number): Out

- Defined in cocos/core/math/vec3.ts:210
逐元素向量乘加: A + B * scale

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
- scale: number
Returns Out

Static set

set<Out>(out: Out, x: number, y: number, z: number): Out

- Defined in cocos/core/math/vec3.ts:89
设置向量值

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- x: number
- y: number
- z: number
Returns Out

Static squaredDistance

squaredDistance(a: IVec3Like, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:232
求两向量的欧氏距离平方

Parameters
- a: IVec3Like
- b: IVec3Like
Returns number

Static strictEquals

strictEquals(a: IVec3Like, b: IVec3Like): boolean

- Defined in cocos/core/math/vec3.ts:611
向量等价判断

Parameters
- a: IVec3Like
- b: IVec3Like
Returns boolean

Static subtract

subtract<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:111
逐元素向量减法

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static toArray

toArray<Out>(out: Out, v: IVec3Like, ofs?: number): Out

- Defined in cocos/core/math/vec3.ts:587
向量转数组

Type parameters
- Out: IWritableArrayLike<number>
Parameters
- out: Out
- v: IVec3Like
- Default value ofs: number = 0
  
  Array Start Offset
Returns Out

Static transformAffine

transformAffine<Out>(out: Out, v: IVec3Like, m: IMat4Like): Out

- Defined in cocos/core/math/vec3.ts:432
向量仿射变换

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
- m: IMat4Like
Returns Out

Static transformInverseRTS

transformInverseRTS<Out>(out: Out, a: IVec3Like, r: IQuatLike, t: IVec3Like, s: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:484
以平移 -> 旋转 -> 缩放顺序逆变换向量

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- r: IQuatLike
- t: IVec3Like
- s: IVec3Like
Returns Out

Static transformMat3

transformMat3<Out>(out: Out, a: IVec3Like, m: IMat3Like): Out

- Defined in cocos/core/math/vec3.ts:418
向量与三维矩阵乘法

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- m: IMat3Like
Returns Out

Static transformMat4

transformMat4<Out>(out: Out, a: IVec3Like, m: IMat4Like): Out

- Defined in cocos/core/math/vec3.ts:386
向量与四维矩阵乘法，默认向量第四位为 1。

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- m: IMat4Like
Returns Out

Static transformMat4Normal

transformMat4Normal<Out>(out: Out, a: IVec3Like, m: IMat4Like): Out

- Defined in cocos/core/math/vec3.ts:402
向量与四维矩阵乘法，默认向量第四位为 0。

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- m: IMat4Like
Returns Out

Static transformQuat

transformQuat<Out>(out: Out, a: IVec3Like, q: IQuatLike): Out

- Defined in cocos/core/math/vec3.ts:446
向量四元数乘法

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- q: IQuatLike
Returns Out

Static transformRTS

transformRTS<Out>(out: Out, a: IVec3Like, r: IQuatLike, t: IVec3Like, s: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:466
以缩放 -> 旋转 -> 平移顺序变换向量

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- r: IQuatLike
- t: IVec3Like
- s: IVec3Like
Returns Out

Static zero

zero<Out>(out: Out): Out

- Defined in cocos/core/math/vec3.ts:59
将目标赋值为零向量

Type parameters
- Out: IVec3Like
Parameters
- out: Out
Returns Out

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

v: Vec3

Returns Vec3

Parameters

Optional x: undefined | number

Optional y: undefined | number

Optional z: undefined | number

Returns Vec3

Properties

x

y

z

Static FORWARD

Static NEG_ONE

Static ONE

Static RIGHT

Static UNIT_X

Static UNIT_Y

Static UNIT_Z

Static UP

Static ZERO

Methods

add

Parameters

other: Vec3

Returns this

add3f

Parameters

x: number

y: number

z: number

Returns this

clampf

Parameters

minInclusive: Vec3

maxInclusive: Vec3

Returns this

clone

Returns Vec3

cross

Parameters

other: Vec3

Returns this

divide

Parameters

other: Vec3

Returns this

divide3f

Parameters

x: number

y: number

z: number

Returns this

dot

Parameters

other: Vec3

Returns number

equals

Parameters

other: Vec3

Default value epsilon: number = EPSILON

Returns boolean

equals3f

Parameters

x: number

y: number

z: number

Default value epsilon: number = EPSILON

Returns boolean

length

Returns number

lengthSqr

Returns number