Cocos Creator 3.7 API

类: Vec2

extend: size

导入示例：

import { math } from "cc"; 
const { Vec2 } = math;

二维向量。

索引

构造函数

Vec2 public
Vec2 public

静态属性

ZERO static

UNIT_Y static

UNIT_X static

ONE static

NEG_ONE static

静态方法

transformMat4 static

向量与四维矩阵乘法，默认向量第三位为 0，第四位为 1。

transformMat3 static

向量与三维矩阵乘法，默认向量第三位为 1。

toArray static

向量转数组

subtract static

逐元素向量减法

strictEquals static

向量等价判断

str static

返回向量的字符串表示

squaredDistance static

求两向量的欧氏距离平方

set static

设置向量值

scaleAndAdd static

逐元素向量乘加: A + B * scale

round static

逐元素向量四舍五入取整

random static

生成一个在单位圆上均匀分布的随机向量

normalize static

归一化向量，输入零向量将会返回零向量。

negate static

逐元素向量取负

multiplyScalar static

向量标量乘法

multiply static

逐元素向量乘法

min static

逐元素向量最小值

max static

逐元素向量最大值

lerp static

逐元素向量线性插值： A + t * (B - A)

lengthSqr static

求向量长度平方

len static

求向量长度

inverseSafe static

逐元素向量取倒数，接近 0 时返回 0

inverse static

逐元素向量取倒数，接近 0 时返回 Infinity

fromArray static

数组转向量

floor static

逐元素向量向下取整

equals static

排除浮点数误差的向量近似等价判断

dot static

向量点积（数量积）

divide static

逐元素向量除法

distance static

求两向量的欧氏距离

cross static

向量叉积（向量积），注意二维向量的叉积为与 Z 轴平行的三维向量

copy static

复制目标向量

clone static

获得指定向量的拷贝

ceil static

逐元素向量向上取整

angle static

求两向量夹角弧度，任意一个向量是零向量则返回零。

add static

逐元素向量加法

属性

y public

y 分量。

x public

x 分量。

方法

transformMat4 public

将当前向量视为 z 分量为 0、w 分量为 1 的四维向量，
应用四维矩阵变换到当前矩阵

subtract2f public

向量减法。将当前向量减去指定分量的向量

subtract public

向量减法。将当前向量减去指定向量

strictEquals2f public

判断当前向量是否与指定分量的向量相等。

strictEquals public

判断当前向量是否与指定向量相等。

signAngle public

获取当前向量和指定向量之间的有符号角度。
有符号角度的取值范围为 (-180, 180]，当前向量可以通过逆时针旋转有符号角度与指定向量同向。

rotate public

将当前向量的旋转

project public

计算当前向量在指定向量上的投影向量。

normalize public

将当前向量归一化。

negative public

将当前向量的各个分量取反

multiplyScalar public

向量数乘。将当前向量数乘指定标量

multiply2f public

向量乘法。将当前向量与指定分量的向量相乘的结果赋值给当前向量。

multiply public

向量乘法。将当前向量乘以与指定向量的结果赋值给当前向量。

lerp public

根据指定的插值比率，从当前向量到目标向量之间做插值。

lengthSqr public

计算向量长度（模）的平方。

length public

计算向量的长度（模）。

equals2f public

判断当前向量是否在误差范围内与指定分量的向量相等。

dot public

向量点乘。

divide2f public

向量逐元素相除。将当前向量与指定分量的向量相除的结果赋值给当前向量。

divide public

向量逐元素相除。将当前向量与指定分量的向量相除的结果赋值给当前向量。

cross public

向量叉乘。

clampf public

设置当前向量的值，使其各个分量都处于指定的范围内。

angle public

获取当前向量和指定向量之间的角度，任意一个向量是零向量则返回零。

add2f public

向量加法。将当前向量与指定分量的向量相加

add public

向量加法。将当前向量与指定向量的相加

继承方法

toString public

返回当前向量的字符串表示。

set public

设置当前向量使其与指定向量相等。

equals public

判断当前向量是否在误差范围内与指定向量相等。

clone public

克隆当前向量。

详情

构造函数

public Vec2 (other : Vec2) : Vec2

输入参数

名称	类型	描述
`other`	Vec2	-

返回值： Vec2

public Vec2 (x ?: number, y ?: number) : Vec2

输入参数

名称	类型	描述
`x`	number	-
`y`	number	-

