Vec3 Class

Extends ValueType

Module: cc Parent Module: cc

Representation of 3D vectors and points.

Index

Properties

• x Number
• y Number
• z Number
• ONE Vec3 return a Vec3 object with x = 1, y = 1, z = 1.
• ZERO Vec3 return a Vec3 object with x = 0, y = 0, z = 0.
• UP Vec3 return a Vec3 object with x = 0, y = 1, z = 0.
• RIGHT Vec3 return a Vec3 object with x = 1, y = 0, z = 0.
• FRONT Vec3 return a Vec3 object with x = 0, y = 0, z = 1.

Methods

• constructor Constructor
• clone clone a Vec3 value
• set Set the current vector value with the given vector.
• equals Check whether the vector equals another one
• fuzzyEquals Check whether two vector equal with some degree of variance.
• toString Transform to string with vector informations
• lerp Calculate linear interpolation result between this vector and another one with given ratio
• clampf Clamp the vector between from float and to float.
• addSelf Adds this vector.
• add Adds two vectors, and returns the new result.
• subSelf Subtracts one vector from this.
• sub Subtracts one vector from this, and returns the new result.
• mulSelf Multiplies this by a number.
• mul Multiplies by a number, and returns the new result.
• scaleSelf Multiplies two vectors.
• scale Multiplies two vectors, and returns the new result.
• divSelf Divides by a number.
• div Divides by a number, and returns the new result.
• negSelf Negates the components.
• neg Negates the components, and returns the new result.
• dot Dot product
• cross Cross product
• mag Returns the length of this vector.
• magSqr Returns the squared length of this vector.
• normalizeSelf Make the length of this vector to 1.
• normalize Note that the current vector is unchanged and a new normalized vector is returned.
• transformMat4 Transforms the vec3 with a mat4.
• angle Get angle in radian between this and vector.
• project Calculates the projection of the current vector over the given vector.
• signAngle Get angle in radian between this and vector with direction.
• rotate rotate.
• rotateSelf rotate self.

Details

Properties

x

y

z

ONE

return a Vec3 object with x = 1, y = 1, z = 1.

ZERO

return a Vec3 object with x = 0, y = 0, z = 0.

UP

return a Vec3 object with x = 0, y = 1, z = 0.

RIGHT

return a Vec3 object with x = 1, y = 0, z = 0.

FRONT

return a Vec3 object with x = 0, y = 0, z = 1.

Methods

constructor

Constructor see Cc/vec3:method

Parameters

• x number
• y number
• z number

clone

clone a Vec3 value

set

Set the current vector value with the given vector.

Parameters

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

equals

Check whether the vector equals another one

Parameters

• other Vec3

fuzzyEquals

Check whether two vector equal with some degree of variance.

Parameters

• other Vec3
• variance Number

toString

Transform to string with vector informations

lerp

Calculate linear interpolation result between this vector and another one with given ratio

Parameters

• 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

Clamp the vector between from float and to float.

Parameters

• min_inclusive Vec3
• max_inclusive Vec3

addSelf

Adds this vector. If you want to save result to another vector, use add() instead.

Parameters

• vector Vec3

add

Adds two vectors, and returns the new result.

Parameters

• 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

subSelf

Subtracts one vector from this. If you want to save result to another vector, use sub() instead.

Parameters

• vector Vec3

sub

Subtracts one vector from this, and returns the new result.

Parameters

• 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

Multiplies this by a number. If you want to save result to another vector, use mul() instead.

Parameters

• num number

mul

Multiplies by a number, and returns the new result.

Parameters

• 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

Multiplies two vectors.

Parameters

• vector Vec3

scale

Multiplies two vectors, and returns the new result.

Parameters

• 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

divSelf

Divides by a number. If you want to save result to another vector, use div() instead.

Parameters

• num number

div

Divides by a number, and returns the new result.

Parameters

• 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

negSelf

Negates the components. If you want to save result to another vector, use neg() instead.

neg

Negates the components, and returns the new result.

Parameters

• 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

dot

Dot product

Parameters

• vector Vec3

cross

Cross product

Parameters

• vector Vec3
• out Vec3

mag

Returns the length of this vector.

Examples

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

magSqr

Returns the squared length of this vector.

normalizeSelf

Make the length of this vector to 1.

normalize

Returns this vector with a magnitude of 1.

Note that the current vector is unchanged and a new normalized vector is returned. If you want to normalize the current vector, use normalizeSelf function.

Parameters

• 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'

Parameters

• 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

angle

Get angle in radian between this and vector.

Parameters

• vector Vec3

project

Calculates the projection of the current vector over the given vector.

Parameters

• vector Vec3

Examples

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

Get angle in radian between this and vector with direction.
In order to compatible with the vec2 API.

Parameters

• vector Vec3 | Vec2

rotate

rotate. In order to compatible with the vec2 API.

Parameters

• 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

rotate self. In order to compatible with the vec2 API.

Parameters

• radians number