Class Vector2

Represents a two-dimensional vector with x and y components.
Provides static methods for common vector operations like addition, subtraction, scaling, dot product, cross product, normalization and more.
Used throughout the engine for storing 2D positions, directions, velocities and other vector quantities.

Example

const v1 = new Vector2(2, 1);
const v2 = new Vector2(3, 2);
const v3 = new Vector2(); // zero vector

Vector2.add(v3, v1, v2);
v3.x // 5
v3.y // 3

Constructors

constructor

Accessors

direction magnitude x y

Methods

clone copy distance equals set toString add ceil cross dot floor normal round scale subtract unit

Constructors

constructor

Accessors

direction

magnitude

  • get magnitude(): number

  • Get the magnitude of the vector

    Returns number

    The magnitude of the vector

x

y

Methods

clone

copy

distance

  • distance(vector): number

  • Get the distance with another vector

    Parameters

    • vector: Vector2

      The vector to compare

    Returns number

    The magnitude of the distance

equals

  • equals(vector): boolean

  • Compare if two vector are equals

    Parameters

    • vector: Vector2

      The vector to compare

    Returns boolean

    True if the vectors are equals, false if not

set

  • set(x, y): void

  • Set the vector

    Parameters

    • x: number

      The x value

    • y: number

      The y value

    Returns void

toString

Staticadd

  • add(out, a, b): Vector2

  • Calculates a + b

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(2, 1);
    const v2 = new Vector2(3, 2);
    const v3 = Vector2.add(new Vector2(), v1, v2);
    v3.x // 5
    v3.y // 3

Staticceil

  • ceil(out, a): Vector2

  • Ceils a vector

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(3.9, 2.2);
    const v2 = Vector2.ceil(new Vector2(), v1);
    v2.x // 4
    v2.y // 3

    Example

    const v1 = new Vector2(3.9, 2.2);
    Vector2.ceil(v1, v1);
    v1.x // 4
    v1.y // 3

Staticcross

  • cross(a, b): number

  • Calculates the cross product of two vectors and returns a scalar value

    Parameters

    Returns number

    The cross produc result

    Example

    const v1 = new Vector2(3, 2);
    const v2 = new Vector2(2, 1);
    Vector2.cross(v1, v2); // -1

Staticdot

  • dot(a, b): number

  • Calculates the dot product of two vectors and returns a scalar value

    Parameters

    Returns number

    The dot product result

    Example

    const v1 = new Vector2(3, 2);
    const v2 = new Vector2(2, 1);
    Vector2.dot(v1, v2); // 8

Staticfloor

  • floor(out, a): Vector2

  • Floors a vector

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(3.9, 2.2);
    const v2 = Vector2.floor(new Vector2(), v1);
    v2.x // 3
    v2.y // 2

    Example

    const v1 = new Vector2(3.9, 2.2);
    Vector2.floor(v1, v1);
    v1.x // 3
    v1.y // 2

Staticnormal

  • normal(out, a): Vector2

  • Normalize a vector

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(0, 2);
    const v2 = Vector2.normal(new Vector2(), v1);
    v2.x // -2
    v2.y // 0

Staticround

  • round(out, a): Vector2

  • Rounds a vector

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(3.9, 2.2);
    const v2 = Vector2.round(new Vector2(), v1);
    v2.x // 4
    v2.y // 2

    Example

    const v1 = new Vector2(3.9, 2.2);
    Vector2.round(v1, v1);
    v1.x // 4
    v1.y // 2

Staticscale

  • scale(out, a, scalar): Vector2

  • Scale a vector

    Parameters

    • out: Vector2

      The output vector

    • a: Vector2

      The vector to scale

    • scalar: number

      The scalar value

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(3, 2);
    const v2 = Vector2.scale(new Vector2(), v1, 2);
    v2.x // 6
    v2.y // 4

Staticsubtract

  • subtract(out, a, b): Vector2

  • Calculates a - b

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(3, 2);
    const v2 = new Vector2(2, 1);
    const v3 = Vector2.subtract(new Vector2(), v1, v2);
    v3.x // 1
    v3.y // 1

Staticunit

  • unit(out, a): Vector2

  • Returns the unit vector

    Parameters

    Returns Vector2

    The output vector

    Example

    const v1 = new Vector2(3, 0);
    const v2 = Vector2.unit(new Vector2(), v1);
    v2.x // 1
    v2.y // 0

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods