Vector2 | ts-vector-math

Hierarchy

Vector2

Index

Constructors

constructor

Properties

_values

Accessors

x
xy
y
zero

Methods

Constructors

constructor

new Vector2(values?: number[]): Vector2

- Defined in vec2.ts:55
Parameters
- Optional values: number[]
Returns Vector2

Properties

Private _values

_values: Float32Array = new Float32Array(2)

Accessors

x

x:

xy

xy:

y

y:

Static zero

zero:

Retrieves a new instance of the vector (0, 0)

Methods

add

add(vector: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:297
Adds two vectors together. If no dest vector is specified, the operation is performed in-place.

Parameters
- vector: Vector2
- Optional dest: Vector2
Returns Vector2

at

at(index: number): number

- Defined in vec2.ts:219
Retrieves the x-component or y-component of the vector.

Parameters
- index: number
Returns number

copy

copy(dest?: Vector2): Vector2

- Defined in vec2.ts:237
Copies the x- and y-components from one vector to another. If no dest vector is specified, a new vector is instantiated.

Parameters
- Optional dest: Vector2
Returns Vector2

divide

divide(vector: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:338
Divides two vectors piecewise.

Parameters
- vector: Vector2
- Optional dest: Vector2
Returns Vector2

equals

equals(other: Vector2, threshold?: number): boolean

- Defined in vec2.ts:262
Checks if two vectors are equal, using a threshold to avoid floating-point precision errors.

Parameters
- other: Vector2
- Default value threshold: number = EPSILON
Returns boolean

length

length(): number

- Defined in vec2.ts:276
Returns the distance from the vector to the origin.

Returns number

multiply

multiply(vector: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:325
Multiplies two vectors together piecewise. If no dest vector is specified, the operation is performed in-place.

Parameters
- vector: Vector2
- Optional dest: Vector2
Returns Vector2

negate

negate(dest?: Vector2): Vector2

- Defined in vec2.ts:249
Multiplies both the x- and y-components of a vector by -1. If no dest vector is specified, the operation is performed in-place.

Parameters
- Optional dest: Vector2
Returns Vector2

normalize

normalize(dest?: Vector2): Vector2

- Defined in vec2.ts:365
Normalizes a vector. If no dest vector is specified, the operation is performed in-place.

Parameters
- Optional dest: Vector2
Returns Vector2

reset

reset(): void

- Defined in vec2.ts:226
Sets both the x- and y-components of the vector to 0.

Returns void

scale

scale(value: number, dest?: Vector2): Vector2

- Defined in vec2.ts:352
Scales a vector by a scalar parameter. If no dest vector is specified, the operation is performed in-place.

Parameters
- value: number
- Optional dest: Vector2
Returns Vector2

squaredLength

squaredLength(): number

- Defined in vec2.ts:284
Returns the distance from the vector to the origin, squared.

Returns number

subtract

subtract(vector: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:311
Subtracts one vector from another. If no dest vector is specified, the operation is performed in-place.

Parameters
- vector: Vector2
- Optional dest: Vector2
Returns Vector2

toString

toString(): string

- Defined in vec2.ts:382
Returns string

Static cross

cross(vector: Vector2, vector2: Vector2, dest?: Vector3): Vector3

- Defined in vec2.ts:62
Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector3
Returns Vector3

Static difference

difference(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:167
Subtracts two vectors. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
Returns Vector2

Static direction

direction(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:113
Calculates a normalized vector representing the direction from one vector to another. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
Returns Vector2

Static distance

distance(vector: Vector2, vector2: Vector2): number

- Defined in vec2.ts:89
Calculates the distance between two vectors

Parameters
- vector: Vector2
- vector2: Vector2
Returns number

The distance between the two vectors

Static dot

dot(vector: Vector2, vector2: Vector2): number

- Defined in vec2.ts:79
Calculates the dot product of two vectors

Parameters
- vector: Vector2
- vector2: Vector2
Returns number

The dot product of the two vectors

Static lerp

lerp(a: Vector2, b: Vector2, t: number, dest?: Vector2): Vector2

- Defined in vec2.ts:137
Performs a linear interpolation over two vectors. If no dest vector is specified, a new vector is instantiated.

Parameters
- a: Vector2
- b: Vector2
- t: number
- Optional dest: Vector2
Returns Vector2

Static product

product(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:188
Multiplies two vectors piecewise. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
Returns Vector2

Static quotient

quotient(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:205
Divides two vectors piecewise. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
Returns Vector2

Static squaredDistance

squaredDistance(vector: Vector2, vector2: Vector2): number

- Defined in vec2.ts:99
Calculates the distance between two vectors squared

Parameters
- vector: Vector2
- vector2: Vector2
Returns number

The distance between the two vectors

Static sum

sum(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in vec2.ts:152
Adds two vectors. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
Returns Vector2

Generated using TypeDoc