Vec3 类型

继承于 ValueType

模块: cc 父模块: cc

表示 3D 向量和坐标

索引

属性（properties）

• ONE Vec3 新 Vec3 对象。
• ZERO Vec3 返回 x = 0，y = 0，z = 0 的 Vec3 对象。
• UP Vec3 返回 x = 0, y = 1, z = 0 的 Vec3 对象。
• RIGHT Vec3 返回 x = 1，y = 0，z = 0 的 Vec3 对象。
• FORWARD Vec3 返回 x = 0，y = 0，z = 1 的 Vec3 对象。
• x Number
• y Number
• z Number

方法

• mag 返回该向量的长度。
• magSqr 返回该向量的长度平方。
• subSelf 向量减法。
• sub 向量减法，并返回新结果。
• mulSelf 缩放当前向量。
• mul 缩放向量，并返回新结果。
• divSelf 向量除法。
• div 向量除法，并返回新的结果。
• scaleSelf 分量相乘。
• scale 分量相乘，并返回新的结果。
• negSelf 向量取反。
• neg 返回取反后的新向量。
• zero 将目标赋值为零向量
• clone 获得指定向量的拷贝
• copy 复制目标向量
• set 设置向量值
• add 逐元素向量加法
• subtract 逐元素向量减法
• multiply 逐元素向量乘法 (分量积)
• divide 逐元素向量除法
• ceil 逐元素向量向上取整
• floor 逐元素向量向下取整
• min 逐元素向量最小值
• max 逐元素向量最大值
• round 逐元素向量四舍五入取整
• multiplyScalar 向量标量乘法
• scaleAndAdd 逐元素向量乘加: A + B * scale
• distance 求两向量的欧氏距离
• squaredDistance 求两向量的欧氏距离平方
• len 求向量长度
• lengthSqr 求向量长度平方
• negate 逐元素向量取负
• inverse 逐元素向量取倒数，接近 0 时返回 Infinity
• inverseSafe 逐元素向量取倒数，接近 0 时返回 0
• normalize 归一化向量
• dot 向量点积（数量积）
• cross 向量叉积（向量积）
• lerp 逐元素向量线性插值： A + t * (B - A)
• random 生成一个在单位球体上均匀分布的随机向量
• transformMat4 向量与四维矩阵乘法，默认向量第四位为 1。
• transformMat4Normal 向量与四维矩阵乘法，默认向量第四位为 0。
• transformMat3 向量与三维矩阵乘法
• transformAffine 向量仿射变换
• transformQuat 向量四元数乘法
• transformQuat 以缩放 -> 旋转 -> 平移顺序变换向量
• transformInverseRTS 以平移 -> 旋转 -> 缩放顺序逆变换向量
• rotateX 绕 X 轴旋转向量指定弧度
• rotateY 绕 Y 轴旋转向量指定弧度
• rotateZ 绕 Z 轴旋转向量指定弧度
• strictEquals 向量等价判断
• equals 排除浮点数误差的向量近似等价判断
• angle 求两向量夹角弧度
• projectOnPlane 计算向量在指定平面上的投影
• project 计算向量在指定向量上的投影
• toArray 向量转数组
• fromArray 数组转向量
• constructor 构造函数，可查看 Cc/vec3:method
• clone 克隆一个 Vec3 值
• set 用另一个向量设置当前的向量对象值。
• equals 当前的向量是否与指定的向量相等。
• fuzzyEquals 近似判断两个点是否相等。
• toString 转换为方便阅读的字符串。
• lerp 线性插值。
• clampf 返回指定限制区域后的向量。
• addSelf 向量加法。
• add 向量加法，并返回新结果。
• subtract 向量减法。
• multiplyScalar 缩放当前向量。
• multiply 分量相乘。
• divide 向量除法。
• negate 向量取反。
• dot 当前向量与指定向量进行点乘。
• cross 当前向量与指定向量进行叉乘。
• len 返回该向量的长度。
• lengthSqr 返回该向量的长度平方。
• normalizeSelf 向量归一化，让这个向量的长度为 1。
• normalize 返回归一化后的向量。
• transformMat4 Transforms the vec3 with a mat4. 4th vector component is implicitly '1'
• maxAxis Returns the maximum value in x, y, and z
• angle 夹角的弧度。
• project 返回当前向量在指定 vector 向量上的投影向量。
• signAngle 带方向的夹角的弧度。
• rotate 返回旋转给定弧度后的新向量。
• rotateSelf 按指定弧度旋转向量。

Details

属性（properties）

ONE

新 Vec3 对象。

ZERO

返回 x = 0，y = 0，z = 0 的 Vec3 对象。

UP

返回 x = 0, y = 1, z = 0 的 Vec3 对象。

RIGHT

返回 x = 1，y = 0，z = 0 的 Vec3 对象。

