Vec3 | CocosCreatorAPI

Representation of 3D vectors and points.

Hierarchy

ValueType
- Vec3

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

newVec3(v: Vec3): Vec3
newVec3(x?: undefined | number, y?: undefined | number, z?: undefined | number): Vec3

- Defined in cocos/core/math/vec3.ts:690
Parameters
- v: Vec3
Returns Vec3
- Defined in cocos/core/math/vec3.ts:692
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
Returns Vec3

Properties

x

x: number

x component.

y

y: number

y component.

z

z: number

z component.

Static FORWARD

FORWARD: Readonly<Vec3> = Object.freeze(new Vec3(0, 0, -1))

Static NEG_ONE

NEG_ONE: Readonly<Vec3> = Object.freeze(new Vec3(-1, -1, -1))

Static ONE

ONE: Readonly<Vec3> = Object.freeze(new Vec3(1, 1, 1))

Static RIGHT

RIGHT: Readonly<Vec3> = Object.freeze(new Vec3(1, 0, 0))

Static UNIT_X

UNIT_X: Readonly<Vec3> = Object.freeze(new Vec3(1, 0, 0))

Static UNIT_Y

UNIT_Y: Readonly<Vec3> = Object.freeze(new Vec3(0, 1, 0))

Static UNIT_Z

UNIT_Z: Readonly<Vec3> = Object.freeze(new Vec3(0, 0, 1))

Static UP

UP: Readonly<Vec3> = Object.freeze(new Vec3(0, 1, 0))

Static ZERO

ZERO: Readonly<Vec3> = Object.freeze(new Vec3(0, 0, 0))

Methods

add

