Vec2 类型

继承于 ValueType

模块: cc 父模块: cc

表示 2D 向量和坐标

索引

属性（properties）

• x Number
• y Number
• ONE Vec2 新 Vec2 对象。
• ZERO Vec2 返回 x = 0 和 y = 0 的 Vec2 对象。
• UP Vec2 返回 x = 0 和 y = 1 的 Vec2 对象。
• RIGHT Vec2 返回 x = 1 和 y = 0 的 Vec2 对象。

方法

• constructor 构造函数，可查看 Cc/vec2:method 或者 cc.p
• clone 克隆一个 Vec2 对象
• set 设置向量值。
• equals 当前的向量是否与指定的向量相等。
• fuzzyEquals 近似判断两个点是否相等。
• toString 转换为方便阅读的字符串。
• lerp 线性插值。
• clampf 返回指定限制区域后的向量。
• addSelf 向量加法。
• add 向量加法，并返回新结果。
• subSelf 向量减法。
• sub 向量减法，并返回新结果。
• mulSelf 缩放当前向量。
• mul 缩放向量，并返回新结果。
• scaleSelf 分量相乘。
• scale 分量相乘，并返回新的结果。
• divSelf 向量除法。
• div 向量除法，并返回新的结果。
• negSelf 向量取反。
• neg 返回取反后的新向量。
• dot 当前向量与指定向量进行点乘。
• cross 当前向量与指定向量进行叉乘。
• mag 返回该向量的长度。
• magSqr 返回该向量的长度平方。
• normalizeSelf 向量归一化，让这个向量的长度为 1。
• normalize 返回归一化后的向量。
• angle 夹角的弧度。
• signAngle 带方向的夹角的弧度。
• rotate 返回旋转给定弧度后的新向量。
• rotateSelf 按指定弧度旋转向量。
• project 返回当前向量在指定 vector 向量上的投影向量。
• transformMat4 Transforms the vec2 with a mat4. 3rd vector component is implicitly '0', 4th vector component is implicitly '1'

Details

属性（properties）

x

y

ONE

新 Vec2 对象。

ZERO

返回 x = 0 和 y = 0 的 Vec2 对象。

UP

返回 x = 0 和 y = 1 的 Vec2 对象。

RIGHT

返回 x = 1 和 y = 0 的 Vec2 对象。

方法

constructor

构造函数，可查看 Cc/vec2:method 或者 cc.p

参数列表

• x number
• y number

clone

克隆一个 Vec2 对象

set

设置向量值。

参数列表

• newValue Vec2 !#en new value to set. !#zh 要设置的新值

equals

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

参数列表

• other Vec2

fuzzyEquals

近似判断两个点是否相等。
判断 2 个向量是否在指定数值的范围之内，如果在则返回 true，反之则返回 false。

参数列表

• other Vec2
• variance Number

toString

转换为方便阅读的字符串。

lerp

线性插值。

参数列表

• to Vec2
• ratio number the interpolation coefficient
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

clampf

返回指定限制区域后的向量。
向量大于 max_inclusive 则返回 max_inclusive。
向量小于 min_inclusive 则返回 min_inclusive。
否则返回自身。

参数列表

• min_inclusive Vec2
• max_inclusive Vec2

示例

var min_inclusive = cc.v2(0, 0);
var max_inclusive = cc.v2(20, 20);
var v1 = cc.v2(20, 20).clampf(min_inclusive, max_inclusive); // Vec2 {x: 20, y: 20};
var v2 = cc.v2(0, 0).clampf(min_inclusive, max_inclusive);   // Vec2 {x: 0, y: 0};
var v3 = cc.v2(10, 10).clampf(min_inclusive, max_inclusive); // Vec2 {x: 10, y: 10};

addSelf

向量加法。如果你想保存结果到另一个向量，使用 add() 代替。

参数列表

• vector Vec2

示例

var v = cc.v2(10, 10);
v.addSelf(cc.v2(5, 5));// return Vec2 {x: 15, y: 15};

add

向量加法，并返回新结果。

参数列表

• vector Vec2
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

示例

var v = cc.v2(10, 10);
v.add(cc.v2(5, 5));      // return Vec2 {x: 15, y: 15};
var v1;
v.add(cc.v2(5, 5), v1);  // return Vec2 {x: 15, y: 15};

subSelf

向量减法。如果你想保存结果到另一个向量，可使用 sub() 代替。

