Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractVector

The class that all other vector representations are derived from.

Contains the core implementation for all methods that will be exposed by vector instances.

Example of creating a custom implementation:

import { AbstractVector } from "./AbstractVector"

export class MyCustomVector extends AbstractVector {
 constructor (x: number, y: number) {
   super(CustomVectorType)
 }
}

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected ctor

ctor: VectorConstructable<AbstractVector>

Accessors

x

  • get x(): number
  • set x(x: number): any

  • Returns number

  • Parameters

    • x: number

    Returns any

y

  • get y(): number
  • set y(y: number): any

  • Returns number

  • Parameters

    • y: number

    Returns any

Methods

abs

  • abs(): this

  • Set the vector axes values to absolute values

    Returns this

add

  • Add the provided vector to this one

    Parameters

    Returns this

clone

  • Returns a copy of this vector

    Returns AbstractVector

cross

  • Returns the cross product of this vector by another.

    Parameters

    Returns number

distance

  • Returns the distance between this vector and another

    Parameters

    Returns number

divS

  • divS(n: number): this

  • Divive this vector by the provided number

    Parameters

    • n: number

    Returns this

divV

  • Divide this vector by the provided vector

    Parameters

    Returns this

divideByScalar

  • divideByScalar(n: number): this

  • Divive this vector by the provided number

    Parameters

    • n: number

    Returns this

divideByVector

  • Divide this vector by the provided vector

    Parameters

    Returns this

dot

  • Returns the dot product of this vector by another

    Parameters

    Returns number

equals

  • Check if the provided vector equal to this one

    Parameters

    Returns boolean

getX

  • getX(): number

  • Getter for x the axis value

    Returns number

getY

  • getY(): number

  • Getter for y axis value

    Returns number

length

  • length(): number

  • Returns the magnitude (length) of this vector

    Returns number

lengthSq

  • lengthSq(): number

  • Returns the squred length of this vector

    Returns number

magnitude

  • magnitude(): number

  • Returns the magnitude (length) of this vector

    Returns number

mulS

  • mulS(n: number): this

  • Multiply this vector by the provided number

    Parameters

    • n: number

    Returns this

mulV

  • Multiply this vector by the provided vector

    Parameters

    Returns this

multiplyByScalar

  • multiplyByScalar(n: number): this

  • Multiply this vector by the provided number

    Parameters

    • n: number

    Returns this

multiplyByVector

  • Multiply this vector by the provided vector

    Parameters

    Returns this

normalise

  • normalise(): this

  • Normalise this vector

    Returns this

normalize

  • normalize(): this

  • For American spelling. Same as unit/normalise function

    Returns this

reverse

  • reverse(): this

  • Reverses this vector i.e multiplies it by -1

    Returns this

rotate

  • rotate(rads: number): this

  • Rotates the vetor by provided radians

    Parameters

    • rads: number

    Returns this

round

  • round(n?: number): this

  • Rounds this vector to n decimal places

    Parameters

    • Default value n: number = 2

    Returns this

setAxes

  • setAxes(x: number, y: number): this

  • Set both x and y axis value

    Parameters

    • x: number

      New x val

    • y: number

      New y val

    Returns this

setX

  • setX(x: number): this

  • Setter for x axis value

    Parameters

    • x: number

    Returns this

setY

  • setY(y: number): this

  • Setter for y axis.

    Parameters

    • y: number

    Returns this

subtract

  • Subtract the provided vector from this one

    Parameters

    Returns this

toArray

  • toArray(): number[]

  • Return an Array containing the vector axes, e.g [0, 4]

    Returns number[]

toObject

  • toObject(): object

  • Return an Object containing the vector axes, e.g { x: 0, y: 4 }

    Returns object

    • x: number
    • y: number

toString

  • toString(round?: boolean): string

  • Return the vector as a formatted string, e.g "(0, 4)"

    Parameters

    • Default value round: boolean = false

    Returns string

unit

  • unit(): this

  • The same as normalise and normalize

    Returns this

zero

  • zero(): this

  • Zeroes the vector i.e sets all axes to 0

    Returns this

Generated using TypeDoc