@polarfront-lab/ionian 1.7.0 → 2.0.0

package/dist/ionian.js

@@ -206,6 +206,11 @@ const _face = new Triangle();
 const _color = new Vector3();
 const _uva = new Vector2(), _uvb = new Vector2(), _uvc = new Vector2();
 class MeshSurfaceSampler {
+  /**
+   * Constructs a mesh surface sampler.
+   *
+   * @param {Mesh} mesh - Surface mesh from which to sample.
+   */
   constructor(mesh) {
     this.geometry = mesh.geometry;
     this.randomFunction = Math.random;
@@ -217,10 +222,27 @@ class MeshSurfaceSampler {
     this.weightAttribute = null;
     this.distribution = null;
   }
+  /**
+   * Specifies a vertex attribute to be used as a weight when sampling from the surface.
+   * Faces with higher weights are more likely to be sampled, and those with weights of
+   * zero will not be sampled at all. For vector attributes, only .x is used in sampling.
+   *
+   * If no weight attribute is selected, sampling is randomly distributed by area.
+   *
+   * @param {string} name - The attribute name.
+   * @return {MeshSurfaceSampler} A reference to this sampler.
+   */
   setWeightAttribute(name) {
     this.weightAttribute = name ? this.geometry.getAttribute(name) : null;
     return this;
   }
+  /**
+   * Processes the input geometry and prepares to return samples. Any configuration of the
+   * geometry or sampler must occur before this method is called. Time complexity is O(n)
+   * for a surface with n faces.
+   *
+   * @return {MeshSurfaceSampler} A reference to this sampler.
+   */
   build() {
     const indexAttribute = this.indexAttribute;
     const positionAttribute = this.positionAttribute;
@@ -255,19 +277,37 @@ class MeshSurfaceSampler {
     this.distribution = distribution;
     return this;
   }
+  /**
+   * Allows to set a custom random number generator. Default is `Math.random()`.
+   *
+   * @param {Function} randomFunction - A random number generator.
+   * @return {MeshSurfaceSampler} A reference to this sampler.
+   */
   setRandomGenerator(randomFunction) {
     this.randomFunction = randomFunction;
     return this;
   }
+  /**
+   * Selects a random point on the surface of the input geometry, returning the
+   * position and optionally the normal vector, color and UV Coordinate at that point.
+   * Time complexity is O(log n) for a surface with n faces.
+   *
+   * @param {Vector3} targetPosition - The target object holding the sampled position.
+   * @param {Vector3} targetNormal - The target object holding the sampled normal.
+   * @param {Color} targetColor - The target object holding the sampled color.
+   * @param {Vector2} targetUV -  The target object holding the sampled uv coordinates.
+   * @return {MeshSurfaceSampler} A reference to this sampler.
+   */
   sample(targetPosition, targetNormal, targetColor, targetUV) {
-    const faceIndex = this.sampleFaceIndex();
-    return this.sampleFace(faceIndex, targetPosition, targetNormal, targetColor, targetUV);
+    const faceIndex = this._sampleFaceIndex();
+    return this._sampleFace(faceIndex, targetPosition, targetNormal, targetColor, targetUV);
   }
-  sampleFaceIndex() {
+  // private
+  _sampleFaceIndex() {
     const cumulativeTotal = this.distribution[this.distribution.length - 1];
-    return this.binarySearch(this.randomFunction() * cumulativeTotal);
+    return this._binarySearch(this.randomFunction() * cumulativeTotal);
   }
-  binarySearch(x) {
+  _binarySearch(x) {
     const dist = this.distribution;
     let start = 0;
     let end = dist.length - 1;
@@ -285,7 +325,7 @@ class MeshSurfaceSampler {
     }
     return index;
   }
-  sampleFace(faceIndex, targetPosition, targetNormal, targetColor, targetUV) {
+  _sampleFace(faceIndex, targetPosition, targetNormal, targetColor, targetUV) {
     let u = this.randomFunction();
     let v = this.randomFunction();
     if (u + v > 1) {
@@ -1012,15 +1052,34 @@ class FullscreenTriangleGeometry extends BufferGeometry {
 }
 const _geometry = new FullscreenTriangleGeometry();
 class FullScreenQuad {
+  /**
+   * Constructs a new full screen quad.
+   *
+   * @param {?Material} material - The material to render te full screen quad with.
+   */
   constructor(material) {
     this._mesh = new Mesh(_geometry, material);
   }
+  /**
+   * Frees the GPU-related resources allocated by this instance. Call this
+   * method whenever the instance is no longer used in your app.
+   */
   dispose() {
     this._mesh.geometry.dispose();
   }
+  /**
+   * Renders the full screen quad.
+   *
+   * @param {WebGLRenderer} renderer - The renderer.
+   */
   render(renderer) {
     renderer.render(this._mesh, _camera);
   }
+  /**
+   * The quad's material.
+   *
+   * @type {?Material}
+   */
   get material() {
     return this._mesh.material;
   }
@@ -1030,9 +1089,11 @@ class FullScreenQuad {
 }
 class GPUComputationRenderer {
   /**
-   * @param {number} sizeX Computation problem size is always 2d: sizeX * sizeY elements.
-  	 * @param {number} sizeY Computation problem size is always 2d: sizeX * sizeY elements.
-  	 * @param {WebGLRenderer} renderer The renderer
+   * Constructs a new GPU computation renderer.
+   *
+   * @param {number} sizeX - Computation problem size is always 2d: sizeX * sizeY elements.
+  	 * @param {number} sizeY - Computation problem size is always 2d: sizeX * sizeY elements.
+  	 * @param {WebGLRenderer} renderer - The renderer.
    */
   constructor(sizeX, sizeY, renderer) {
     this.variables = [];