Class Vector

Hierarchy

Vector

Index

Constructors

constructor

Properties

x
y
z

Methods

Constructors

constructor

new Vector(x?: number, y?: number, z?: number): Vector

- Defined in src/classes/Vector.ts:50
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
Returns Vector

Properties

x

x: number

y

y: number

z

z: number

Methods

add

add(vector: Vector): Vector
add(offset: readonly [undefined | number, undefined | number, undefined | number]): Vector
add(x: number, y: number, z: number): Vector

- Defined in src/classes/Vector.ts:86
Parameters
- vector: Vector
Returns Vector
- Defined in src/classes/Vector.ts:87
Parameters
- offset: readonly [undefined | number, undefined | number, undefined | number]
Returns Vector
- Defined in src/classes/Vector.ts:88
Parameters
- x: number
- y: number
- z: number
Returns Vector

angleBetween

angleBetween(vector: Vector): number

- Defined in src/classes/Vector.ts:290
Parameters
- vector: Vector
Returns number

array

array(): readonly [number, number, number]

- Defined in src/classes/Vector.ts:316
Returns readonly [number, number, number]

copy

copy(): Vector

- Defined in src/classes/Vector.ts:82
Returns Vector

cross

cross(v: Vector): Vector

- Defined in src/classes/Vector.ts:247
Parameters
- v: Vector
Returns Vector

div

div(n: number): Vector

- Defined in src/classes/Vector.ts:216
Parameters
- n: number
Returns Vector

dot

dot(vector: Vector): number
dot(x?: number, y?: number, z?: number): number

- Defined in src/classes/Vector.ts:237
Parameters
- vector: Vector
Returns number
- Defined in src/classes/Vector.ts:238
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
Returns number

equals

equals(vector: Vector): boolean
equals(params: readonly [undefined | number, undefined | number, undefined | number]): boolean
equals(x?: number, y?: number, z?: number): boolean

- Defined in src/classes/Vector.ts:320
Parameters
- vector: Vector
Returns boolean
- Defined in src/classes/Vector.ts:321
Parameters
- params: readonly [undefined | number, undefined | number, undefined | number]
Returns boolean
- Defined in src/classes/Vector.ts:322
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
Returns boolean

heading

heading(): number

- Defined in src/classes/Vector.ts:278
Returns number

lerp

lerp(vector: Vector, amt?: number): Vector
lerp(x?: number, y?: number, z?: number, amt?: number): Vector

- Defined in src/classes/Vector.ts:298
Parameters
- vector: Vector
- Optional amt: number
Returns Vector
- Defined in src/classes/Vector.ts:299
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
- Optional amt: number
Returns Vector

limit

limit(max: number): Vector

- Defined in src/classes/Vector.ts:263
Parameters
- max: number
Returns Vector

mag

mag(): number

- Defined in src/classes/Vector.ts:228
Returns number

magSq

magSq(): number

- Defined in src/classes/Vector.ts:232
Returns number

mult

mult(n: number): Vector

- Defined in src/classes/Vector.ts:209
Parameters
- n: number
Returns Vector

normalize

normalize(): Vector

- Defined in src/classes/Vector.ts:255
Returns Vector

reflect

reflect(surfaceNormal: Vector): Vector

- Defined in src/classes/Vector.ts:311
Parameters
- surfaceNormal: Vector
Returns Vector

rem

rem(vector: Vector): void
rem(params: readonly [number, undefined | number, undefined | number]): void

- Defined in src/classes/Vector.ts:114
Parameters
- vector: Vector
Returns void
- Defined in src/classes/Vector.ts:115
Parameters
- params: readonly [number, undefined | number, undefined | number]
Returns void

rotate

rotate(angle: number): Vector

- Defined in src/classes/Vector.ts:282
Parameters
- angle: number
Returns Vector

set

set(vector: Vector): Vector
set(offset: readonly [undefined | number, undefined | number, undefined | number]): Vector
set(x?: number, y?: number, z?: number): Vector

- Defined in src/classes/Vector.ts:54
Parameters
- vector: Vector
Returns Vector
- Defined in src/classes/Vector.ts:55
Parameters
- offset: readonly [undefined | number, undefined | number, undefined | number]
Returns Vector
- Defined in src/classes/Vector.ts:56
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
Returns Vector

setMag

setMag(n: number): Vector

- Defined in src/classes/Vector.ts:274
Parameters
- n: number
Returns Vector

sub

sub(vector: Vector): Vector
sub(offset: readonly [undefined | number, undefined | number, undefined | number]): Vector
sub(x: number, y: number, z: number): Vector

- Defined in src/classes/Vector.ts:181
Parameters
- vector: Vector
Returns Vector
- Defined in src/classes/Vector.ts:182
Parameters
- offset: readonly [undefined | number, undefined | number, undefined | number]
Returns Vector
- Defined in src/classes/Vector.ts:183
Parameters
- x: number
- y: number
- z: number
Returns Vector

toString

toString(): string

- Defined in src/classes/Vector.ts:348
Returns string

Generated using TypeDoc