返回值： Vec2

静态属性

public ZERO : Readonly < Vec2 >

static

Defined in cocos/core/math/vec2.ts:40

public UNIT_Y : Readonly < Vec2 >

static

Defined in cocos/core/math/vec2.ts:44

public UNIT_X : Readonly < Vec2 >

static

Defined in cocos/core/math/vec2.ts:43

public ONE : Readonly < Vec2 >

static

Defined in cocos/core/math/vec2.ts:41

public NEG_ONE : Readonly < Vec2 >

static

Defined in cocos/core/math/vec2.ts:42

静态方法

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

static

向量与四维矩阵乘法，默认向量第三位为 0，第四位为 1。

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-
`m`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:358

public transformMat3 <Out extends dot , MatLike extends IMat3Like> (out : _planeBias, a : _planeBias, m : IMat3Like) : _planeBias

static

向量与三维矩阵乘法，默认向量第三位为 1。

输入参数

名称	类型	描述
`out`	_planeBias	-
`a`	_planeBias	-
`m`	IMat3Like	-

返回值： _planeBias

Defined in cocos/core/math/vec2.ts:346

public toArray <Out extends IWritableArrayLike < number, Out >> (out : Out, v : dot, ofs ?: number) : Out

static

向量转数组

输入参数

名称	类型	描述
`out`	Out	-
`v`	dot	-
`ofs`	number	Array Start Offset

返回值： Out

Defined in cocos/core/math/vec2.ts:379

public subtract <Out extends dot> (out : _globalDSManager, a : _globalDSManager, b : _globalDSManager) : _globalDSManager

static

逐元素向量减法

输入参数

名称	类型	描述
`out`	_globalDSManager	-
`a`	_globalDSManager	-
`b`	_globalDSManager	-

返回值： _globalDSManager

Defined in cocos/core/math/vec2.ts:88

public strictEquals <Out extends dot> (a : Out, b : Out) : boolean

static

向量等价判断

输入参数

名称	类型	描述
`a`	Out	-
`b`	Out	-

返回值： boolean

Defined in cocos/core/math/vec2.ts:400

public str <Out extends dot> (a : Out) : string

static

返回向量的字符串表示

输入参数

名称	类型	描述
`a`	Out	-

返回值： string

Defined in cocos/core/math/vec2.ts:370

public squaredDistance <Out extends dot> (a : LEVEL_1, b : LEVEL_1) : number

static

求两向量的欧氏距离平方

输入参数

名称	类型	描述
`a`	LEVEL_1	-
`b`	LEVEL_1	-

返回值： number

Defined in cocos/core/math/vec2.ts:198

public set <Out extends dot> (out : diffuseMap, x : number, y : number) : diffuseMap

static

设置向量值

输入参数

名称	类型	描述
`out`	diffuseMap	-
`x`	number	-
`y`	number	-

返回值： diffuseMap

Defined in cocos/core/math/vec2.ts:68

public scaleAndAdd <Out extends dot> (out : ShadowType, a : ShadowType, b : ShadowType, scale : number) : ShadowType

static

逐元素向量乘加: A + B * scale

输入参数

名称	类型	描述
`out`	ShadowType	-
`a`	ShadowType	-
`b`	ShadowType	-
`scale`	number	-

返回值： ShadowType

Defined in cocos/core/math/vec2.ts:178

public round <Out extends dot> (out : Out, a : Out) : Out

static

逐元素向量四舍五入取整

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:158

public random <Out extends dot> (out : _material, scale ?: number) : _material

static

生成一个在单位圆上均匀分布的随机向量

输入参数

名称	类型	描述
`out`	_material	-
`scale`	number	vector length

返回值： _material

Defined in cocos/core/math/vec2.ts:334

public normalize <Out extends dot , Vec2Like extends dot> (out : Out, a : Vec2Like) : Out

static

归一化向量，输入零向量将会返回零向量。

输入参数

名称	类型	描述
`out`	Out	-
`a`	Vec2Like	-

返回值： Out

Defined in cocos/core/math/vec2.ts:271

public negate <Out extends dot> (out : Out, a : Out) : Out

static

逐元素向量取负

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:228

public multiplyScalar <Out extends dot> (out : ShadowSize, a : ShadowSize, b : number) : ShadowSize

static

向量标量乘法

输入参数

名称	类型	描述
`out`	ShadowSize	-
`a`	ShadowSize	-
`b`	number	-

