Class Vector2

constructor

• new Vector2(x?, y?): Vector2

• Parameters

  • Optional x: number
  • Optional y: number

  Returns Vector2

height

Readonly isVector2

width

x

0
Copy

y

0
Copy

[iterator]

• [iterator](): Iterator<number, any, undefined>

• Iterating through a Vector2 instance will yield its components (x, y) in the corresponding order.

  Returns Iterator<number, any, undefined>

add

• add(v, w?): this

• Adds v to this vector.

  Parameters

  • v: Vector2
  • Optional w: Vector2

  Returns this

addScalar

• addScalar(s): this

• Adds the scalar value s to this vector's x and y values.

  Parameters

  • s: number

  Returns this

addScaledVector

• addScaledVector(v, s): this

• Adds the multiple of v and s to this vector.

  Parameters

  • v: Vector2
  • s: number

  Returns this

addVectors

• addVectors(a, b): this

• Sets this vector to a + b.

  Parameters

  • a: Vector2
  • b: Vector2

  Returns this

angle

• angle(): number

• computes the angle in radians with respect to the positive x-axis

  Returns number

angleTo

• angleTo(v): number

• Returns the angle between this vector and vector v in radians.

  Parameters

  • v: Vector2

  Returns number

applyMatrix3

• applyMatrix3(m): this

• Multiplies this vector (with an implicit 1 as the 3rd component) by m.

  Parameters

  • m: Matrix3

  Returns this

ceil

• ceil(): this

• The x and y components of the vector are rounded up to the nearest integer value.

  Returns this

clamp

• clamp(min, max): this

• If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value. If this vector's x or y value is less than the min vector's x or y value, it is replaced by the corresponding value.

  Parameters

  • min: Vector2

    the minimum x and y values.
  • max: Vector2

    the maximum x and y values in the desired range.

  Returns this

clampLength

• clampLength(min, max): this

• If this vector's length is greater than the max value, it is replaced by the max value. If this vector's length is less than the min value, it is replaced by the min value.

  Parameters

  • min: number

    the minimum value the length will be clamped to.
  • max: number

    the maximum value the length will be clamped to.

  Returns this

clampScalar

• clampScalar(min, max): this

• If this vector's x or y values are greater than the max value, they are replaced by the max value. If this vector's x or y values are less than the min value, they are replaced by the min value.

  Parameters

  • min: number

    the minimum value the components will be clamped to.
  • max: number

    the maximum value the components will be clamped to.

  Returns this

clone

• clone(): this

• Returns a new Vector2 instance with the same x and y values.

  Returns this

copy

• copy(v): this

• Copies value of v to this vector.

  Parameters

  • v: Vector2

  Returns this

cross

• cross(v): number

• Computes cross product of this vector and v.

  Parameters

  • v: Vector2

  Returns number

distanceTo

• distanceTo(v): number

• Computes distance of this vector to v.

  Parameters

  • v: Vector2

  Returns number

distanceToManhattan

• distanceToManhattan(v): number

• Parameters

  • v: Vector2

  Returns number

  Deprecated

  Use .manhattanDistanceTo() instead.

distanceToSquared

• distanceToSquared(v): number

• Computes squared distance of this vector to v.

  Parameters

  • v: Vector2

  Returns number

divide

• divide(v): this

• Divides this vector by v.

  Parameters

  • v: Vector2

  Returns this

divideScalar

• divideScalar(s): this

• Divides this vector by scalar s. Set vector to ( 0, 0 ) if s == 0.

  Parameters

  • s: number

  Returns this

dot

• dot(v): number

• Computes dot product of this vector and v.

  Parameters

  • v: Vector2

  Returns number

equals

• equals(v): boolean

• Checks for strict equality of this vector and v.

  Parameters

  • v: Vector2

  Returns boolean

floor

• floor(): this

• The components of the vector are rounded down to the nearest integer value.

  Returns this

fromArray

• fromArray(array, offset?): this

• Sets this vector's x and y value from the provided array or array-like.

  Parameters

  • array: ArrayLike<number> | number[]

    the source array or array-like.
  • Optional offset: number

    (optional) offset into the array. Default is 0.

  Returns this

fromBufferAttribute

• fromBufferAttribute(attribute, index): this

• Sets this vector's x and y values from the attribute.

  Parameters

  • attribute: BufferAttribute

    the source attribute.
  • index: number

    index in the attribute.

  Returns this

