Class Vector

Hierarchy

Vector

Implements

Indexable

[axis: string]: any

Constructors

constructor

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

- Defined in classes/Vector.ts:315
Parameters
- vector: IVectorData
Returns Vector
- Defined in classes/Vector.ts:316
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
Returns Vector

Properties

Readonly x

x: number

Readonly y

y: number

Readonly z

z: number

Methods

add

add(...vectors: IVectorData[]): Vector

- Defined in classes/Vector.ts:368
Parameters
- Rest ...vectors: IVectorData[]
Returns Vector

apply

apply(modifier: IVectorApplyModifier): Vector

- Defined in classes/Vector.ts:444
Parameters
- modifier: IVectorApplyModifier
Returns Vector

applyWithin

applyWithin(context: IInversible<IAppliableOnVector>, modifier: IVectorApplyModifierFunction): Vector

- Defined in classes/Vector.ts:448
Parameters
- context: IInversible<IAppliableOnVector>
- modifier: IVectorApplyModifierFunction
Returns Vector

clone

clone(): Vector

- Defined in classes/Vector.ts:362
Returns Vector

crossProduct

crossProduct(vectorB: IVectorData): Vector

- Defined in classes/Vector.ts:404
Parameters
- vectorB: IVectorData
Returns Vector

cubeMax

cubeMax(): Vector

- Defined in classes/Vector.ts:432
Returns Vector

distance

distance(vectorB?: IVectorData): number

- Defined in classes/Vector.ts:420
Parameters
- Optional vectorB: IVectorData
Returns number

distanceSquared

distanceSquared(vectorB?: IVectorData): number

- Defined in classes/Vector.ts:424
Parameters
- Optional vectorB: IVectorData
Returns number

divide

divide(vectorB: IVectorData): Vector

- Defined in classes/Vector.ts:380
Parameters
- vectorB: IVectorData
Returns Vector

dotProduct

dotProduct(vectorB: IVectorData): number

- Defined in classes/Vector.ts:400
Parameters
- vectorB: IVectorData
Returns number

double

double(): Vector

- Defined in classes/Vector.ts:350
Returns Vector

half

half(): Vector

- Defined in classes/Vector.ts:338
Returns Vector

inverse

inverse(): Vector

Implementation of IInversible.inverse
- Defined in classes/Vector.ts:330
Returns Vector

isEqual

isEqual(vectorB: IVectorData): boolean

- Defined in classes/Vector.ts:408
Parameters
- vectorB: IVectorData
Returns boolean

isZero

isZero(): boolean

- Defined in classes/Vector.ts:412
Returns boolean

map

map(modifier: (value: number, axis: keyof IVectorData) => number): Vector

- Defined in classes/Vector.ts:436
Parameters
- modifier: (value: number, axis: keyof IVectorData) => number
  - - (value: number, axis: keyof IVectorData): number
    - Parameters
      - value: number
      - axis: keyof IVectorData
      Returns number
Returns Vector

mapEachPlane

mapEachPlane(callback: (ortogonalAxis: IAxis, vectorBD: Vector) => IVectorData): Vector

- Defined in classes/Vector.ts:392
Parameters
- callback: (ortogonalAxis: IAxis, vectorBD: Vector) => IVectorData
  - - (ortogonalAxis: IAxis, vectorBD: Vector): IVectorData
    - Parameters
      - ortogonalAxis: IAxis
      - vectorBD: Vector
      Returns IVectorData
Returns Vector

mapPlane

mapPlane(ortogonalAxis: IAxis, callback: (vectorBD: Vector) => IVectorData): Vector

- Defined in classes/Vector.ts:396
Parameters
- ortogonalAxis: IAxis
- callback: (vectorBD: Vector) => IVectorData
  - - (vectorBD: Vector): IVectorData
    - Parameters
      - vectorBD: Vector
      Returns IVectorData
Returns Vector

multiply

multiply(...vectors: IVectorData[]): Vector