返回值： ShadowSize

Defined in cocos/core/math/vec2.ts:168

public multiply <Out extends dot> (out : _useDiffuseMap, a : _useDiffuseMap, b : _useDiffuseMap) : _useDiffuseMap

static

逐元素向量乘法

输入参数

名称	类型	描述
`out`	_useDiffuseMap	-
`a`	_useDiffuseMap	-
`b`	_useDiffuseMap	-

返回值： _useDiffuseMap

Defined in cocos/core/math/vec2.ts:98

public min <Out extends dot> (out : Out, a : Out, b : Out) : Out

static

逐元素向量最小值

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-
`b`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:138

public max <Out extends dot> (out : Out, a : Out, b : Out) : Out

static

逐元素向量最大值

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-
`b`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:148

public lerp <Out extends dot> (out : material, a : material, b : material, t : number) : material

static

逐元素向量线性插值： A + t * (B - A)

输入参数

名称	类型	描述
`out`	material	-
`a`	material	-
`b`	material	-
`t`	number	-

返回值： material

Defined in cocos/core/math/vec2.ts:321

public lengthSqr <Out extends dot> (a : Shadows) : number

static

求向量长度平方

输入参数

名称	类型	描述
`a`	Shadows	-

返回值： number

Defined in cocos/core/math/vec2.ts:218

public len <Out extends dot> (a : Out) : number

static

求向量长度

输入参数

名称	类型	描述
`a`	Out	-

返回值： number

Defined in cocos/core/math/vec2.ts:208

public inverseSafe <Out extends dot> (out : Out, a : Out) : Out

static

逐元素向量取倒数，接近 0 时返回 0

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:248

public inverse <Out extends dot> (out : type, a : type) : type

static

逐元素向量取倒数，接近 0 时返回 Infinity

输入参数

名称	类型	描述
`out`	type	-
`a`	type	-

返回值： type

Defined in cocos/core/math/vec2.ts:238

public fromArray <Out extends dot> (out : Fog, arr : IWritableArrayLike < number >, ofs ?: number) : Fog

static

数组转向量

输入参数

名称	类型	描述
`out`	Fog	-
`arr`	IWritableArrayLike < number >	-
`ofs`	number	Array Start Offset

返回值： Fog

Defined in cocos/core/math/vec2.ts:390

public floor <Out extends dot> (out : setSkyboxMaterial, a : setSkyboxMaterial) : setSkyboxMaterial

static

逐元素向量向下取整

输入参数

名称	类型	描述
`out`	setSkyboxMaterial	-
`a`	setSkyboxMaterial	-

返回值： setSkyboxMaterial

Defined in cocos/core/math/vec2.ts:128

public equals <Out extends dot> (a : fogColor, b : fogColor, epsilon ?: number) : boolean

static

排除浮点数误差的向量近似等价判断

输入参数

名称	类型	描述
`a`	fogColor	-
`b`	fogColor	-
`epsilon`	number	-

返回值： boolean

Defined in cocos/core/math/vec2.ts:408

public dot <Out extends dot> (a : shadowColor, b : shadowColor) : number

static

向量点积（数量积）

输入参数

名称	类型	描述
`a`	shadowColor	-
`b`	shadowColor	-

返回值： number

Defined in cocos/core/math/vec2.ts:290

public divide <Out extends dot> (out : initialize, a : initialize, b : initialize) : initialize

static

逐元素向量除法

输入参数

名称	类型	描述
`out`	initialize	-
`a`	initialize	-
`b`	initialize	-

返回值： initialize

Defined in cocos/core/math/vec2.ts:108

public distance <Out extends dot> (a : SOFT, b : SOFT) : number

static

求两向量的欧氏距离

输入参数

名称	类型	描述
`a`	SOFT	-
`b`	SOFT	-

返回值： number

Defined in cocos/core/math/vec2.ts:188

public cross (a : dot, b : dot) : number

static

向量叉积（向量积），注意二维向量的叉积为与 Z 轴平行的三维向量

输入参数

名称	类型	描述
`a`	dot	-
`b`	dot	-

返回值： number

public cross <Out extends dot> (out : baked, a : shadowMapDirty, b : shadowMapDirty) : baked

static

输入参数

名称	类型	描述
`out`	baked	-
`a`	shadowMapDirty	-
`b`	shadowMapDirty	-

返回值： baked