getComponent

• getComponent(index): number

• Gets a component of this vector.

  Parameters

  • index: number

  Returns number

length

• length(): number

• Computes length of this vector.

  Returns number

lengthManhattan

• lengthManhattan(): number

• Returns number

  Deprecated

  Use .manhattanLength() instead.

lengthSq

• lengthSq(): number

• Computes squared length of this vector.

  Returns number

lerp

• lerp(v, alpha): this

• Linearly interpolates between this vector and v, where alpha is the distance along the line - alpha = 0 will be this vector, and alpha = 1 will be v.

  Parameters

  • v: Vector2

    vector to interpolate towards.
  • alpha: number

    interpolation factor in the closed interval [0, 1].

  Returns this

lerpVectors

• lerpVectors(v1, v2, alpha): this

• Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.

  Parameters

  • v1: Vector2

    the starting vector.
  • v2: Vector2

    vector to interpolate towards.
  • alpha: number

    interpolation factor in the closed interval [0, 1].

  Returns this

manhattanDistanceTo

• manhattanDistanceTo(v): number

• Computes the Manhattan length (distance) from this vector to the given vector v

  see Taxicab Geometry

  Parameters

  • v: Vector2

  Returns number

manhattanLength

• manhattanLength(): number

• Computes the Manhattan length of this vector.

  see Taxicab Geometry

  Returns number

max

• max(v): this

• If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.

  Parameters

  • v: Vector2

  Returns this

min

• min(v): this

• If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.

  Parameters

  • v: Vector2

  Returns this

multiply

• multiply(v): this

• Multiplies this vector by v.

  Parameters

  • v: Vector2

  Returns this

multiplyScalar

• multiplyScalar(scalar): this

• Multiplies this vector by scalar s.

  Parameters

  • scalar: number

  Returns this

negate

• negate(): this

• Inverts this vector.

  Returns this

normalize

• normalize(): this

• Normalizes this vector.

  Returns this

random

• random(): this

• Sets this vector's x and y from Math.random

  Returns this

rotateAround

• rotateAround(center, angle): this

• Rotates the vector around center by angle radians.

  Parameters

  • center: Vector2

    the point around which to rotate.
  • angle: number

    the angle to rotate, in radians.

  Returns this

round

• round(): this

• The components of the vector are rounded to the nearest integer value.

  Returns this

roundToZero

• roundToZero(): this

• The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.

  Returns this

set

• set(x, y): this

• Sets value of this vector.

  Parameters

  • x: number
  • y: number

  Returns this

setComponent

• setComponent(index, value): this

• Sets a component of this vector.

  Parameters

  • index: number
  • value: number

  Returns this

setLength

• setLength(length): this

• Normalizes this vector and multiplies it by l.

  Parameters

  • length: number

  Returns this

setScalar

• setScalar(scalar): this

• Sets the x and y values of this vector both equal to scalar.

  Parameters

  • scalar: number

  Returns this

setX

• setX(x): this

• Sets X component of this vector.

  Parameters

  • x: number

  Returns this

setY

• setY(y): this

• Sets Y component of this vector.

  Parameters

  • y: number

  Returns this

sub

• sub(v): this

• Subtracts v from this vector.

  Parameters

  • v: Vector2

  Returns this

subScalar

• subScalar(s): this

• Subtracts s from this vector's x and y components.

  Parameters

  • s: number

  Returns this

subVectors

• subVectors(a, b): this

• Sets this vector to a - b.

  Parameters

  • a: Vector2
  • b: Vector2

  Returns this

toArray

• toArray(array?, offset?): number[]

• Returns an array [x, y], or copies x and y into the provided array.

  Parameters

  • Optional array: number[]

    (optional) array to store the vector to. If this is not provided, a new array will be created.
  • Optional offset: number

    (optional) optional offset into the array.

  Returns number[]

  The created or provided array.
• toArray(array?, offset?): Vector2Tuple

• Parameters

  • Optional array: Vector2Tuple
  • Optional offset: 0

  Returns Vector2Tuple

• toArray(array, offset?): ArrayLike<number>

• Copies x and y into the provided array-like.

  Parameters

  • array: ArrayLike<number>

    array-like to store the vector to.
  • Optional offset: number

    (optional) optional offset into the array.

  Returns ArrayLike<number>

  The provided array-like.