- Defined in classes/Vector.ts:376
Parameters
- Rest ...vectors: IVectorData[]
Returns Vector

negate

negate(): Vector

- Defined in classes/Vector.ts:334
Returns Vector

quarter

quarter(): Vector

- Defined in classes/Vector.ts:346
Returns Vector

rearrangeAxes

rearrangeAxes(modifier: (values: number[]) => number[]): Vector

- Defined in classes/Vector.ts:440
Parameters
- modifier: (values: number[]) => number[]
  - - (values: number[]): number[]
    - Parameters
      - values: number[]
      Returns number[]
Returns Vector

rotate

rotate(rotate: IVectorData): Vector

- Defined in classes/Vector.ts:388
Parameters
- rotate: IVectorData
Returns Vector

rotation

rotation(vectorB?: IVectorData): number

- Defined in classes/Vector.ts:428
Parameters
- Optional vectorB: IVectorData
Returns number

scale

scale(scale: number): Vector

- Defined in classes/Vector.ts:384
Parameters
- scale: number
Returns Vector

stripInfatesimals

stripInfatesimals(): Vector

- Defined in classes/Vector.ts:416
Returns Vector

subtract

subtract(vectorB: IVectorData): Vector

- Defined in classes/Vector.ts:372
Parameters
- vectorB: IVectorData
Returns Vector

third

third(): Vector

- Defined in classes/Vector.ts:342
Returns Vector

to2D

to2D(): Vector

- Defined in classes/Vector.ts:452
Returns Vector

toArray

toArray(): number[]

- Defined in classes/Vector.ts:472
Returns number[]

toArray2D

toArray2D(): [number, number]

- Defined in classes/Vector.ts:476
Returns [number, number]

toArray3D

toArray3D(): [number, number, number]

- Defined in classes/Vector.ts:480
Returns [number, number, number]

toJSON

toJSON(): IVectorData

- Defined in classes/Vector.ts:456
Returns IVectorData

toObject

toObject<T>(axisMapping?: keyof T[]): T

- Defined in classes/Vector.ts:460
Type parameters
- T = IVectorData
Parameters
- Optional axisMapping: keyof T[]
Returns T

toObject2D

toObject2D(): IVectorData

- Defined in classes/Vector.ts:464
Returns IVectorData

toObject3D

toObject3D(): IVectorData

- Defined in classes/Vector.ts:468
Returns IVectorData

toString

toString(): string

- Defined in classes/Vector.ts:484
Returns string

toString2D

toString2D(): string

- Defined in classes/Vector.ts:488
Returns string

toString3D

toString3D(): string

- Defined in classes/Vector.ts:492
Returns string

triple

triple(): Vector

- Defined in classes/Vector.ts:354
Returns Vector

Static add

add(...vectors: IVectorData[]): Vector

- Defined in classes/Vector.ts:87
Parameters
- Rest ...vectors: IVectorData[]
Returns Vector

Static apply

apply(vector: IVectorData, modifier: IVectorApplyModifier): Vector

- Defined in classes/Vector.ts:240
Parameters
- vector: IVectorData
- modifier: IVectorApplyModifier
Returns Vector

Static applyWithin

applyWithin(vector: IVectorData, context: IInversible<IAppliableOnVector>, modifier: IVectorApplyModifierFunction): Vector

- Defined in classes/Vector.ts:248
Parameters
- vector: IVectorData
- context: IInversible<IAppliableOnVector>
- modifier: IVectorApplyModifierFunction
Returns Vector

Static average

average(...vectors: IVectorData[]): IVectorData

- Defined in classes/Vector.ts:164
Parameters
- Rest ...vectors: IVectorData[]
Returns IVectorData

Static clone

clone(vector: IVectorData): Vector

- Defined in classes/Vector.ts:83
Parameters
- vector: IVectorData
Returns Vector

Static crossProduct