add(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:835
Adds the current vector with another one and return this

Parameters
- other: Vec3
  
  specified vector
Returns this

add3f

add3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:849
Adds the current vector with another one and return this

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

clampf

clampf(minInclusive: Vec3, maxInclusive: Vec3): this

- Defined in cocos/core/math/vec3.ts:966
Clamp the vector between minInclusive and maxInclusive.

Parameters
- minInclusive: Vec3
  
  Minimum value allowed
- maxInclusive: Vec3
  
  Maximum value allowed
Returns this

this

clone

clone(): Vec3

Overrides ValueType.clone
- Defined in cocos/core/math/vec3.ts:713
clone a Vec3 value

Returns Vec3

cross

cross(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:988
Calculates the cross product with another vector.

Parameters
- other: Vec3
  
  specified vector
Returns this

divide

divide(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:927
Element-wisely divides this vector with another one, and return this.

Parameters
- other: Vec3
  
  specified vector
Returns this

divide3f

divide3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:941
Element-wisely divides this vector with another one, and return this.

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

dot

dot(other: Vec3): number

- Defined in cocos/core/math/vec3.ts:979
Calculates the dot product with another vector

Parameters
- other: Vec3
  
  specified vector
Returns number

The result of calculates the dot product with another vector

equals

equals(other: Vec3, epsilon?: number): boolean

Overrides ValueType.equals
- Defined in cocos/core/math/vec3.ts:755
Check whether the vector approximately equals another one.

Parameters
- other: Vec3
  
  Specified vector
- Default value epsilon: number = EPSILON
  
  The error allowed. It`s should be a non-negative number.
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

equals3f

equals3f(x: number, y: number, z: number, epsilon?: number): boolean

- Defined in cocos/core/math/vec3.ts:775
Check whether the vector approximately equals another one.

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
- Default value epsilon: number = EPSILON
  
  The error allowed. It`s should be a non-negative number.
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

length

length(): number

- Defined in cocos/core/math/vec3.ts:1003
Returns the length of this vector.

Returns number

Length of vector

lengthSqr

lengthSqr(): number

- Defined in cocos/core/math/vec3.ts:1012
Returns the squared length of this vector.

Returns number

the squared length of this vector

lerp

lerp(to: Vec3, ratio: number): this

- Defined in cocos/core/math/vec3.ts:823
Calculate linear interpolation result between this vector and another one with given ratio.

Parameters
- to: Vec3
  
  Target vector
- ratio: number
  
  The interpolation coefficient.The range is [0,1].
Returns this

multiply

multiply(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:900
Multiplies the current vector with another one and return this

Parameters
- other: Vec3
  
  specified vector
Returns this

multiply3f

multiply3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:915
Multiplies the current vector with another one and return this

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

multiplyScalar

multiplyScalar(scalar: number): this

- Defined in cocos/core/math/vec3.ts:887
Multiplies the current vector with a number, and returns this.

Parameters
- scalar: number
  
  scalar number
Returns this

negative

negative(): this

- Defined in cocos/core/math/vec3.ts:952
Sets each component of this vector with its negative value

Returns this

normalize

normalize(): this

- Defined in cocos/core/math/vec3.ts:1020
Normalize the current vector.

Returns this

set

set(other: Vec3): any
set(x?: undefined | number, y?: undefined | number, z?: undefined | number): any

Overrides ValueType.set
- Defined in cocos/core/math/vec3.ts:723
Set the current vector value with the given vector.

Parameters
- other: Vec3
  
  Specified vector
Returns any

this
Overrides ValueType.set
- Defined in cocos/core/math/vec3.ts:733
Set the value of each component of the current vector.

Parameters
- Optional x: undefined | number
  
  x value
- Optional y: undefined | number
  
  y value
- Optional z: undefined | number
  
  z value
Returns any

this

strictEquals

strictEquals(other: Vec3): boolean

- Defined in cocos/core/math/vec3.ts:792
Check whether the current vector strictly equals another Vec3.

Parameters
- other: Vec3
  
  specified vector
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

strictEquals3f

strictEquals3f(x: number, y: number, z: number): boolean

- Defined in cocos/core/math/vec3.ts:804
Check whether the current vector strictly equals another Vec3.

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns boolean

Returns true when the components of both vectors are equal within the specified range of error; otherwise it returns false.

subtract

subtract(other: Vec3): this

- Defined in cocos/core/math/vec3.ts:861
Subtracts one vector from this, and returns this.

Parameters
- other: Vec3
  
  specified vector
Returns this

subtract3f

subtract3f(x: number, y: number, z: number): this

- Defined in cocos/core/math/vec3.ts:875
Subtracts one vector from this, and returns this.

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y value of specified vector
- z: number
  
  The z value of specified vector
Returns this

toString

toString(): string

Overrides ValueType.toString
- Defined in cocos/core/math/vec3.ts:813
Transform to string with vector information.

Returns string

The string with vector information

transformMat4

transformMat4(matrix: Mat4): this

- Defined in cocos/core/math/vec3.ts:1040
Transforms the vec3 with a mat4. 4th vector component is implicitly '1'

Parameters
- matrix: Mat4
  
  matrix to transform with
Returns this

Static add

add<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:100
Element-wise vector addition and save the results to out vector object

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static angle

angle(a: IVec3Like, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:636
Calculates the radian angle between two vectors

Parameters
- a: IVec3Like
- b: IVec3Like
Returns number

Static ceil

ceil<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:144
Rounds up by elements of the vector and save the results to out vector object

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static clone

clone<Out>(a: Out): Vec3

- Defined in cocos/core/math/vec3.ts:70
Obtains a clone of the given vector object

Type parameters
- Out: IVec3Like
Parameters
- a: Out
Returns Vec3

Static copy

copy<Out, Vec3Like>(out: Out, a: Vec3Like): Out

- Defined in cocos/core/math/vec3.ts:78
Copy the target vector and save the results to out vector object

Type parameters
- Out: IVec3Like
- Vec3Like: IVec3Like
Parameters
- out: Out
- a: Vec3Like
Returns Out

Static cross

cross<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:344
Calculates the cross product of the vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static distance

distance(a: IVec3Like, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:221
Calculates the euclidean distance of two vectors

Parameters
- a: IVec3Like
- b: IVec3Like
Returns number

Static divide

divide<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:133
Element-wise vector division and save the results to out vector object

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static dot

dot<Out>(a: Out, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:336
Calculates the dot product of the vector

Type parameters
- Out: IVec3Like
Parameters
- a: Out
- b: IVec3Like
Returns number

Static equals

equals(a: IVec3Like, b: IVec3Like, epsilon?: number): boolean

- Defined in cocos/core/math/vec3.ts:619
Check whether the two given vectors are approximately equivalent

Parameters
- a: IVec3Like
- b: IVec3Like
- Default value epsilon: number = EPSILON
Returns boolean

Static floor

floor<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:155
Element-wise rounds down of the current vector and save the results to the out vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static fromArray

fromArray<Out>(out: Out, arr: IWritableArrayLike<number>, ofs?: number): Out

- Defined in cocos/core/math/vec3.ts:600
Converts the given array to a vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- arr: IWritableArrayLike<number>
- Default value ofs: number = 0
  
  Array Start Offset
Returns Out

Static invert

invert<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:276
Sets each element to its inverse value, zero value will become Infinity

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static invertSafe

invertSafe<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:287
Sets each element to its inverse value, zero value will remain zero

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static len

len(a: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:243
Calculates the length of the vector

Parameters
- a: IVec3Like
Returns number

Static lengthSqr

lengthSqr(a: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:254
Calculates the squared length of the vector

Parameters
- a: IVec3Like
Returns number

Static lerp

lerp<Out>(out: Out, a: IVec3Like, b: IVec3Like, t: number): Out

- Defined in cocos/core/math/vec3.ts:357
Calculates the linear interpolation between two vectors with a given ratio

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
- t: number
Returns Out

Static max

max<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:177
Calculates element-wise maximum values and save to the out vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static min

min<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:166
Calculates element-wise minimum values and save to the out vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static multiply

multiply<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:122
Element-wise vector multiplication and save the results to out vector object

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static multiplyScalar

multiplyScalar<Out, Vec3Like>(out: Out, a: Vec3Like, b: number): Out

- Defined in cocos/core/math/vec3.ts:199
Vector scalar multiplication and save the results to out vector object

Type parameters
- Out: IVec3Like
- Vec3Like: IVec3Like
Parameters
- out: Out
- a: Vec3Like
- b: number
Returns Out

Static negate

negate<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:265
Sets each element to its negative value

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static normalize

normalize<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:317
Sets the normalized vector to the out vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static project

project<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:665
Calculates the projection on the specified vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
  
  projection vector
- b: IVec3Like
Returns Out

Static projectOnPlane

projectOnPlane<Out>(out: Out, a: IVec3Like, n: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:655
Calculates the projection vector on the specified plane

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
  
  projection vector
- n: IVec3Like
  
  the normal line of specified plane
Returns Out

Static random

random<Out>(out: Out, scale?: undefined | number): Out

- Defined in cocos/core/math/vec3.ts:369
Generates a uniformly distributed random vector points from center to the surface of the unit sphere

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- Optional scale: undefined | number
  
  vector length
Returns Out

Static rotateX

rotateX<Out>(out: Out, v: IVec3Like, o: IVec3Like, a: number): Out

- Defined in cocos/core/math/vec3.ts:505
Rotates the vector with specified angle around X axis

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
  
  rotation vector
- o: IVec3Like
  
  center of rotation
- a: number
  
  radius of rotation
Returns Out

Static rotateY

rotateY<Out>(out: Out, v: IVec3Like, o: IVec3Like, a: number): Out

- Defined in cocos/core/math/vec3.ts:533
Rotates the vector with specified angle around Y axis

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
  
  rotation vector
- o: IVec3Like
  
  center of rotation
- a: number
  
  radius of rotation
Returns Out

Static rotateZ

rotateZ<Out>(out: Out, v: IVec3Like, o: IVec3Like, a: number): Out

- Defined in cocos/core/math/vec3.ts:561
Rotates the vector with specified angle around Z axis

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
  
  rotation vector
- o: IVec3Like
  
  center of rotation
- a: number
  
  radius of rotation
Returns Out

Static round

round<Out>(out: Out, a: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:188
Calculates element-wise round results and save to the out vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
Returns Out

Static scaleAndAdd

scaleAndAdd<Out>(out: Out, a: IVec3Like, b: IVec3Like, scale: number): Out

- Defined in cocos/core/math/vec3.ts:210
Element-wise multiplication and addition with the equation: a + b * scale

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
- scale: number
Returns Out

Static set

set<Out>(out: Out, x: number, y: number, z: number): Out

- Defined in cocos/core/math/vec3.ts:89
Sets the out vector with the given x, y and z values

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- x: number
- y: number
- z: number
Returns Out

Static squaredDistance

squaredDistance(a: IVec3Like, b: IVec3Like): number

- Defined in cocos/core/math/vec3.ts:232
Calculates the squared euclidean distance of two vectors

Parameters
- a: IVec3Like
- b: IVec3Like
Returns number

Static strictEquals

strictEquals(a: IVec3Like, b: IVec3Like): boolean

- Defined in cocos/core/math/vec3.ts:611
Check the equality of the two given vectors

Parameters
- a: IVec3Like
- b: IVec3Like
Returns boolean

Static subtract

subtract<Out>(out: Out, a: IVec3Like, b: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:111
Element-wise vector subtraction and save the results to out vector object

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- b: IVec3Like
Returns Out

Static toArray

toArray<Out>(out: Out, v: IVec3Like, ofs?: number): Out

- Defined in cocos/core/math/vec3.ts:587
Converts the given vector to an array

Type parameters
- Out: IWritableArrayLike<number>
Parameters
- out: Out
- v: IVec3Like
- Default value ofs: number = 0
  
  Array Start Offset
Returns Out

Static transformAffine

transformAffine<Out>(out: Out, v: IVec3Like, m: IMat4Like): Out

- Defined in cocos/core/math/vec3.ts:432
Affine transformation vector

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- v: IVec3Like
- m: IMat4Like
Returns Out

Static transformInverseRTS

transformInverseRTS<Out>(out: Out, a: IVec3Like, r: IQuatLike, t: IVec3Like, s: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:484
Transforms the current vector with given scale, rotation and translation in reverse order

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- r: IQuatLike
- t: IVec3Like
- s: IVec3Like
Returns Out

Static transformMat3

transformMat3<Out>(out: Out, a: IVec3Like, m: IMat3Like): Out

- Defined in cocos/core/math/vec3.ts:418
Vector and third order matrix multiplication

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- m: IMat3Like
Returns Out

Static transformMat4

transformMat4<Out>(out: Out, a: IVec3Like, m: IMat4Like): Out

- Defined in cocos/core/math/vec3.ts:386
Vector and fourth order matrix multiplication, will complete the vector with a fourth value as one

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- m: IMat4Like
Returns Out

Static transformMat4Normal

transformMat4Normal<Out>(out: Out, a: IVec3Like, m: IMat4Like): Out

- Defined in cocos/core/math/vec3.ts:402
Vector and fourth order matrix multiplication, will complete the vector with a fourth element as one

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- m: IMat4Like
Returns Out

Static transformQuat

transformQuat<Out>(out: Out, a: IVec3Like, q: IQuatLike): Out

- Defined in cocos/core/math/vec3.ts:446
Vector quaternion multiplication

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- q: IQuatLike
Returns Out

Static transformRTS

transformRTS<Out>(out: Out, a: IVec3Like, r: IQuatLike, t: IVec3Like, s: IVec3Like): Out

- Defined in cocos/core/math/vec3.ts:466
Transforms the current vector with given scale, rotation and translation in order

Type parameters
- Out: IVec3Like
Parameters
- out: Out
- a: IVec3Like
- r: IQuatLike
- t: IVec3Like
- s: IVec3Like
Returns Out

Static zero

zero<Out>(out: Out): Out

- Defined in cocos/core/math/vec3.ts:59
return a Vec3 object with x = 0, y = 0, z = 0.

Type parameters
- Out: IVec3Like
Parameters
- out: Out
Returns Out

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

v: Vec3

Returns Vec3

Parameters

Optional x: undefined | number

Optional y: undefined | number

Optional z: undefined | number

Returns Vec3

Properties

x

y

z

Static FORWARD

Static NEG_ONE

Static ONE

Static RIGHT

Static UNIT_X

Static UNIT_Y

Static UNIT_Z

Static UP

Static ZERO

Methods

add

Parameters

other: Vec3

Returns this

add3f

Parameters

x: number

y: number

z: number

Returns this

clampf

Parameters

minInclusive: Vec3

maxInclusive: Vec3

Returns this

clone

Returns Vec3

cross

Parameters

other: Vec3

Returns this

divide

Parameters

other: Vec3

Returns this

divide3f

Parameters

x: number

y: number

z: number

Returns this

dot

Parameters

other: Vec3

Returns number

equals

Parameters

other: Vec3

Default value epsilon: number = EPSILON

Returns boolean

equals3f

Parameters

x: number

y: number

z: number

Default value epsilon: number = EPSILON

Returns boolean

length

Returns number

lengthSqr

Returns number