Interface Vector

A quantity with magnitude and direction.

See

interface Vector {
    get magnitude(): number;
    get squaredMagnitude(): number;
    add(vector: VectorLike): VectorLike;
    ceil(): VectorLike;
    clone(): VectorLike;
    copy(vector: VectorLike): this;
    distance(vector: VectorLike): number;
    divide(vector: VectorLike): VectorLike;
    dot(vector: VectorLike): number;
    equals(vector: VectorLike): boolean;
    exactEquals(vector: VectorLike): boolean;
    floor(): VectorLike;
    invert(): VectorLike;
    lerp(vector: VectorLike, t: number): VectorLike;
    max(vector: VectorLike): VectorLike;
    min(vector: VectorLike): VectorLike;
    multiply(vector: VectorLike): VectorLike;
    negate(): VectorLike;
    normalize(): VectorLike;
    pow(exponent: number): VectorLike;
    random(magnitude: number): this;
    round(): VectorLike;
    scale(scalar: number): VectorLike;
    scaleAndAdd(vector: VectorLike, scalar: number): VectorLike;
    squaredDistance(vector: VectorLike): number;
    subtract(vector: VectorLike): VectorLike;
    zero(): this;
    [key: number]: number;
}

Hierarchy (View Summary)

VectorLike
- Vector

Implemented by

Indexable

[key: number]: number

Index

Accessors

magnitude squaredMagnitude

Methods

add ceil clone copy distance divide dot equals exactEquals floor invert lerp max min multiply negate normalize pow random round scale scaleAndAdd squaredDistance subtract zero

Accessors

magnitude

get magnitude(): number
Get the magnitude (length) of this vector.

Returns number
- Defined in src/linalg/Vector.ts:137

squaredMagnitude

get squaredMagnitude(): number
Get the squared magnitude (length) of this vector.

Returns number
- Defined in src/linalg/Vector.ts:140

Methods

add

add(vector: VectorLike): VectorLike
Add two vectors of the same size.
Parameters
- vector: VectorLike
  The other vector.
Returns VectorLike
The sum of the vectors.
- Defined in src/linalg/Vector.ts:32

ceil

ceil(): VectorLike
Round up the components of this vector.

Returns VectorLike
The rounded vector.
- Defined in src/linalg/Vector.ts:72

clone

clone(): VectorLike
Create a copy of this vector.

Returns VectorLike
A copy of this vector.
- Defined in src/linalg/Vector.ts:38

copy

copy(vector: VectorLike): this
Copy the values of another vector into this one.
Parameters
- vector: VectorLike
  The vector to copy.
Returns this
This vector.
- Defined in src/linalg/Vector.ts:45

distance

distance(vector: VectorLike): number
Calculate the Euclidean distance between this vector and another.
Parameters
- vector: VectorLike
  The other vector.
Returns number
The distance.
- Defined in src/linalg/Vector.ts:127

divide

divide(vector: VectorLike): VectorLike
Divide this vector by another.
Parameters
- vector: VectorLike
  The other vector.
Returns VectorLike
The quotient of the vectors.
- Defined in src/linalg/Vector.ts:59

dot

dot(vector: VectorLike): number
Calculate the dot product of this and another vector.
Parameters
- vector: VectorLike
  The other vector.
Returns number
The dot product.

See
Dot product
- Defined in src/linalg/Vector.ts:167

equals

equals(vector: VectorLike): boolean
Determine whether this vector is roughly equivalent to another.
Parameters
- vector: VectorLike
  The other vector.
Returns boolean
Whether the vectors are equivalent.
- Defined in src/linalg/Vector.ts:18

exactEquals

exactEquals(vector: VectorLike): boolean
Determine whether this vector is exactly equivalent to another.
Parameters
- vector: VectorLike
  The other vector.
Returns boolean
Whether the vectors are equivalent.
- Defined in src/linalg/Vector.ts:25

floor

floor(): VectorLike
Round down the components of this vector.

Returns VectorLike
The rounded vector.
- Defined in src/linalg/Vector.ts:78

invert

invert(): VectorLike
Calculate the multiplicative inverse of the components of this vector.

Returns VectorLike
The inverted vector.
- Defined in src/linalg/Vector.ts:152

