Class Vec4

四维向量。

Hierarchy

ValueType
- Vec4

Index

Constructors

constructor

Properties

w
x
y
z
NEGONE
ONE
ZERO

Methods

Constructors

constructor

newVec4(other: Vec4): Vec4
newVec4(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Vec4

- Defined in cocos/core/math/vec4.ts:507
Parameters
- other: Vec4
Returns Vec4
- Defined in cocos/core/math/vec4.ts:509
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
- Optional w: undefined | number
Returns Vec4

Properties

w

w: number

w 分量。

x

x: number

x 分量。

y

y: number

y 分量。

z

z: number

z 分量。

Static NEGONE

NEGONE: {} = Object.freeze(new Vec4(-1, -1, -1, -1))

Type declaration

Static ONE

ONE: {} = Object.freeze(new Vec4(1, 1, 1, 1))

Type declaration

Static ZERO

ZERO: {} = Object.freeze(new Vec4(0, 0, 0, 0))

Type declaration

Methods

add

add(other: Vec4): this

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

Parameters
- other: Vec4
  
  specified vector
Returns this

add4f

add4f(x: number, y: number, z: number, w: number): this

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

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
- w: number
  
  The w value of specified vector
Returns this

clampf

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

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

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

this

clone

clone(): Vec4

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

Returns Vec4

cross

cross(vector: Vec4): this

- Defined in cocos/core/math/vec4.ts:824
向量叉乘。视当前向量和指定向量为三维向量（舍弃 w 分量），将当前向量左叉乘指定向量

Parameters
- vector: Vec4
Returns this

divide

divide(other: Vec4): this

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

Parameters
- other: Vec4
  
  specified vector
Returns this

divide4f

divide4f(x: number, y: number, z: number, w: number): this

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

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
- w: number
  
  The w value of specified vector
Returns this

dot

dot(vector: Vec4): number

- Defined in cocos/core/math/vec4.ts:815
向量点乘。

Parameters
- vector: Vec4
Returns number

当前向量与指定向量点乘的结果。

equals

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

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

Parameters
- other: Vec4
  
  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.

equals4f

equals4f(x: number, y: number, z: number, w: number, epsilon?: number): boolean

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

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
- w: number
  
  The w 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/vec4.ts:839
计算向量的长度（模）。

Returns number

Length of vector

lengthSqr

lengthSqr(): number

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

Returns number

the squared length of this vector

lerp

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

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

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

multiply

multiply(other: Vec4): this

- Defined in cocos/core/math/vec4.ts:743
向量乘法。将当前向量乘以指定向量

Parameters
- other: Vec4
  
  specified vector
Returns this

multiply4f

multiply4f(x: number, y: number, z: number, w: number): this

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

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
- w: number
  
  The w value of specified vector
Returns this

multiplyScalar

multiplyScalar(scalar: number): this

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

Parameters
- scalar: number
  
  scalar number
Returns this

negative

negative(): this

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

Returns this

normalize

normalize(): this

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

Returns this

set

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

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

Parameters
- other: Vec4
  
  Specified vector
Returns any

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

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

this

strictEquals

strictEquals(other: Vec4): boolean

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

Parameters
- other: Vec4
  
  specified vector
Returns boolean

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

strictEquals4f

strictEquals4f(x: number, y: number, z: number, w: number): boolean

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

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
- w: number
  
  The w 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: Vec4): this

- Defined in cocos/core/math/vec4.ts:700
向量减法。将当前向量减去指定向量

Parameters
- other: Vec4
  
  specified vector
Returns this

subtract4f

subtract4f(x: number, y: number, z: number, w: number): this

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

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
- w: number
  
  The w value of specified vector
Returns this

toString

toString(): string

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

Returns string

The string with vector information

transformMat4

transformMat4(matrix: Mat4): this

- Defined in cocos/core/math/vec4.ts:885
应用四维矩阵变换到当前矩阵

Parameters
- matrix: Mat4
  
  matrix to transform with
Returns this

Static add

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

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

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

Static ceil

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

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

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

Static clone

clone<Out>(a: Out): Vec4

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

Type parameters
- Out: IVec4Like
Parameters
- a: Out
Returns Vec4

Static copy

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

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

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

Static distance

distance<Out>(a: Out, b: Out): number

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

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

Static divide

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

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

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

Static dot

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

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

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

Static equals

equals<Out>(a: Out, b: Out, epsilon?: number): boolean

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

Type parameters
- Out: IVec4Like
Parameters
- a: Out
- b: Out
- Default value epsilon: number = EPSILON
Returns boolean

Static floor

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

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

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

Static fromArray

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

- Defined in cocos/core/math/vec4.ts:458
数组转向量

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

Static inverse

inverse<Out>(out: Out, a: Out): Out

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

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

Static inverseSafe

inverseSafe<Out>(out: Out, a: Out): Out

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

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

Static len

len<Out>(a: Out): number

- Defined in cocos/core/math/vec4.ts:241
求向量长度

Type parameters
- Out: IVec4Like
Parameters
- a: Out
Returns number

Static lengthSqr

lengthSqr<Out>(a: Out): number

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

Type parameters
- Out: IVec4Like
Parameters
- a: Out
Returns number

Static lerp

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

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

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

Static max

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

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

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

Static min

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

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

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

Static multiply

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

- Defined in cocos/core/math/vec4.ts:109
逐元素向量乘法

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

Static multiplyScalar

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

- Defined in cocos/core/math/vec4.ts:193
向量标量乘法

Type parameters
- Out: IVec4Like
Parameters
- out: Out
- a: Out
- b: number
Returns Out

Static negate

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

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

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

Static normalize

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

- Defined in cocos/core/math/vec4.ts:326
归一化向量

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

Static random

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

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

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

Static round

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

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

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

Static scaleAndAdd

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

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

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

Static set

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

- Defined in cocos/core/math/vec4.ts:73
设置向量值

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

Static squaredDistance

squaredDistance<Out>(a: Out, b: Out): number

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

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

Static strictEquals

strictEquals<Out>(a: Out, b: Out): boolean

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

Type parameters
- Out: IVec4Like
Parameters
- a: Out
- b: Out
Returns boolean

Static subtract

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

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

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

Static toArray

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

- Defined in cocos/core/math/vec4.ts:445
向量转数组

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

Static transformAffine

transformAffine<Out, VecLike, MatLike>(out: Out, v: VecLike, m: MatLike): Out

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

Type parameters
- Out: IVec4Like
- VecLike: IVec4Like
- MatLike: IMat4Like
Parameters
- out: Out
- v: VecLike
- m: MatLike
Returns Out

Static transformMat4

transformMat4<Out, MatLike>(out: Out, a: Out, m: MatLike): Out

- Defined in cocos/core/math/vec4.ts:385
向量与四维矩阵乘法

Type parameters
- Out: IVec4Like
- MatLike: IMat4Like
Parameters
- out: Out
- a: Out
- m: MatLike
Returns Out

Static transformQuat

transformQuat<Out, QuatLike>(out: Out, a: Out, q: QuatLike): Out

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

Type parameters
- Out: IVec4Like
- QuatLike: IQuatLike
Parameters
- out: Out
- a: Out
- q: QuatLike
Returns Out

Generated using TypeDoc