Vec4 Class

Extends ValueType

Module: cc Parent Module: cc

Representation of 3D vectors and points.

Index

Properties

• x Number
• y Number
• z Number
• w Number

Methods

• 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.
• divSelf Divides by a number.
• div Divides by a number, and returns the new result.
• scaleSelf Multiplies two vectors.
• scale Multiplies two vectors, and returns the new result.
• negSelf Negates the components.
• neg Negates the components, and returns the new result.
• clone Obtaining copy vectors designated
• copy Copy the target vector
• set Set to value
• add Element-wise vector addition
• subtract Element-wise vector subtraction
• multiply Element-wise vector multiplication
• divide Element-wise vector division
• ceil Rounding up by elements of the vector
• floor Element vector by rounding down
• min The minimum by-element vector
• max The maximum value of the element-wise vector
• round Element-wise vector of rounding to whole
• multiplyScalar Vector scalar multiplication
• scaleAndAdd Element-wise vector multiply add: A + B * scale
• distance Seeking two vectors Euclidean distance
• squaredDistance Euclidean distance squared seeking two vectors
• len Seeking vector length
• lengthSqr Seeking squared vector length
• negate By taking the negative elements of the vector
• inverse Element vector by taking the inverse, return near 0 Infinity
• inverseSafe Element vector by taking the inverse, return near 0 0
• normalize Normalized vector
• dot Vector dot product (scalar product)
• lerp Vector element by element linear interpolation: A + t * (B - A)
• random Generates a uniformly distributed random vectors on the unit sphere
• transformMat4 Vector matrix multiplication
• transformAffine Affine transformation vector
• transformQuat Vector quaternion multiplication
• strictEquals Equivalent vectors Analyzing
• equals Negative error vector floating point approximately equivalent Analyzing
• toArray Vector transfer array
• fromArray Array steering amount
• constructor Constructor
• clone clone a Vec4 value
• set Set the current vector value with the given vector.
• equals Check whether the vector equals another one
• equals4f Check whether the vector equals another one
• strictEquals Check whether strict equals other Vec4
• strictEquals4f Check whether strict equals other Vec4
• lerp Calculate linear interpolation result between this vector and another one with given ratio
• toString Transform to string with vector informations
• clampf Clamp the vector between minInclusive and maxInclusive.
• addSelf Adds this vector.
• add Adds two vectors, and returns the new result.
• subtract Subtracts one vector from this, and returns the new result.
• multiplyScalar Multiplies this by a number.
• multiply Multiplies two vectors.
• divide Divides by a number.
• negate Negates the components.
• dot Dot product
• cross Cross product
• len Returns the length of this vector.
• lengthSqr 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 vec4 with a mat4.
• maxAxis Returns the maximum value in x, y, z, w.

Details

Properties

x

y

z

w

Methods

subSelf

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

Parameters

• vector Vec4

sub

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

Parameters

• vector Vec4
• out Vec4 optional, the receiving vector, you can pass the same vec4 to save result to itself, if not provided, a new vec4 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 Vec4 optional, the receiving vector, you can pass the same vec4 to save result to itself, if not provided, a new vec4 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 Vec4 optional, the receiving vector, you can pass the same vec4 to save result to itself, if not provided, a new vec4 will be created

scaleSelf

Multiplies two vectors.

Parameters

• vector Vec4

scale

Multiplies two vectors, and returns the new result.

Parameters

• vector Vec4
• out Vec4 optional, the receiving vector, you can pass the same vec4 to save result to itself, if not provided, a new vec4 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 Vec4 optional, the receiving vector, you can pass the same vec4 to save result to itself, if not provided, a new vec4 will be created

clone

Obtaining copy vectors designated

copy

Copy the target vector

set

Set to value

add

Element-wise vector addition

subtract

Element-wise vector subtraction

multiply

Element-wise vector multiplication

divide

Element-wise vector division

ceil

Rounding up by elements of the vector

floor

Element vector by rounding down

min

The minimum by-element vector

max

The maximum value of the element-wise vector

round

Element-wise vector of rounding to whole

multiplyScalar

Vector scalar multiplication

scaleAndAdd

Element-wise vector multiply add: A + B * scale

distance

Seeking two vectors Euclidean distance

squaredDistance

Euclidean distance squared seeking two vectors

len

Seeking vector length

lengthSqr

Seeking squared vector length

negate

By taking the negative elements of the vector

inverse

Element vector by taking the inverse, return near 0 Infinity

inverseSafe

Element vector by taking the inverse, return near 0 0

normalize

Normalized vector

dot

Vector dot product (scalar product)

lerp

Vector element by element linear interpolation: A + t * (B - A)

random

Generates a uniformly distributed random vectors on the unit sphere

Parameters

• scale Unknown 生成的向量长度

transformMat4

Vector matrix multiplication

transformAffine

Affine transformation vector

transformQuat

Vector quaternion multiplication

strictEquals

Equivalent vectors Analyzing

equals

Negative error vector floating point approximately equivalent Analyzing

toArray

Vector transfer array

Parameters

• ofs Unknown 数组起始偏移量

fromArray

Array steering amount

Parameters

• ofs Unknown 数组起始偏移量

constructor

Constructor see Cc/vec4:method

Parameters

• x number
• y number
• z number
• w number

clone

clone a Vec4 value

set

Set the current vector value with the given vector.

Parameters

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

equals

Check whether the vector equals another one

Parameters

• other Vec4
• epsilon number

equals4f

Check whether the vector equals another one

Parameters

• x number 相比较的向量的 x 分量。
• y number 相比较的向量的 y 分量。
• z number 相比较的向量的 z 分量。
• w number 相比较的向量的 w 分量。
• epsilon number 允许的误差，应为非负数。

strictEquals

Check whether strict equals other Vec4

Parameters

• other Vec4 相比较的向量。

strictEquals4f

Check whether strict equals other Vec4

Parameters

• x number 指定向量的 x 分量。
• y number 指定向量的 y 分量。
• z number 指定向量的 z 分量。
• w number 指定向量的 w 分量。

lerp

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

Parameters

• to Vec4 目标向量。
• ratio number 插值比率，范围为 [0,1]。

toString

Transform to string with vector informations

clampf

Clamp the vector between minInclusive and maxInclusive.

Parameters

• minInclusive Vec4 每个分量都代表了对应分量允许的最小值。
• maxInclusive Vec4 每个分量都代表了对应分量允许的最大值。

addSelf

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

Parameters

• vector Vec4

add

Adds two vectors, and returns the new result.

Parameters

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

subtract

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

Parameters

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

multiplyScalar

Multiplies this by a number.

Parameters

• num number

multiply

Multiplies two vectors.

Parameters

• vector Vec4

divide

Divides by a number.

Parameters

• num number

negate

Negates the components.

dot

Dot product

Parameters

• vector Vec4

cross

Cross product

Parameters

• vector Vec4
• out Vec4

len

Returns the length of this vector.

Examples

var v = cc.v4(10, 10);
v.len(); // return 14.142135623730951;

lengthSqr

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 Vec4 optional, the receiving vector, you can pass the same vec4 to save result to itself, if not provided, a new vec4 will be created

transformMat4

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

Parameters

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

maxAxis

Returns the maximum value in x, y, z, w.