Class vec2

Description

A two dimensional vector. Vectors can only store finite numbers in the range Number.MIN_VALUE to Number.MAX_VALUE.

Index

Constructors

Properties

g length lengthSquared r x y

Methods

add angleTo clampLength distance distanceSquared div dot equal moveTowards mult normalize project projectOnPlane reflect scale sub toString uniformScale

Constructors

constructor

new vec2(x, y): vec2
Parameters
- x: number
- y: number
Returns vec2
Description
Creates a new instance of a vec2.

Properties

g

g: number

Description

Alternate name for the y component.

length

length: number

Description

Returns the length of the vector.

lengthSquared

lengthSquared: number

Description

Returns the squared length of the vector.

r

r: number

Description

Alternate name for the x component.

x

x: number

Description

x component of the vec2.

y

y: number

Description

y component of the vec2.

Methods

add

add(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns the vector plus vec.

angleTo

angleTo(vec): number
Parameters
- vec: vec2
Returns number
Description
Returns the angle between the vector and vec.

clampLength

clampLength(length): vec2
Parameters
- length: number
Returns vec2
Description
Returns a copy of the vector with its length clamped to length.

distance

distance(vec): number
Parameters
- vec: vec2
Returns number
Description
Returns the distance between the vector and the vector vec.

distanceSquared

distanceSquared(vec): number
Parameters
- vec: vec2
Returns number
Description
Like distance(), but returns the squared distance between vectors.

div

div(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns the division of the vector by the vector vec.

dot

dot(vec): number
Parameters
- vec: vec2
Returns number
Description
Returns the dot product of the vector and vec.

equal

equal(vec): boolean
Parameters
- vec: vec2
Returns boolean
Description
Returns whether this is equal to vec.

moveTowards

moveTowards(point, magnitude): vec2
Parameters
- point: vec2
- magnitude: number
Returns vec2
Description
Returns a copy of the vector moved towards the point point by the amount magnitude.

mult

mult(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns the component-wise multiplication product of the vector and vec.

normalize

normalize(): vec2
Returns vec2
Description
Returns a copy of the vector with its length scaled to 1.

project

project(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns a copy of the vector projected onto the vector vec.

projectOnPlane

projectOnPlane(normal): vec2
Parameters
- normal: vec2
Returns vec2
Description
Projects the vector onto the plane represented by the normal normal.

reflect

reflect(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns a copy of the vector reflected across the plane defined by the normal vec.

scale

scale(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns the component-wise multiplication product of the vector and vec.

sub

sub(vec): vec2
Parameters
- vec: vec2
Returns vec2
Description
Returns the vector minus vec.

toString

toString(): string
Returns string
Description
Returns a string representation of the vector.

uniformScale

uniformScale(scale): vec2
Parameters
- scale: number
Returns vec2
Description
Multiplies the components by the number scale.

Generated using TypeDoc