Mat4 Class

Extends ValueType

Module: cc Parent Module: cc

Representation of 4*4 matrix.

Index

Properties

• IDENTITY Mat4 Identity of Mat4
• m Float64Array | Float32Array Matrix Data

Methods

• mul Multiply the current matrix with another one
• mulScalar Multiply each element of the matrix by a scalar.
• sub Subtracts the current matrix with another one
• clone Copy of the specified matrix to obtain
• copy Copy the target matrix
• identity The target of an assignment is the identity matrix
• transpose Transposed matrix
• invert Matrix inversion
• determinant Matrix determinant
• multiply Matrix Multiplication
• transform Was added in a given transformation matrix transformation on the basis of
• translate Add new displacement transducer in a matrix transformation on the basis of a given
• scale Add new scaling transformation in a given matrix transformation on the basis of
• rotate Add a new rotational transform matrix transformation on the basis of a given
• rotateX Add rotational transformation around the X axis at a given matrix transformation on the basis of
• rotateY Add about the Y axis rotation transformation in a given matrix transformation on the basis of
• rotateZ Added about the Z axis at a given rotational transformation matrix transformation on the basis of
• fromTranslation Displacement matrix calculation
• fromScaling Scaling matrix calculation
• fromRotation Calculates the rotation matrix
• fromXRotation Calculating rotation matrix about the X axis
• fromYRotation Calculating rotation matrix about the Y axis
• fromZRotation Calculating rotation matrix about the Z axis
• fromRT The rotation and displacement information calculating matrix
• getTranslation Extracting displacement information of the matrix, the matrix transform to the default sequential application S-> R-> T is
• getScaling Scaling information extraction matrix, the matrix transform to the default sequential application S-> R-> T is
• getRotation Rotation information extraction matrix, the matrix containing no default input scaling information, such as the use of toRTS should consider the scaling function.
• toRTS Extracting rotational displacement, zoom information, the default matrix transformation in order S-> R-> T applications
• fromRTS The rotary displacement, the scaling matrix calculation information, the order S-> R-> T applications
• fromRTSOrigin According to the specified rotation, displacement, and scale conversion matrix calculation information center, order S-> R-> T applications
• fromQuat The rotation matrix calculation information specified
• frustum The matrix calculation information specified frustum
• perspective Perspective projection matrix calculation
• ortho Computing orthogonal projection matrix
• lookAt Up parallel vector or vector centernot be zero - the matrix calculation according to the viewpoint, note eye
• inverseTranspose Reversal matrix calculation
• add Element by element matrix addition
• subtract Matrix element by element subtraction
• multiplyScalar Matrix scalar multiplication
• multiplyScalarAndAdd Elements of the matrix by the scalar multiplication and addition: A + B * scale
• strictEquals Analyzing the equivalent matrix
• equals Negative floating point error is approximately equivalent to determining a matrix
• toArray Matrix transpose array
• fromArray Transfer matrix array
• constructor Constructor
• clone clone a Mat4 object
• set Sets the matrix with another one's value
• equals Check whether two matrix equal
• fuzzyEquals Check whether two matrix equal with default degree of variance.
• toString Transform to string with matrix informations
• identity Set the matrix to the identity matrix
• transpose Transpose the values of a mat4
• invert Inverts a mat4
• adjoint Calculates the adjugate of a mat4
• determinant Calculates the determinant of a mat4
• add Adds two Mat4
• subtract Subtracts the current matrix with another one
• multiply Subtracts the current matrix with another one
• multiplyScalar Multiply each element of the matrix by a scalar.
• translate Translate a mat4 by the given vector
• scale Scales the mat4 by the dimensions in the given vec3
• rotate Rotates a mat4 by the given angle around the given axis
• getTranslation Returns the translation vector component of a transformation matrix.
• getScale Returns the scale factor component of a transformation matrix
• getRotation Returns the rotation factor component of a transformation matrix
• fromRTS Restore the matrix values from a quaternion rotation, vector translation and vector scale
• fromQuat Restore the matrix values from a quaternion rotation
• lerp Linearly interpolates between this value to to value by ratio which is in the range [0, 1].

Details

Properties

IDENTITY

Identity of Mat4

m

Matrix Data

Methods

mul

Multiply the current matrix with another one

Parameters

• other Mat4 the second operand
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

mulScalar

Multiply each element of the matrix by a scalar.

Parameters

• number Number amount to scale the matrix's elements by
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

sub

Subtracts the current matrix with another one

Parameters

• other Mat4 the second operand
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

clone

Copy of the specified matrix to obtain

copy

Copy the target matrix

identity

The target of an assignment is the identity matrix

transpose

Transposed matrix

invert

Matrix inversion

determinant

Matrix determinant

multiply

Matrix Multiplication

transform

Was added in a given transformation matrix transformation on the basis of

translate

Add new displacement transducer in a matrix transformation on the basis of a given

scale

Add new scaling transformation in a given matrix transformation on the basis of

rotate

Add a new rotational transform matrix transformation on the basis of a given

Parameters

• rad Unknown 旋转角度
• axis Unknown 旋转轴

rotateX

Add rotational transformation around the X axis at a given matrix transformation on the basis of

Parameters

• rad Unknown 旋转角度

rotateY

Add about the Y axis rotation transformation in a given matrix transformation on the basis of