参数列表

• vector Vec2

示例

var v = cc.v2(10, 10);
v.subSelf(cc.v2(5, 5));// return Vec2 {x: 5, y: 5};

sub

向量减法，并返回新结果。

参数列表

• vector Vec2
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

示例

var v = cc.v2(10, 10);
v.sub(cc.v2(5, 5));      // return Vec2 {x: 5, y: 5};
var v1;
v.sub(cc.v2(5, 5), v1);  // return Vec2 {x: 5, y: 5};

mulSelf

缩放当前向量。如果你想结果保存到另一个向量，可使用 mul() 代替。

参数列表

• num number

示例

var v = cc.v2(10, 10);
v.mulSelf(5);// return Vec2 {x: 50, y: 50};

mul

缩放向量，并返回新结果。

参数列表

• num number
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

示例

var v = cc.v2(10, 10);
v.mul(5);      // return Vec2 {x: 50, y: 50};
var v1;
v.mul(5, v1);  // return Vec2 {x: 50, y: 50};

scaleSelf

分量相乘。

参数列表

• vector Vec2

示例

var v = cc.v2(10, 10);
v.scaleSelf(cc.v2(5, 5));// return Vec2 {x: 50, y: 50};

scale

分量相乘，并返回新的结果。

参数列表

• vector Vec2
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

示例

var v = cc.v2(10, 10);
v.scale(cc.v2(5, 5));      // return Vec2 {x: 50, y: 50};
var v1;
v.scale(cc.v2(5, 5), v1);  // return Vec2 {x: 50, y: 50};

divSelf

向量除法。如果你想结果保存到另一个向量，可使用 div() 代替。

参数列表

• num number

示例

var v = cc.v2(10, 10);
v.divSelf(5); // return Vec2 {x: 2, y: 2};

div

向量除法，并返回新的结果。

参数列表

• num number
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

示例

var v = cc.v2(10, 10);
v.div(5);      // return Vec2 {x: 2, y: 2};
var v1;
v.div(5, v1);  // return Vec2 {x: 2, y: 2};

negSelf

向量取反。如果你想结果保存到另一个向量，可使用 neg() 代替。

示例

var v = cc.v2(10, 10);
v.negSelf(); // return Vec2 {x: -10, y: -10};

neg

返回取反后的新向量。

参数列表

• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

示例

var v = cc.v2(10, 10);
var v1;
v.neg(v1);  // return Vec2 {x: -10, y: -10};

dot

当前向量与指定向量进行点乘。

参数列表

• vector Vec2

示例

var v = cc.v2(10, 10);
v.dot(cc.v2(5, 5)); // return 100;

cross

当前向量与指定向量进行叉乘。

参数列表

• vector Vec2

示例

var v = cc.v2(10, 10);
v.cross(cc.v2(5, 5)); // return 0;

mag

返回该向量的长度。

示例

var v = cc.v2(10, 10);
v.mag(); // return 14.142135623730951;

magSqr

返回该向量的长度平方。

示例

var v = cc.v2(10, 10);
v.magSqr(); // return 200;

normalizeSelf

向量归一化，让这个向量的长度为 1。

示例

var v = cc.v2(10, 10);
v.normalizeSelf(); // return Vec2 {x: 0.7071067811865475, y: 0.7071067811865475};

normalize

返回归一化后的向量。

注意，当前向量不变，并返回一个新的归一化向量。如果你想来归一化当前向量，可使用 normalizeSelf 函数。

参数列表

• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

angle

夹角的弧度。

参数列表

• vector Vec2

signAngle

带方向的夹角的弧度。

参数列表

• vector Vec2

rotate

返回旋转给定弧度后的新向量。

参数列表

• radians number
• out Vec2 optional, the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created

rotateSelf

按指定弧度旋转向量。

参数列表

• radians number

project

返回当前向量在指定 vector 向量上的投影向量。

参数列表

• vector Vec2

示例

var v1 = cc.v2(20, 20);
var v2 = cc.v2(5, 5);
v1.project(v2); // Vec2 {x: 20, y: 20};

transformMat4

Transforms the vec2 with a mat4. 3rd vector component is implicitly '0', 4th vector component is implicitly '1'

参数列表

• m Mat4 matrix to transform with
• out Vec2 the receiving vector, you can pass the same vec2 to save result to itself, if not provided, a new vec2 will be created