tapspace/lib/geometry/Vector/index.js

A zoomable user interface lib for web apps

const Vector = function (basis, vec) {
  // @Vector(basis, vec)
  //
  // Creates a vector that can be transited between bases.
  // The vector has length and direction but no position.
  //
  // Parameters
  //   basis
  //     a BasisComponent
  //   vec
  //     a vec3 object {x,y,z}
  //
  this.basis = basis
  this.vec = vec

  // Support 2d
  if (!vec.z) {
    this.vec.z = 0
  }
}

module.exports = Vector
const proto = Vector.prototype
proto.isVector = true

// Class functions
Vector.fromAverage = require('./fromAverage')(Vector)
Vector.fromPolar = require('./fromPolar')(Vector)
Vector.fromSpherical = require('./fromSpherical')(Vector)

// Methods
proto.add = require('./add')
proto.almostEqual = require('./almostEqual')
proto.changeBasis = require('./changeBasis')
proto.copy = require('./copy')
proto.cross = require('./cross')
proto.difference = require('./difference')
proto.getRaw = require('./getRaw')
proto.multiply = require('./scaleBy')
proto.negate = require('./negate')
proto.norm = proto.getDistance
proto.normalize = require('./normalize')
proto.rotateBy = require('./rotateBy')
proto.scaleBy = proto.multiply
proto.scaleTo = proto.normalize
proto.subtract = proto.difference
proto.transformBy = require('./transformBy')
proto.transit = proto.changeBasis
proto.transitRaw = require('./transitRaw')

// Methods with circular dependencies.
const factorDot = require('./dot')
const factorGetDirection = require('./getDirection')
const factorGetDistance = require('./getDistance')
Vector.patchCircular = (Direction, Distance) => {
  proto.getDirection = factorGetDirection(Direction)
  proto.getDistance = factorGetDistance(Distance)
  proto.dot = factorDot(Distance)
  delete Vector.patchCircular // once
}