Parameters

• rad Unknown 旋转角度

rotateZ

Added about the Z axis at a given rotational transformation matrix transformation on the basis of

Parameters

• rad Unknown 旋转角度

fromTranslation

Displacement matrix calculation

fromScaling

Scaling matrix calculation

fromRotation

Calculates the rotation matrix

fromXRotation

Calculating rotation matrix about the X axis

fromYRotation

Calculating rotation matrix about the Y axis

fromZRotation

Calculating rotation matrix about the Z axis

fromRT

The rotation and displacement information calculating matrix

getTranslation

Extracting displacement information of the matrix, the matrix transform to the default sequential application S-> R-> T is

getScaling

Scaling information extraction matrix, the matrix transform to the default sequential application S-> R-> T is

getRotation

Rotation information extraction matrix, the matrix containing no default input scaling information, such as the use of toRTS should consider the scaling function.

toRTS

Extracting rotational displacement, zoom information, the default matrix transformation in order S-> R-> T applications

fromRTS

The rotary displacement, the scaling matrix calculation information, the order S-> R-> T applications

fromRTSOrigin

According to the specified rotation, displacement, and scale conversion matrix calculation information center, order S-> R-> T applications

Parameters

• q Unknown 旋转值
• v Unknown 位移值
• s Unknown 缩放值
• o Unknown 指定变换中心

fromQuat

The rotation matrix calculation information specified

frustum

The matrix calculation information specified frustum

Parameters

• left Unknown 左平面距离
• right Unknown 右平面距离
• bottom Unknown 下平面距离
• top Unknown 上平面距离
• near Unknown 近平面距离
• far Unknown 远平面距离

perspective

Perspective projection matrix calculation

Parameters

• fovy Unknown 纵向视角高度
• aspect Unknown 长宽比
• near Unknown 近平面距离
• far Unknown 远平面距离

ortho

Computing orthogonal projection matrix

Parameters

• left Unknown 左平面距离
• right Unknown 右平面距离
• bottom Unknown 下平面距离
• top Unknown 上平面距离
• near Unknown 近平面距离
• far Unknown 远平面距离

lookAt

Up parallel vector or vector centernot be zero - the matrix calculation according to the viewpoint, note eye

Parameters

• eye Unknown 当前位置
• center Unknown 目标视点
• up Unknown 视口上方向

inverseTranspose

Reversal matrix calculation

add

Element by element matrix addition

subtract

Matrix element by element subtraction

multiplyScalar

Matrix scalar multiplication

multiplyScalarAndAdd

Elements of the matrix by the scalar multiplication and addition: A + B * scale

strictEquals

Analyzing the equivalent matrix

equals

Negative floating point error is approximately equivalent to determining a matrix

toArray

Matrix transpose array

Parameters

• ofs Unknown 数组内的起始偏移量

fromArray

Transfer matrix array

Parameters

• ofs Unknown 数组起始偏移量

constructor

Constructor see cc.mat4

clone

clone a Mat4 object

set

Sets the matrix with another one's value

Parameters

• srcObj Mat4

equals

Check whether two matrix equal

Parameters

• other Mat4

fuzzyEquals

Check whether two matrix equal with default degree of variance.

Parameters

• other Mat4

toString

Transform to string with matrix informations

identity

Set the matrix to the identity matrix

transpose

Transpose the values of a mat4

Parameters

• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

invert

Inverts a mat4

Parameters

• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

adjoint

Calculates the adjugate of a mat4

Parameters

• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

determinant

Calculates the determinant of a mat4

add

Adds two Mat4

Parameters

• other Mat4 the second operand
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

subtract

Subtracts the current matrix with another one

Parameters

• other Mat4 the second operand

multiply

Subtracts the current matrix with another one

Parameters

• other Mat4 the second operand

multiplyScalar

Multiply each element of the matrix by a scalar.

Parameters

• number Number amount to scale the matrix's elements by

translate

Translate a mat4 by the given vector

Parameters

• v Vec3 vector to translate by
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

scale

Scales the mat4 by the dimensions in the given vec3

Parameters

• v Vec3 vector to scale by
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

rotate

Rotates a mat4 by the given angle around the given axis

Parameters

• rad Number the angle to rotate the matrix by
• axis Vec3 the axis to rotate around
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

getTranslation

Returns the translation vector component of a transformation matrix.

Parameters

• out Vec3 Vector to receive translation component, if not provided, a new vec3 will be created

getScale

Returns the scale factor component of a transformation matrix

Parameters

• out Vec3 Vector to receive scale component, if not provided, a new vec3 will be created

getRotation

Returns the rotation factor component of a transformation matrix

Parameters

• out Quat Vector to receive rotation component, if not provided, a new quaternion object will be created

fromRTS

Restore the matrix values from a quaternion rotation, vector translation and vector scale

Parameters

• q Quat Rotation quaternion
• v Vec3 Translation vector
• s Vec3 Scaling vector

fromQuat

Restore the matrix values from a quaternion rotation

Parameters

• q Quat Rotation quaternion

lerp

Linearly interpolates between this value to to value by ratio which is in the range [0, 1]. When ratio = 0 returns this. When ratio = 1 return to. When ratio = 0.5 returns the average of this and to.

Parameters

• to ValueType the to value
• ratio number the interpolation coefficient