Class Vector2

Hierarchy

Vector2

Index

Constructors

Properties

_onValueChanged _x _y _one _zero

Accessors

x y

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
Constructor of Vector2.
Parameters
- x: number = 0
  
  The x component of the vector, default 0
- y: number = 0
  
  The y component of the vector, default 0
Returns Vector2
- Defined in math/Vector2.ts:214

Properties

_onValueChanged

_onValueChanged: (() => void) = null

Type declaration

- (): void
- Internal
  Returns void

`Internal` _x

_x: number

`Internal` _y

_y: number

`Static` `Readonly` `Internal` _one

_one: Vector2 = ...

`Static` `Readonly` `Internal` _zero

_zero: Vector2 = ...

Accessors

x

get x(): number
The x component of the vector.

Returns number
- Defined in math/Vector2.ts:188
set x(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector2.ts:192

y

get y(): number
The y component of the vector.

Returns number
- Defined in math/Vector2.ts:200
set y(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector2.ts:204

Methods

add

add(right: Vector2): Vector2
Determines the sum of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector2
  
  The specified vector
Returns Vector2
- Defined in math/Vector2.ts:250

clone

clone(): Vector2
Creates a clone of this vector.

Returns
A clone of this vector

Returns Vector2
- Defined in math/Vector2.ts:357

cloneTo

cloneTo(out: Vector2): Vector2
Clones this vector to the specified vector.

Returns
The specified vector
Parameters
- out: Vector2
  
  The specified vector
Returns Vector2
- Defined in math/Vector2.ts:366

divide

divide(right: Vector2): Vector2
Determines the divisor of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector2
  
  The specified vector
Returns Vector2
- Defined in math/Vector2.ts:286

length

length(): number
Calculate the length of this vector.

Returns
The length of this vector

Returns number
- Defined in math/Vector2.ts:297

lengthSquared

lengthSquared(): number
Calculate the squared length of this vector.

Returns
The squared length of this vector

Returns number
- Defined in math/Vector2.ts:306

multiply

multiply(right: Vector2): Vector2
Determines the product of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector2
  
  The specified vector
Returns Vector2
- Defined in math/Vector2.ts:274

negate

negate(): Vector2
Reverses the direction of this vector.

Returns
This vector

Returns Vector2
- Defined in math/Vector2.ts:315

normalize

normalize(): Vector2
Converts this vector into a unit vector.

Returns
This vector

Returns Vector2
- Defined in math/Vector2.ts:326

scale

scale(s: number): Vector2
Scale this vector by the given value.

Returns
This vector
Parameters
- s: number
  
  The amount by which to scale the vector
Returns Vector2
- Defined in math/Vector2.ts:336

setValue

setValue(x: number, y: number): Vector2
Set the value of this vector.

Returns
This vector
Parameters
- x: number
  
  The x component of the vector
- y: number
  
  The y component of the vector
Returns Vector2
- Defined in math/Vector2.ts:225

setValueByArray

setValueByArray(array: ArrayLike<number>, offset?: number): Vector2
Set the value of this vector by an array.

Returns
This vector
Parameters
- array: ArrayLike<number>
  
  The array
- offset: number = 0
  
  The start offset of the array
Returns Vector2
- Defined in math/Vector2.ts:238

subtract

subtract(right: Vector2): Vector2
Determines the difference of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector2
  
  The specified vector
Returns Vector2
- Defined in math/Vector2.ts:262

toArray

toArray(out: Float32Array | Float64Array | number[], outOffset?: number): void
Clone the value of this vector to an array.
Parameters
- out: Float32Array | Float64Array | number[]
  
  The array
- outOffset: number = 0
  
  The start offset of the array
Returns void
- Defined in math/Vector2.ts:348

`Static` add

add(left: Vector2, right: Vector2, out: Vector2): void
Determines the sum of two vectors.
Parameters
- left: Vector2
  
  The first vector to add
- right: Vector2
  
  The second vector to add
- out: Vector2
  
  The sum of two vectors
Returns void
- Defined in math/Vector2.ts:15

`Static` distance

distance(left: Vector2, right: Vector2): number
Determines the distance of two vectors.

Returns
The distance of two vectors
Parameters
- left: Vector2
  
  The first vector
- right: Vector2
  
  The second vector
Returns number
- Defined in math/Vector2.ts:73

`Static` distanceSquared

distanceSquared(left: Vector2, right: Vector2): number
Determines the squared distance of two vectors.

Returns
The squared distance of two vectors
Parameters
- left: Vector2
  
  The first vector
- right: Vector2
  
  The second vector
Returns number
- Defined in math/Vector2.ts:85

`Static` divide

divide(left: Vector2, right: Vector2, out: Vector2): void
Determines the divisor of two vectors.
Parameters
- left: Vector2
  
  The first vector to divide
- right: Vector2
  
  The second vector to divide
- out: Vector2
  
  The divisor of two vectors
Returns void
- Defined in math/Vector2.ts:51

`Static` dot

dot(left: Vector2, right: Vector2): number
Determines the dot product of two vectors.

Returns
The dot product of two vectors
Parameters
- left: Vector2
  
  The first vector to dot
- right: Vector2
  
  The second vector to dot
Returns number
- Defined in math/Vector2.ts:63

`Static` equals

equals(left: Vector2, right: Vector2): boolean
Determines whether the specified vectors are equals.

Returns
True if the specified vectors are equals, false otherwise
Parameters
- left: Vector2
  
  The first vector to compare
- right: Vector2
  
  The second vector to compare
Returns boolean
- Defined in math/Vector2.ts:97

`Static` lerp

lerp(left: Vector2, right: Vector2, t: number, out: Vector2): void
Performs a linear interpolation between two vectors.
Parameters
- left: Vector2
  
  The first vector
- right: Vector2
  
  The second vector
- t: number
  
  The blend amount where 0 returns left and 1 right
- out: Vector2
  
  The result of linear blending between two vectors
Returns void
- Defined in math/Vector2.ts:108

`Static` max

max(left: Vector2, right: Vector2, out: Vector2): void
Calculate a vector containing the largest components of the specified vectors.
Parameters
- left: Vector2
  
  The first vector
- right: Vector2
  
  The second vector
- out: Vector2
  
  The vector containing the largest components of the specified vectors
Returns void
- Defined in math/Vector2.ts:121

`Static` min

min(left: Vector2, right: Vector2, out: Vector2): void
Calculate a vector containing the smallest components of the specified vectors.
Parameters
- left: Vector2
  
  The first vector
- right: Vector2
  
  The second vector
- out: Vector2
  
  The vector containing the smallest components of the specified vectors
Returns void
- Defined in math/Vector2.ts:133

`Static` multiply

multiply(left: Vector2, right: Vector2, out: Vector2): void
Determines the product of two vectors.
Parameters
- left: Vector2
  
  The first vector to multiply
- right: Vector2
  
  The second vector to multiply
- out: Vector2
  
  The product of two vectors
Returns void
- Defined in math/Vector2.ts:39

`Static` negate

negate(left: Vector2, out: Vector2): void
Reverses the direction of a given vector.
Parameters
- left: Vector2
  
  The vector to negate
- out: Vector2
  
  The vector facing in the opposite direction
Returns void
- Defined in math/Vector2.ts:144

`Static` normalize

normalize(left: Vector2, out: Vector2): void
Converts the vector into a unit vector.
Parameters
- left: Vector2
  
  The vector to normalize
- out: Vector2
  
  The normalized vector
Returns void
- Defined in math/Vector2.ts:155

`Static` scale

scale(left: Vector2, s: number, out: Vector2): void
Scale a vector by the given value.
Parameters
- left: Vector2
  
  The vector to scale
- s: number
  
  The amount by which to scale the vector
- out: Vector2
  
  The scaled vector
Returns void
- Defined in math/Vector2.ts:172

`Static` subtract

subtract(left: Vector2, right: Vector2, out: Vector2): void
Determines the difference between two vectors.
Parameters
- left: Vector2
  
  The first vector to subtract
- right: Vector2
  
  The second vector to subtract
- out: Vector2
  
  The difference between two vectors
Returns void
- Defined in math/Vector2.ts:27

Generated using TypeDoc