crossProduct(vectorA: IVectorData, vectorB: IVectorData): Vector

- Defined in classes/Vector.ts:158
Parameters
- vectorA: IVectorData
- vectorB: IVectorData
Returns Vector

Static cube

cube(scale?: number): Vector

- Defined in classes/Vector.ts:24
Parameters
- scale: number = 1
Returns Vector

Static cubeMax

cubeMax(vector: IVectorData): Vector

- Defined in classes/Vector.ts:212
Parameters
- vector: IVectorData
Returns Vector

Static distance

distance(vectorA: IVectorData, vectorB?: IVectorData): number

- Defined in classes/Vector.ts:194
Parameters
- vectorA: IVectorData
- vectorB: IVectorData = ...
Returns number

Static distanceSquared

distanceSquared(vectorA: IVectorData, vectorB?: IVectorData): number

- Defined in classes/Vector.ts:198
Parameters
- vectorA: IVectorData
- vectorB: IVectorData = ...
Returns number

Static divide

divide(vectorA: IVectorData, vectorB: IVectorData): Vector

- Defined in classes/Vector.ts:107
Parameters
- vectorA: IVectorData
- vectorB: IVectorData
Returns Vector

Static dotProduct

dotProduct(vectorA: IVectorData, vectorB: IVectorData): number

- Defined in classes/Vector.ts:152
Parameters
- vectorA: IVectorData
- vectorB: IVectorData
Returns number

Static fromArray

fromArray(values: number[]): Vector
fromArray(...values: number[]): Vector

- Defined in classes/Vector.ts:56
Parameters
- values: number[]
Returns Vector
- Defined in classes/Vector.ts:57
Parameters
- Rest ...values: number[]
Returns Vector

Static fromObject

fromObject<T>(vector: IVectorData): Vector
fromObject<T>(vector: T, axisMapping: keyof T[]): Vector

- Defined in classes/Vector.ts:39
Type parameters
- T
Parameters
- vector: IVectorData
Returns Vector
- Defined in classes/Vector.ts:40
Type parameters
- T
Parameters
- vector: T
- axisMapping: keyof T[]
Returns Vector

Static fromPolar

fromPolar(rotation: number, distance?: number): Vector

- Defined in classes/Vector.ts:66
Parameters
- rotation: number
- distance: number = 1
Returns Vector

Static isEqual

isEqual(vectorA: IVectorData, vectorB: IVectorData): boolean

- Defined in classes/Vector.ts:168
Parameters
- vectorA: IVectorData
- vectorB: IVectorData
Returns boolean

Static isZero

isZero(vector: IVectorData): boolean

- Defined in classes/Vector.ts:190
Parameters
- vector: IVectorData
Returns boolean

Static map

map(vector: IVectorData, modifier: (value: number, axis: keyof IVectorData) => number): Vector

- Defined in classes/Vector.ts:218
Parameters
- vector: IVectorData
- modifier: (value: number, axis: keyof IVectorData) => number
  - - (value: number, axis: keyof IVectorData): number
    - Parameters
      - value: number
      - axis: keyof IVectorData
      Returns number
Returns Vector

Static mapEachPlane

mapEachPlane(vector: IVectorData, callback: (ortogonalAxis: IAxis, vectorBD: Vector) => IVectorData): Vector

- Defined in classes/Vector.ts:124
Parameters
- vector: IVectorData
- callback: (ortogonalAxis: IAxis, vectorBD: Vector) => IVectorData
  - - (ortogonalAxis: IAxis, vectorBD: Vector): IVectorData
    - Parameters
      - ortogonalAxis: IAxis
      - vectorBD: Vector
      Returns IVectorData
Returns Vector

Static mapPlane

mapPlane(vector: IVectorData, ortogonalAxis: IAxis, callback: (vectorBD: Vector) => IVectorData): Vector

