Class Vec2

Representation of 2D vectors and points.

Hierarchy

ValueType
- Vec2

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

newVec2(other: Vec2): Vec2
newVec2(x?: undefined | number, y?: undefined | number): Vec2

- Defined in cocos/core/math/vec2.ts:435
Parameters
- other: Vec2
Returns Vec2
- Defined in cocos/core/math/vec2.ts:437
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
Returns Vec2

Properties

x

x: number

x component.

y

y: number

y component.

Static NEG_ONE

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

Static ONE

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

Static UNIT_X

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

Static UNIT_Y

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

Static ZERO

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

Methods

add

add(other: Vec2): this

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

Parameters
- other: Vec2
  
  specified vector
Returns this

add2f

add2f(x: number, y: number): this

- Defined in cocos/core/math/vec2.ts:595
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
Returns this

angle

angle(other: Vec2): number

- Defined in cocos/core/math/vec2.ts:753
Calculates radian angle between two vectors

Parameters
- other: Vec2
  
  specified vector
Returns number

The angle between the current vector and the specified vector (in radians); if there are zero vectors in the current vector and the specified vector, 0 is returned.

clampf

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

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

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

this

clone

clone(): Vec2

Overrides ValueType.clone
- Defined in cocos/core/math/vec2.ts:456
clone a Vec2 value

Returns Vec2

cross

cross(other: Vec2): number

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

Parameters
- other: Vec2
  
  specified vector
Returns number

out

divide

divide(other: Vec2): this

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

Parameters
- other: Vec2
  
  specified vector
Returns this

divide2f

divide2f(x: number, y: number): this

- Defined in cocos/core/math/vec2.ts:677
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
Returns this

dot

dot(other: Vec2): number

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

Parameters
- other: Vec2
  
  specified vector
Returns number

The result of calculates the dot product with another vector

equals

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

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

Parameters
- other: Vec2
  
  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.

equals2f

equals2f(x: number, y: number, epsilon?: number): boolean

- Defined in cocos/core/math/vec2.ts:512
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
- 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/vec2.ts:718
Returns the length of this vector.

Returns number

Length of vector

lengthSqr

lengthSqr(): number

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

Returns number

the squared length of this vector

lerp

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

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

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

multiply

multiply(other: Vec2): this

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

Parameters
- other: Vec2
  
  specified vector
Returns this

multiply2f

multiply2f(x: number, y: number): this

- Defined in cocos/core/math/vec2.ts:654
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
Returns this

multiplyScalar

multiplyScalar(scalar: number): this

- Defined in cocos/core/math/vec2.ts:629
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/vec2.ts:687
Sets each component of this vector with its negative value

Returns this

normalize

normalize(): this

- Defined in cocos/core/math/vec2.ts:735
Normalize the current vector.

Returns this

project

project(other: Vec2): this

- Defined in cocos/core/math/vec2.ts:801
Projects the current vector on another one

Parameters
- other: Vec2
  
  specified vector
Returns this

rotate

rotate(radians: number): this

- Defined in cocos/core/math/vec2.ts:785
Rotates the current vector by an angle in radian value

Parameters
- radians: number
  
  radius of rotation
Returns this

set

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

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

Parameters
- other: Vec2
  
  Specified vector
Returns any

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

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

this

signAngle

signAngle(other: Vec2): number

- Defined in cocos/core/math/vec2.ts:775
Get angle in radian between this and vector with direction.

Parameters
- other: Vec2
  
  specified vector
Returns number

The signed angle between the current vector and the specified vector (in radians); if there is a zero vector in the current vector and the specified vector, 0 is returned.

strictEquals

strictEquals(other: Vec2): boolean

- Defined in cocos/core/math/vec2.ts:527
Check whether the current vector strictly equals another Vec2.

Parameters
- other: Vec2
  
  specified vector
Returns boolean

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

strictEquals2f

strictEquals2f(x: number, y: number): boolean

