tapspace/lib/geometry/Point/fromAverage.js

A zoomable user interface lib for web apps

const point3 = require('affineplane').point3

module.exports = (Point) => {
  // Use factory pattern to control circular dependency.
  return (basis, points) => {
    // @Point.fromAverage(basis, points)
    // @Point.fromMean
    //
    // Mean of an array of points.
    //
    // Parameters:
    //   basis
    //     a Component
    //   points
    //     an array of Point instances
    //
    // Return
    //   a Point on the given basis
    //
    // Example
    // ```
    // const mean = tapspace.Point.fromAverage(basis, points)
    // ```
    //

    // Normalize to point3
    const normPoints = points.map(p => {
      if (p.transitRaw) {
        return p.transitRaw(basis)
      }
      return p
    })

    const meanPoint = point3.mean(normPoints)
    return new Point(basis, meanPoint)
  }
}