FORWARD

返回 x = 0，y = 0，z = 1 的 Vec3 对象。

x

y

z

方法

mag

返回该向量的长度。

示例

var v = cc.v3(10, 10, 10);
v.mag(); // return 17.320508075688775;

magSqr

返回该向量的长度平方。

subSelf

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

参数列表

• vector Vec3

sub

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

参数列表

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

mulSelf

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

参数列表

• num number

mul

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

参数列表

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

divSelf

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

参数列表

• num number

div

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

参数列表

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

scaleSelf

分量相乘。

参数列表

• vector Vec3

scale

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

参数列表

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

negSelf

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

neg

返回取反后的新向量。

参数列表

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

zero

将目标赋值为零向量

clone

获得指定向量的拷贝

copy

复制目标向量

set

设置向量值

add

逐元素向量加法

subtract

逐元素向量减法

multiply

逐元素向量乘法 (分量积)

divide

逐元素向量除法

ceil

逐元素向量向上取整

floor

逐元素向量向下取整

min

逐元素向量最小值

max

逐元素向量最大值

round

逐元素向量四舍五入取整

multiplyScalar

向量标量乘法

scaleAndAdd

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

distance

求两向量的欧氏距离

squaredDistance

求两向量的欧氏距离平方

len

求向量长度

lengthSqr

求向量长度平方

negate

逐元素向量取负

inverse

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

inverseSafe

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

normalize

归一化向量

dot

向量点积（数量积）

cross

向量叉积（向量积）

lerp

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

random

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

参数列表

• scale Unknown 生成的向量长度

transformMat4

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

transformMat4Normal

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

transformMat3

向量与三维矩阵乘法

transformAffine

向量仿射变换

transformQuat

向量四元数乘法

transformQuat

以缩放 -> 旋转 -> 平移顺序变换向量

transformInverseRTS

以平移 -> 旋转 -> 缩放顺序逆变换向量

rotateX

绕 X 轴旋转向量指定弧度

参数列表

• v Unknown 待旋转向量
• o Unknown 旋转中心
• a Unknown 旋转弧度

rotateY

绕 Y 轴旋转向量指定弧度

参数列表

• v Unknown 待旋转向量
• o Unknown 旋转中心
• a Unknown 旋转弧度

rotateZ

绕 Z 轴旋转向量指定弧度

参数列表

• v Unknown 待旋转向量
• o Unknown 旋转中心
• a Unknown 旋转弧度

strictEquals

向量等价判断

equals

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

angle

求两向量夹角弧度

projectOnPlane

计算向量在指定平面上的投影

参数列表

• a Unknown 待投影向量
• n Unknown 指定平面的法线

project

计算向量在指定向量上的投影

参数列表

• a Unknown 待投影向量
• n Unknown 目标向量

toArray

向量转数组

参数列表

• ofs Unknown 数组起始偏移量

fromArray

数组转向量

参数列表

• ofs Unknown 数组起始偏移量

constructor

构造函数，可查看 Cc/vec3:method

参数列表

• x Vec3 | number
• y number
• z number

clone

克隆一个 Vec3 值

set

用另一个向量设置当前的向量对象值。

参数列表

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

equals

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

参数列表

• other Vec3

fuzzyEquals

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

参数列表

• other Vec3
• variance Number

toString

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

lerp

线性插值。

参数列表

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

clampf

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

参数列表

• min_inclusive Vec3
• max_inclusive Vec3

addSelf

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

参数列表

• vector Vec3

add

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

参数列表

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

subtract

向量减法。

参数列表

• vector Vec3

multiplyScalar

缩放当前向量。

参数列表

• num number

multiply

分量相乘。

参数列表

• vector Vec3

divide

向量除法。

参数列表

• num number

negate

向量取反。

dot

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

参数列表

• vector Vec3

cross

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

参数列表

• vector Vec3
• out Vec3

len

返回该向量的长度。

示例

var v = cc.v3(10, 10, 10);
v.len(); // return 17.320508075688775;

lengthSqr

返回该向量的长度平方。

normalizeSelf

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

normalize

返回归一化后的向量。

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

参数列表

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

transformMat4

Transforms the vec3 with a mat4. 4th vector component is implicitly '1'

参数列表

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

maxAxis

Returns the maximum value in x, y, and z

angle

夹角的弧度。

参数列表

• vector Vec3

project

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

参数列表

• vector Vec3

示例

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

signAngle

带方向的夹角的弧度。该方法仅用做兼容 2D 计算。

参数列表

• vector Vec3 | Vec2

rotate

返回旋转给定弧度后的新向量。该方法仅用做兼容 2D 计算。

参数列表

• radians number
• out Vec3 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

按指定弧度旋转向量。该方法仅用做兼容 2D 计算。

参数列表

• radians number