Defined in cocos/core/math/vec2.ts:300

public copy <Out extends dot> (out : Out, a : Out) : Out

static

复制目标向量

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:58

public clone <Out extends dot> (a : Out) : Vec2

static

获得指定向量的拷贝

输入参数

名称	类型	描述
`a`	Out	-

返回值： Vec2

Defined in cocos/core/math/vec2.ts:50

public ceil <Out extends dot> (out : Out, a : Out) : Out

static

逐元素向量向上取整

输入参数

名称	类型	描述
`out`	Out	-
`a`	Out	-

返回值： Out

Defined in cocos/core/math/vec2.ts:118

public angle <Out extends dot> (a : Out, b : Out) : number

static

求两向量夹角弧度，任意一个向量是零向量则返回零。

输入参数

名称	类型	描述
`a`	Out	-
`b`	Out	-

返回值： number

Defined in cocos/core/math/vec2.ts:421

public add <Out extends dot> (out : editableMaterial, a : editableMaterial, b : editableMaterial) : editableMaterial

static

逐元素向量加法

输入参数

名称	类型	描述
`out`	editableMaterial	-
`a`	editableMaterial	-
`b`	editableMaterial	-

返回值： editableMaterial

Defined in cocos/core/math/vec2.ts:78

属性

public y : number

y 分量。

Defined in cocos/core/math/vec2.ts:445

public x : number

x 分量。

Defined in cocos/core/math/vec2.ts:439

方法

public transformMat4 (matrix : Mat4) : Vec2

将当前向量视为 z 分量为 0、w 分量为 1 的四维向量，
应用四维矩阵变换到当前矩阵

输入参数

名称	类型	描述
`matrix`	Mat4	matrix to transform with

返回值： Vec2

Defined in cocos/core/math/vec2.ts:823

public subtract2f (x : number, y : number) : Vec2

向量减法。将当前向量减去指定分量的向量

输入参数

名称	类型	描述
`x`	number	The x value of specified vector
`y`	number	The y value of specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:628

public subtract (other : Vec2) : Vec2

向量减法。将当前向量减去指定向量

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:616

public strictEquals2f (x : number, y : number) : boolean

判断当前向量是否与指定分量的向量相等。

输入参数

名称	类型	描述
`x`	number	The x value of specified vector
`y`	number	The y value of specified vector

返回值： boolean

Defined in cocos/core/math/vec2.ts:548

public strictEquals (other : Vec2) : boolean

判断当前向量是否与指定向量相等。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： boolean

Defined in cocos/core/math/vec2.ts:537

public signAngle (other : Vec2) : number

获取当前向量和指定向量之间的有符号角度。
有符号角度的取值范围为 (-180, 180]，当前向量可以通过逆时针旋转有符号角度与指定向量同向。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： number

Defined in cocos/core/math/vec2.ts:784

public rotate (radians : number) : Vec2

将当前向量的旋转

输入参数

名称	类型	描述
`radians`	number	radius of rotation

返回值： Vec2

Defined in cocos/core/math/vec2.ts:794

public project (other : Vec2) : Vec2

计算当前向量在指定向量上的投影向量。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:810

public normalize () : Vec2

将当前向量归一化。

返回值： Vec2

Defined in cocos/core/math/vec2.ts:745

public negative () : Vec2

将当前向量的各个分量取反

返回值： Vec2

Defined in cocos/core/math/vec2.ts:697

public multiplyScalar (scalar : number) : Vec2

向量数乘。将当前向量数乘指定标量

输入参数

名称	类型	描述
`scalar`	number	scalar number

返回值： Vec2

Defined in cocos/core/math/vec2.ts:639

public multiply2f (x : number, y : number) : Vec2

向量乘法。将当前向量与指定分量的向量相乘的结果赋值给当前向量。

输入参数

名称	类型	描述
`x`	number	The x value of specified vector
`y`	number	The y value of specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:664

public multiply (other : Vec2) : Vec2

向量乘法。将当前向量乘以与指定向量的结果赋值给当前向量。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:651

public lerp (to : Vec2, ratio : number) : Vec2

根据指定的插值比率，从当前向量到目标向量之间做插值。

输入参数

名称	类型	描述
`to`	Vec2	Target vector
`ratio`	number	The interpolation coefficient.The range is [0,1].

返回值： Vec2

Defined in cocos/core/math/vec2.ts:567

public lengthSqr () : number