- Defined in classes/Vector.ts:134
Parameters
- vector: IVectorData
- ortogonalAxis: IAxis
- callback: (vectorBD: Vector) => IVectorData
  - - (vectorBD: Vector): IVectorData
    - Parameters
      - vectorBD: Vector
      Returns IVectorData
Returns Vector

Static multiply

multiply(...vectors: IVectorData[]): Vector

- Defined in classes/Vector.ts:99
Parameters
- Rest ...vectors: IVectorData[]
Returns Vector

Static rearrangeAxes

rearrangeAxes(vector: IVectorData, modifier: (values: number[]) => number[]): Vector

- Defined in classes/Vector.ts:231
Parameters
- vector: IVectorData
- modifier: (values: number[]) => number[]
  - - (values: number[]): number[]
    - Parameters
      - values: number[]
      Returns number[]
Returns Vector

Static rotate

rotate(vector: IVectorData, rotate: IVectorData): Vector

- Defined in classes/Vector.ts:115
Parameters
- vector: IVectorData
- rotate: IVectorData
Returns Vector

Static rotation

rotation(vectorA: IVectorData, vectorB?: IVectorData): number

- Defined in classes/Vector.ts:206
Parameters
- vectorA: IVectorData
- vectorB: IVectorData = ...
Returns number

Static scale

scale(vector: IVectorData, scale: number): Vector

- Defined in classes/Vector.ts:111
Parameters
- vector: IVectorData
- scale: number
Returns Vector

Static square

square(scale?: number): Vector

- Defined in classes/Vector.ts:28
Parameters
- scale: number = 1
Returns Vector

Static stripInfatesimals

stripInfatesimals(vector: IVectorData): Vector

- Defined in classes/Vector.ts:178
Parameters
- vector: IVectorData
Returns Vector

Static subtract

subtract(vectorA: IVectorData, vectorB: IVectorData): Vector

- Defined in classes/Vector.ts:95
Parameters
- vectorA: IVectorData
- vectorB: IVectorData
Returns Vector

Static to2D

to2D(vector: IVectorData): Vector

- Defined in classes/Vector.ts:261
Parameters
- vector: IVectorData
Returns Vector

Static toArray

toArray(vector: IVectorData): number[]

- Defined in classes/Vector.ts:287
Parameters
- vector: IVectorData
Returns number[]

Static toArray2D

toArray2D(vector: IVectorData): [number, number]

- Defined in classes/Vector.ts:291
Parameters
- vector: IVectorData
Returns [number, number]

Static toArray3D

toArray3D(vector: IVectorData): [number, number, number]

- Defined in classes/Vector.ts:295
Parameters
- vector: IVectorData
Returns [number, number, number]

Static toJSON

toJSON(vector: IVectorData): IVectorData

- Defined in classes/Vector.ts:265
Parameters
- vector: IVectorData
Returns IVectorData

Static toObject

toObject<T>(vector: IVectorData, axisMapping?: keyof T[]): T

- Defined in classes/Vector.ts:269
Type parameters
- T = IVectorData
Parameters
- vector: IVectorData
- Optional axisMapping: keyof T[]
Returns T

Static toObject2D

toObject2D(vector: IVectorData): IVectorData

- Defined in classes/Vector.ts:279
Parameters
- vector: IVectorData
Returns IVectorData

Static toObject3D

toObject3D(vector: IVectorData): IVectorData

- Defined in classes/Vector.ts:283
Parameters
- vector: IVectorData
Returns IVectorData

Static toString

toString(vector: IVectorData): string

- Defined in classes/Vector.ts:299
Parameters
- vector: IVectorData
Returns string

Static toString2D

toString2D(vector: IVectorData): string

- Defined in classes/Vector.ts:303
Parameters
- vector: IVectorData
Returns string

Static toString3D

toString3D(vector: IVectorData): string

- Defined in classes/Vector.ts:307
Parameters
- vector: IVectorData
Returns string

Static zero

zero(): Vector

- Defined in classes/Vector.ts:20
Returns Vector