Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArrayVector

A vector representation that stores the axes in an Array

const v = new Vec2D.ArrayVector(2, 5)

Hierarchy

Index

Constructors

constructor

Properties

Protected axes

axes: number[]

Protected ctor

Accessors

x

  • get x(): number
  • set x(x: number): void
  • Returns number

  • Parameters

    • x: number

    Returns void

y

  • get y(): number
  • set y(y: number): void
  • Returns number

  • Parameters

    • y: number

    Returns void

Methods

abs

  • abs(): this
  • Set the vector axes values to absolute values

    Returns this

add

clone

cross

  • Returns the cross product of this vector by another.

    Parameters

    Returns number

distance

divS

  • divS(n: number): this
  • Divive this vector by the provided number

    Parameters

    • n: number

    Returns this

divV

divideByScalar

  • divideByScalar(n: number): this
  • Divive this vector by the provided number

    Parameters

    • n: number

    Returns this

divideByVector

dot

  • Returns the dot product of this vector by another

    Parameters

    Returns number

equals

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

multiplyByScalar

  • multiplyByScalar(n: number): this
  • Multiply this vector by the provided number

    Parameters

    • n: number

    Returns this

multiplyByVector

normalise

  • normalise(): 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

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