tommccracken / vector-2d

A 2D vector math module written in TypeScript (work in progress)

Introduction

A 2D vector math module written in TypeScript.

Source

The MIT License (Copyright 2020 - 2021 Thomas O. McCracken)

Usage

Installation

[TBA once package prepared]

API

Refer to the Vector2d class documentation.

Basic examples

Import the library

[TBA once package prepared]

Create a vector with x and y component values of 1.5 and 3 respectively

let vector1 = new Vector2D(1.5, 3);

Get the length of the vector

let length = vector1.getLength();

Get a normal vector for vector1

let normalVector = vector1.normalVector();

Create a second vector and add it to the first vector

let vector2 = new Vector2D(-1, 5);
let vector3 = vector1.add(vector2);

Note: This is an immutable addition operation as vector1 and vector2 are not modified. The result will be returned as the new Vector2D object, vector3.

Perform a mutable addition

vector1.mutableAdd(vector2);

Note: This is a mutable addition operation as the result of the addition operation is stored in the original Vector2D object vector1. Mutable operations are likely to be more appropriate for applications involving many vector operations (due to a reduction in the overhead associated with creating and cleaning up new Vector2D objects).

Calculate the dot and cross products of vector1 and vector2

let dotProduct = vector1.getDotProduct(vector2);
let crossProduct = vector1.getCrossProduct(vector2);

Print vector1 as a string

console.log(vector1.toString());