Home Reference Source Test Repository

import Vector2D from 'canvas-graph-creator/src/js/util/vector-2d.js'

public class | source

Vector2D

Class for representing 2D vectors.

Test:

Vector2D

Constructor Summary

Public Constructor
public	constructor(x: number, y: number) Constructs a Vector2D object.

Member Summary

Public Members
public get	length: number: * Getter for vector length.
public	x: *
public	y: *

Method Summary

Public Methods
public	add(vec: Vector2D): Vector2D Finds the result of addition with another vector.
public	cross(vec: Vector2D): number Finds the "cross product" between this vector and another vector.
public	degreesTo(vec: Vector2D): number Finds the angle between two vectors (in degrees).
public	dot(vec: Vector2D): number Finds the dot product between this vector and another vector.
public	equals(vec: Vector2D): boolean Checks if this vector and another vector are equal.
public	projectOnto(vec: Vector2D): Vector2D Finds the vector projection of this vector onto another vector.
public	rotateDegrees(deg: number): Vector2D Finds the vector resulting from a rotation in degrees.
public	rotateRadians(rad: number): Vector2D Finds the vector resulting from a rotation in radians.
public	scale(n: number): Vector2D Finds the vector resulting from multiplication by a scalar.
public	sub(vec: Vector2D): Vector2D Finds the result of subtracting another vector.

Public Constructors

public constructor(x: number, y: number) source

Constructs a Vector2D object.

Params:

Name	Type	Attribute	Description
x	number		x-component of the vector.
y	number		y-component of the vector.

Test:

Vector2D #constructor(a, b)

Public Members

public get length: number: * source

Getter for vector length.

Return:

The length of the vector.

Test:

Vector2D .length

public x: * source

public y: * source

Public Methods

public add(vec: Vector2D): Vector2D source

Finds the result of addition with another vector.

Params:

Name	Type	Attribute	Description
vec	Vector2D		The vector to add.

Return:

The result of vector addition.

Test:

Vector2D #add(vec)

public cross(vec: Vector2D): number source

Finds the "cross product" between this vector and another vector.

Params:

Name	Type	Attribute	Description
vec	Vector2D		Vector to find the cross product with.

Return:

The value of the cross product. Zero means the vectors are parallel.

Test:

Vector2D #cross(vec)

public degreesTo(vec: Vector2D): number source

Finds the angle between two vectors (in degrees).

Params:

Name	Type	Attribute	Description
vec	Vector2D		Vector to find the angle to.

Return:

Angle between the vectors in degrees.

Test:

Vector2D #degreesTo(vec)

public dot(vec: Vector2D): number source

Finds the dot product between this vector and another vector.

Params:

Name	Type	Attribute	Description
vec	Vector2D		Vector to find a dot product with.

Return:

The value of the dot product.

Test:

Vector2D #dot(vec)

public equals(vec: Vector2D): boolean source

Checks if this vector and another vector are equal. Returns true if the x- and y-components are equal.

Params:

Name	Type	Attribute	Description
vec	Vector2D		Vector to compare with.

Return:

Whether or not the vectors are equivalent.

Test:

Vector2D #equals(vec)

public projectOnto(vec: Vector2D): Vector2D source

Finds the vector projection of this vector onto another vector.

Params:

Name	Type	Attribute	Description
vec	Vector2D		Vector to project onto.

Return:

Vector resulting from the vector projection.

Test:

Vector2D #projectOnto(vec)

public rotateDegrees(deg: number): Vector2D source

Finds the vector resulting from a rotation in degrees.

Params:

Name	Type	Attribute	Description
deg	number		Angle (in degrees) to rotate.

Return:

Vector resulting from the rotation.

Test:

Vector2D #rotateDegrees(deg)

public rotateRadians(rad: number): Vector2D source

Finds the vector resulting from a rotation in radians.

Params:

Name	Type	Attribute	Description
rad	number		Angle (in radians) to rotate.

Return:

Vector resulting from the rotation.

Test:

Vector2D #rotateRadians(rad)

public scale(n: number): Vector2D source

Finds the vector resulting from multiplication by a scalar.

Params:

Name	Type	Attribute	Description
n	number		The scalar to multiply by.

Return:

Vector resulting from the scale.

Test:

Vector2D #scale(n)

public sub(vec: Vector2D): Vector2D source

Finds the result of subtracting another vector.

Params:

Name	Type	Attribute	Description
vec	Vector2D		The vector to subtract.

Return:

The result of vector subtraction.

Test:

Vector2D #sub(vec)