tapspace/lib/geometry/Box/index.js

A zoomable user interface lib for web apps

const box3 = require('affineplane').box3

const Box = function (basis, box) {
  // @Box(basis, box)
  //
  // A rectangular box in space. Basically it is three-dimensional cuboid
  // that has two faces parallel to xy-plane. A box has basis in space and
  // a position, orientation, and size in that basis. In a way the box has
  // two bases, the basis in space and its placement basis respective of
  // the basis in space. This is necessary in order to represent the box
  // in any basis, not only those that have same orientation.
  //
  // Parameters
  //   basis
  //     a BasisComponent
  //   box
  //     a box3 object `{ a, b, x, y, z, w, h, d }`.
  //

  // Debug
  if (!box3.validate(box)) {
    throw new Error('Invalid box argument')
  }

  this.basis = basis
  this.box = box
}

const proto = Box.prototype
module.exports = Box
proto.isBox = true

// Class functions
Box.fromPoints = require('./fromPoints')(Box)
Box.fromBoxes = require('./fromBoxes')(Box)

// Methods
proto.at = require('./at')
proto.atCenter = require('./atCenter')
proto.atMid = proto.atCenter
proto.atNorm = require('./atNorm')
proto.changeBasis = require('./changeBasis')
proto.detectCollision = require('./detectCollision')
proto.getArea = require('./getArea')
proto.getBoundingBox = require('./getBoundingBox')
proto.getDepth = require('./getDepth')
proto.getDiagonal = require('./getDiagonal')
proto.getHeight = require('./getHeight')
proto.getPoint = proto.at
proto.getRaw = require('./getRaw')
proto.getSize = require('./getSize')
proto.getVolume = require('./getVolume')
proto.getWidth = require('./getWidth')
proto.normAt = require('./normAt')
proto.projectTo = require('./projectTo')
proto.resizeTo = require('./resizeTo')
proto.rotateBy = require('./rotateBy')
proto.scaleBy = require('./scaleBy')
proto.transitRaw = require('./transitRaw')
proto.translateBy = require('./translateBy')

// Methods with circular dependencies.
const getBoundingSphere = require('./getBoundingSphere')
Box.patchCircular = (Sphere) => {
  proto.getBoundingSphere = getBoundingSphere(Sphere)
  delete Box.patchCircular
}