计算向量长度（模）的平方。

返回值： number

Defined in cocos/core/math/vec2.ts:737

public length () : number

计算向量的长度（模）。

返回值： number

Defined in cocos/core/math/vec2.ts:728

public equals2f (x : number, y : number, epsilon ?: number) : boolean

判断当前向量是否在误差范围内与指定分量的向量相等。

输入参数

名称	类型	描述
`x`	number	The x value of specified vector
`y`	number	The y value of specified vector
`epsilon`	number	The error allowed. It`s should be a non-negative number.

返回值： boolean

Defined in cocos/core/math/vec2.ts:522

public dot (other : Vec2) : number

向量点乘。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： number

Defined in cocos/core/math/vec2.ts:709

public divide2f (x : number, y : number) : Vec2

向量逐元素相除。将当前向量与指定分量的向量相除的结果赋值给当前向量。

输入参数

名称	类型	描述
`x`	number	The x value of specified vector
`y`	number	The y value of specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:687

public divide (other : Vec2) : Vec2

向量逐元素相除。将当前向量与指定分量的向量相除的结果赋值给当前向量。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:675

public cross (other : Vec2) : number

向量叉乘。

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： number

Defined in cocos/core/math/vec2.ts:719

public clampf (minInclusive : Vec2, maxInclusive : Vec2) : Vec2

设置当前向量的值，使其各个分量都处于指定的范围内。

输入参数

名称	类型	描述
`minInclusive`	Vec2	Minimum value allowed
`maxInclusive`	Vec2	Maximum value allowed

返回值： Vec2

Defined in cocos/core/math/vec2.ts:582

public angle (other : Vec2) : number

获取当前向量和指定向量之间的角度，任意一个向量是零向量则返回零。

输入参数

名称	类型	描述
`other`	Vec2	specified vector.

返回值： number

Defined in cocos/core/math/vec2.ts:763

public add2f (x : number, y : number) : Vec2

向量加法。将当前向量与指定分量的向量相加

输入参数

名称	类型	描述
`x`	number	The x value of specified vector
`y`	number	The y value of specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:605

public add (other : Vec2) : Vec2

向量加法。将当前向量与指定向量的相加

输入参数

名称	类型	描述
`other`	Vec2	specified vector

返回值： Vec2

Defined in cocos/core/math/vec2.ts:593

继承方法

public toString () : string

返回当前向量的字符串表示。

返回值： string

Defined in cocos/core/math/vec2.ts:557

public set (other : Vec2) : Vec2

设置当前向量使其与指定向量相等。

输入参数

名称	类型	描述
`other`	Vec2	Specified vector

返回值： Vec2

public set (x ?: number, y ?: number) : Vec2

设置当前向量的具体分量值。

输入参数

名称	类型	描述
`x`	number	x value
`y`	number	y value

返回值： Vec2

Defined in cocos/core/math/vec2.ts:476

public equals (other : Vec2, epsilon ?: number) : boolean

判断当前向量是否在误差范围内与指定向量相等。

输入参数

名称	类型	描述
`other`	Vec2	Specified vector
`epsilon`	number	The error allowed. It`s should be a non-negative number.

返回值： boolean

Defined in cocos/core/math/vec2.ts:505

public clone () : Vec2

克隆当前向量。

返回值： Vec2

Defined in cocos/core/math/vec2.ts:466

索引

构造函数

Vec2 public
Vec2 public

静态属性

ZERO static

UNIT_Y static

UNIT_X static

ONE static

NEG_ONE static

静态方法

transformMat4 static

transformMat3 static

toArray static

subtract static

strictEquals static

str static

squaredDistance static

set static

scaleAndAdd static

round static

random static

normalize static

negate static

multiplyScalar static

multiply static

min static

max static

lerp static

lengthSqr static

len static

inverseSafe static

inverse static

fromArray static

floor static

equals static

dot static

divide static

distance static

cross static

copy static

clone static

ceil static

angle static

add static

属性

y public

x public

方法

transformMat4 public

subtract2f public

subtract public

strictEquals2f public

strictEquals public

signAngle public

rotate public

project public

normalize public

negative public

multiplyScalar public

multiply2f public

multiply public

lerp public

lengthSqr public

length public

equals2f public

dot public

divide2f public

divide public

cross public

clampf public

angle public

add2f public

add public

继承方法

toString public

set public

equals public

clone public