lerp

lerp(vector: VectorLike, t: number): VectorLike
Perform a linear interpolation between this and another vector.
Parameters
- vector: VectorLike
  The other vector.
- t: number
  The interpolation amount (in [0,1]).
Returns VectorLike
The interpolated vector.
- Defined in src/linalg/Vector.ts:175

max

max(vector: VectorLike): VectorLike
Return the maximum of this and another vector.
Parameters
- vector: VectorLike
  The other vector.
Returns VectorLike
The maximum.
- Defined in src/linalg/Vector.ts:98

min

min(vector: VectorLike): VectorLike
Return the minimum of this and another vector.
Parameters
- vector: VectorLike
  The other vector.
Returns VectorLike
The minimum.
- Defined in src/linalg/Vector.ts:91

multiply

multiply(vector: VectorLike): VectorLike
Multiply this vector by another.
Parameters
- vector: VectorLike
  The other vector.
Returns VectorLike
The product of the vectors.
- Defined in src/linalg/Vector.ts:52

negate

negate(): VectorLike
Negate this vector.

Returns VectorLike
The negated vector.
- Defined in src/linalg/Vector.ts:146

normalize

normalize(): VectorLike
Normalize this vector.

Returns VectorLike
The normalized vector.

See
Unit vector
- Defined in src/linalg/Vector.ts:159

pow

pow(exponent: number): VectorLike
Raise each component of this vector to the given power.
Parameters
- exponent: number
  The exponent (power) to raise each component to.
Returns VectorLike
The power (result of the exponentiation).
- Defined in src/linalg/Vector.ts:105

random

random(magnitude: number): this
Set this vector to a random value with the given magnitude.
Parameters
- magnitude: number
  The magnitude.
Returns this
This vector.
- Defined in src/linalg/Vector.ts:182

round

round(): VectorLike
Round the components of this vector.

Returns VectorLike
The rounded vector.
- Defined in src/linalg/Vector.ts:84

scale

scale(scalar: number): VectorLike
Scale this vector by a scalar.
Parameters
- scalar: number
  The scalar.
Returns VectorLike
The scaled vector.
- Defined in src/linalg/Vector.ts:112

scaleAndAdd

scaleAndAdd(vector: VectorLike, scalar: number): VectorLike
Add another vector to this one after scaling the other by a scalar.
Parameters
- vector: VectorLike
  The other vector.
- scalar: number
  The scalar.
Returns VectorLike
The sum.
- Defined in src/linalg/Vector.ts:120

squaredDistance

squaredDistance(vector: VectorLike): number
Calculate the squared Euclidean distance between this vector and another.
Parameters
- vector: VectorLike
  The other vector.
Returns number
The squared distance.
- Defined in src/linalg/Vector.ts:134

subtract

subtract(vector: VectorLike): VectorLike
Subtract another vector from this one.
Parameters
- vector: VectorLike
  The other vector.
Returns VectorLike
The difference between the vectors.
- Defined in src/linalg/Vector.ts:66

zero

zero(): this
Set this to the zero vector.

Returns this
This vector.
- Defined in src/linalg/Vector.ts:188

Interface Vector

See

Hierarchy (View Summary)

Implemented by

Indexable

Index

Accessors

Methods

Accessors

magnitude

Returns number

squaredMagnitude

Returns number

Methods

add

Parameters

Returns VectorLike

ceil

Returns VectorLike

clone

Returns VectorLike

copy

Parameters

Returns this

distance

Parameters

Returns number

divide

Parameters

Returns VectorLike

dot

Parameters

Returns number

See

equals

Parameters

Returns boolean

exactEquals

Parameters

Returns boolean

floor

Returns VectorLike

invert

Returns VectorLike

lerp

Parameters

Returns VectorLike

max

Parameters

Returns VectorLike

min

Parameters

Returns VectorLike

multiply

Parameters

Returns VectorLike

negate

Returns VectorLike

normalize

Returns VectorLike

See

pow

Parameters

Returns VectorLike

random

Parameters

Returns this

round

Returns VectorLike

scale

Parameters

Returns VectorLike

scaleAndAdd

Parameters

Returns VectorLike

squaredDistance

Parameters

Returns number

subtract

Parameters