Class Vector2

A 2-dimensional vector.

Methods that manipulate values are generally destructive. To preserve the original values, explicitly call clone() to create a duplicate instance.

Hierarchy

Vector2

Index

Constructors

Properties

x y

Methods

add addScalar clone cross divide divideScalar dot equals length lengthSq lerp multiply multiplyScalar negate normalize set sub subScalar

Constructors

constructor

new Vector2(): Vector2
Returns Vector2
new Vector2(x: number, y: number): Vector2
Parameters
- x: number
- y: number
Returns Vector2

Properties

x

x: number

y

y: number

Methods

add

add(v: Vector2): Vector2
Adds v to the vector's value.
Parameters
- v: Vector2
Returns Vector2

addScalar

addScalar(s: number): Vector2
Adds the scalar value s to the vector's x and y components.
Parameters
- s: number
Returns Vector2

clone

clone(): Vector2
Clones the instance.

Returns Vector2

cross

cross(v: Vector2): number
Returns the size of the 2-dimensional cross product of the vector and v.
Parameters
- v: Vector2
Returns number

divide

divide(v: Vector2): Vector2
Divides the vector by v.
Parameters
- v: Vector2
Returns Vector2

divideScalar

divideScalar(s: number): Vector2
Divides the vector by the scalar value s.
Parameters
- s: number
Returns Vector2

dot

dot(v: Vector2): number
Returns the dot product of the vector and v.
Parameters
- v: Vector2
Returns number

equals

equals(v: Vector2): boolean
Compares the vector to v, and returns true if they are approximately equal.
Parameters
- v: Vector2
Returns boolean

length

length(): number
Returns the vector's length.

Returns number

lengthSq

lengthSq(): number
Returns the vector's squared length.

Returns number

lerp

lerp(v: Vector2, a: number): Vector2
Calculates the linear interpolation (lerp) between the current value and v, using a as the interpolation factor, then updates the vector's value to the result.
Parameters
- v: Vector2
- a: number
  
  The interpolation factor, specified as a number between [0, 1].
Returns Vector2

multiply

multiply(v: Vector2): Vector2
Multiplies the vector by v.
Parameters
- v: Vector2
Returns Vector2

multiplyScalar

multiplyScalar(s: number): Vector2
Multiplies the vector by the scalar value s.
Parameters
- s: number
Returns Vector2

negate

negate(): Vector2
Negates the vector's value.

Returns Vector2

normalize

normalize(): Vector2
Normalizes the vector's value.

Returns Vector2

set

set(x: number, y: number): Vector2
Sets the vector's component values to those specified in x and y.
Parameters
- x: number
- y: number
Returns Vector2

sub

sub(v: Vector2): Vector2
Subtracts v from the vector's value.
Parameters
- v: Vector2
Returns Vector2

subScalar

subScalar(s: number): Vector2
Subtracts the scalar value s from the vector's x and y components.
Parameters
- s: number
Returns Vector2

Generated using TypeDoc