- Defined in cocos/core/math/vec2.ts:538
Check whether the current vector strictly equals another Vec2.

Parameters
- x: number
  
  The x value of specified vector
- y: number
  
  The y 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: Vec2): this

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

Parameters
- other: Vec2
  
  specified vector
Returns this

subtract2f

subtract2f(x: number, y: number): this

- Defined in cocos/core/math/vec2.ts:618
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
Returns this

toString

toString(): string

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

Returns string

The string with vector information

transformMat4

transformMat4(matrix: Mat4): this

- Defined in cocos/core/math/vec2.ts:814
Transforms the vec2 with a mat4. 3rd vector component is implicitly '0', 4th vector component is implicitly '1'

Parameters
- matrix: Mat4
  
  matrix to transform with
Returns this

Static add

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

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

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

Static angle

angle<Out>(a: Out, b: Out): number

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

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

Static ceil

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

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

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

Static clone

clone<Out>(a: Out): Vec2

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

Type parameters
- Out: IVec2Like
Parameters
- a: Out
Returns Vec2

Static copy

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

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

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

Static cross

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

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

Type parameters
- Out: IVec2Like
Parameters
- out: Vec3
- a: Out
- b: Out
Returns Vec3

Static distance

distance<Out>(a: Out, b: Out): number

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

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

Static divide

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

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

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

Static dot

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

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

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

Static equals

equals<Out>(a: Out, b: Out, epsilon?: number): boolean

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

Type parameters
- Out: IVec2Like
Parameters
- a: Out
- b: Out
- Default value epsilon: number = EPSILON
Returns boolean

Static floor

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

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

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

Static fromArray

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

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

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

Static inverse

inverse<Out>(out: Out, a: Out): Out

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

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

Static inverseSafe

inverseSafe<Out>(out: Out, a: Out): Out

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

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

Static len

len<Out>(a: Out): number

- Defined in cocos/core/math/vec2.ts:215
Calculates the length of the vector

Type parameters
- Out: IVec2Like
Parameters
- a: Out
Returns number

Static lengthSqr

lengthSqr<Out>(a: Out): number

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

Type parameters
- Out: IVec2Like
Parameters
- a: Out
Returns number

Static lerp

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

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

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

Static max

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

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

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

Static min

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

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

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

Static multiply

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

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

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

Static multiplyScalar

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

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

Type parameters
- Out: IVec2Like
Parameters
- out: Out
- a: Out
- b: number
Returns Out

Static negate

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

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

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

Static normalize

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

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

Type parameters
- Out: IVec2Like
- Vec2Like: IVec2Like
Parameters
- out: Out
- a: Vec2Like
Returns Out

Static random

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

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

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

Static round

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

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

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

Static scaleAndAdd

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

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

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

Static set

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

- Defined in cocos/core/math/vec2.ts:75
Sets the out vector with the given x and y values

Type parameters
- Out: IVec2Like
Parameters
- out: Out
- x: number
- y: number
Returns Out

Static squaredDistance

squaredDistance<Out>(a: Out, b: Out): number

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

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

Static str

str<Out>(a: Out): string

- Defined in cocos/core/math/vec2.ts:361
Gets the string representation of the given vector

Type parameters
- Out: IVec2Like
Parameters
- a: Out
Returns string

Static strictEquals

strictEquals<Out>(a: Out, b: Out): boolean

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

Type parameters
- Out: IVec2Like
Parameters
- a: Out
- b: Out
Returns boolean

Static subtract

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

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

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

Static toArray

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

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

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

Static transformMat3

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

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

Type parameters
- Out: IVec2Like
- MatLike: IMat3Like
Parameters
- out: Out
- a: Out
- m: IMat3Like
Returns Out

Static transformMat4

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

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

Type parameters
- Out: IVec2Like
- MatLike: IMat4Like
Parameters
- out: Out
- a: Out
- m: IMat4Like
Returns Out

Generated using TypeDoc