@openglobus/og 0.11.2 → 0.11.7

package/src/og/math/Ray.js

@@ -2,51 +2,58 @@
  * @module og/math/Ray
  */
 
-'use strict';
+"use strict";
 
-import * as math from '../math.js';
-import { Vec3 } from './Vec3.js';
+import * as math from "../math.js";
+import { Vec3 } from "./Vec3.js";
 
 /**
  * Represents a ray that extends infinitely from the provided origin in the provided direction.
  * @class
- * @param {og.Vec3} origin - The origin of the ray.
- * @param {og.Vec3} direction - The direction of the ray.
+ * @param {Vec3} origin - The origin of the ray.
+ * @param {Vec3} direction - The direction of the ray.
  */
 export class Ray {
     constructor(origin, direction) {
-
         /**
          * The origin of the ray.
          * @public
-         * @type {og.Vec3}
+         * @type {Vec3}
          */
         this.origin = origin || new Vec3();
 
         /**
          * The direction of the ray.
          * @public
-         * @type {og.Vec3}
+         * @type {Vec3}
          */
         this.direction = direction || new Vec3();
     }
 
     /** @const */
-    static get OUTSIDE() { return 0; }
+    static get OUTSIDE() {
+        return 0;
+    }
 
     /** @const */
-    static get INSIDE() { return 1; }
+    static get INSIDE() {
+        return 1;
+    }
     /** @const */
-    static get INPLANE() { return 2; }
+    static get INPLANE() {
+        return 2;
+    }
     /** @const */
-    static get AWAY() { return 3; }
+    static get AWAY() {
+        return 3;
+    }
 
     /**
      * Sets a ray parameters.
      * @public
-     * @param {og.Vec3} origin - The origin of the ray.
-     * @param {og.Vec3} direction - The direction of the ray.
-     * @returns {og.Ray}
+     * @param {Vec3} origin - The origin of the ray.
+     * @param {Vec3} direction - The direction of the ray.
+     * @returns {Ray}
      */
     set(origin, direction) {
         this.origin = origin;
@@ -58,7 +65,7 @@ export class Ray {
      * Computes the point along the ray on the distance.
      * @public
      * @param {number} distance - Point distance.
-     * @returns {og.Vec3}
+     * @returns {Vec3}
      */
     getPoint(distance) {
         return Vec3.add(this.origin, this.direction.scaleTo(distance));
@@ -67,11 +74,11 @@ export class Ray {
     /**
      * Returns ray hit a triange result.
      * @public
-     * @param {og.Vec3} v0 - First triangle corner coordinate.
-     * @param {og.Vec3} v1 - Second triangle corner coordinate.
-     * @param {og.Vec3} v2 - Third triangle corner coordinate.
-     * @param {og.Vec3} res - Hit point object pointer that stores hit result.
-     * @returns {number} - Hit code, could 0 - og.Ray.OUTSIDE, 1 - og.Ray.INSIDE, 
+     * @param {Vec3} v0 - First triangle corner coordinate.
+     * @param {Vec3} v1 - Second triangle corner coordinate.
+     * @param {Vec3} v2 - Third triangle corner coordinate.
+     * @param {Vec3} res - Hit point object pointer that stores hit result.
+     * @returns {number} - Hit code, could 0 - og.Ray.OUTSIDE, 1 - og.Ray.INSIDE,
      *      2 - og.Ray.INPLANE and 3 - og.Ray.AWAY(ray goes away from triangle).
      */
     hitTriangle(v0, v1, v2, res, normal) {
@@ -120,7 +127,7 @@ export class Ray {
         }
 
         var t = (uv * wu - uu * wv) / D;
-        if (t < 0.0 || (s + t) > 1.0) {
+        if (t < 0.0 || s + t > 1.0) {
             return Ray.OUTSIDE;
         }
 
@@ -130,10 +137,10 @@ export class Ray {
     /**
      * Gets a ray hit a plane result. If the ray cross the plane returns 1 - og.Ray.INSIDE otherwise returns 0 - og.Ray.OUTSIDE.
      * @public
-     * @param {og.Vec3} v0 - First plane point.
-     * @param {og.Vec3} v1 - Second plane point.
-     * @param {og.Vec3} v2 - Third plane point.
-     * @param {og.Vec3} res - Hit point object pointer that stores hit result.
+     * @param {Vec3} v0 - First plane point.
+     * @param {Vec3} v1 - Second plane point.
+     * @param {Vec3} v2 - Third plane point.
+     * @param {Vec3} res - Hit point object pointer that stores hit result.
      * @returns {number}
      */
     hitPlane(v0, v1, v2, res) {
@@ -171,8 +178,8 @@ export class Ray {
     /**
      * Returns a ray hit sphere coordiante. If there isn't hit returns null.
      * @public
-     * @param {og.bv.Sphere} sphere - Sphere object.
-     * @returns {og.Vec3}
+     * @param {Sphere} sphere - Sphere object.
+     * @returns {Vec3}
      */
     hitSphere(sphere) {
         var r = sphere.radius,
@@ -218,17 +225,15 @@ export class Ray {
         // TODO
         //
     }
-
 }
 
 /**
  * Ray object creator.
  * @function
- * @param {og.Vec3} origin - The origin of the ray.
- * @param {og.Vec3} direction - The direction of the ray.
- * @returns {og.Ray}
+ * @param {Vec3} origin - The origin of the ray.
+ * @param {Vec3} direction - The direction of the ray.
+ * @returns {Ray}
  */
 export function ray(origin, direction) {
     return new Ray(origin, direction);
 }
-

package/src/og/math/Vec2.js

@@ -2,9 +2,9 @@
  * @module og/math/Vec2
  */
 
-'use strict';
+"use strict";
 
-import { Vec3 } from './Vec3.js';
+import { Vec3 } from "./Vec3.js";
 
 /**
  * Class represents a 3d vector.
@@ -13,9 +13,7 @@ import { Vec3 } from './Vec3.js';
  * @param {number} [y] - Second value.
  */
 export class Vec2 {
-
     constructor(x, y) {
-
         /**
          * @public
          * @type {number}
@@ -29,22 +27,32 @@ export class Vec2 {
         this.y = y || 0.0;
     }
     /** @const */
-    static get UP() { return new Vec2(0, 1) }
+    static get UP() {
+        return new Vec2(0, 1);
+    }
     /** @const */
-    static get DOWN() { return new Vec2(0, -1) }
+    static get DOWN() {
+        return new Vec2(0, -1);
+    }
     /** @const */
-    static get RIGHT() { return new Vec2(1, 0) }
+    static get RIGHT() {
+        return new Vec2(1, 0);
+    }
     /** @const */
-    static get LEFT() { return new Vec2(-1, 0) }
+    static get LEFT() {
+        return new Vec2(-1, 0);
+    }
     /** @const */
-    static get ZERO() { return new Vec2() }
+    static get ZERO() {
+        return new Vec2();
+    }
 
     /**
      * Returns summary vector.
      * @static
-     * @param {og.math.Vec2} a - First vector.
-     * @param {og.math.Vec2} b - Second vector.
-     * @returns {og.math.Vec2} - Summary vector.
+     * @param {math.Vec2} a - First vector.
+     * @param {math.Vec2} b - Second vector.
+     * @returns {math.Vec2} - Summary vector.
      */
     static add(a, b) {
         var res = new Vec2(a.x, a.y);
@@ -55,9 +63,9 @@ export class Vec2 {
     /**
      * Returns two vectors subtraction.
      * @static
-     * @param {og.math.Vec2} a - First vector.
-     * @param {og.math.Vec2} b - Second vector.
-     * @returns {og.math.Vec2} - Vectors subtraction.
+     * @param {math.Vec2} a - First vector.
+     * @param {math.Vec2} b - Second vector.
+     * @returns {math.Vec2} - Vectors subtraction.
      */
     static sub(a, b) {
         var res = new Vec2(a.x, a.y);
@@ -68,9 +76,9 @@ export class Vec2 {
     /**
      * Returns scaled vector.
      * @static
-     * @param {og.math.Vec2} a - Input vector.
+     * @param {math.Vec2} a - Input vector.
      * @param {number} scale - Scale value.
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     static scale(a, scale) {
         var res = new Vec2(a.x, a.y);
@@ -81,9 +89,9 @@ export class Vec2 {
     /**
      * Returns two vectors production.
      * @static
-     * @param {og.math.Vec2} a - First vector.
-     * @param {og.math.Vec2} b - Second vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} a - First vector.
+     * @param {math.Vec2} b - Second vector.
+     * @returns {math.Vec2}
      */
     static mul(a, b) {
         var res = new Vec2(a.x, a.y);
@@ -94,9 +102,9 @@ export class Vec2 {
     /**
      * Returns vector components division product one to another.
      * @static
-     * @param {og.math.Vec2} a - First vector.
-     * @param {og.math.Vec2} b - Second vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} a - First vector.
+     * @param {math.Vec2} b - Second vector.
+     * @returns {math.Vec2}
      */
     static div(a, b) {
         var res = new Vec2(a.x, a.y);
@@ -107,9 +115,9 @@ export class Vec2 {
     /**
      * Get projection of the first vector to the second.
      * @static
-     * @param {og.math.Vec2} b - First vector.
-     * @param {og.math.Vec2} a - Second vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} b - First vector.
+     * @param {math.Vec2} a - Second vector.
+     * @returns {math.Vec2}
      */
     static proj_b_to_a(b, a) {
         return a.scaleTo(a.dot(b) / a.dot(a));
@@ -118,8 +126,8 @@ export class Vec2 {
     /**
      * Gets angle between two vectors.
      * @static
-     * @param {og.math.Vec2} a - First vector.
-     * @param {og.math.Vec2} b - Second vector.
+     * @param {math.Vec2} a - First vector.
+     * @param {math.Vec2} b - Second vector.
      * @returns {number}
      */
     static angle(a, b) {
@@ -129,9 +137,9 @@ export class Vec2 {
     /**
      * Makes vectors normalized and orthogonal to each other.
      * @static
-     * @param {og.math.Vec2} normal - Normal vector.
-     * @param {og.math.Vec2} tangent - Tangent vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} normal - Normal vector.
+     * @param {math.Vec2} tangent - Tangent vector.
+     * @returns {math.Vec2}
      */
     static orthoNormalize(normal, tangent) {
         normal = normal.norm();
@@ -142,7 +150,7 @@ export class Vec2 {
     /**
      * Converts to 3d vector, third value is 0.0.
      * @public
-     * @returns {og.Vec3}
+     * @returns {Vec3}
      */
     toVector3() {
         return new Vec3(this.x, this.y, 0);
@@ -151,7 +159,7 @@ export class Vec2 {
     /**
      * Returns clone vector.
      * @public
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     clone() {
         return new Vec2(this.x, this.y);
@@ -160,7 +168,7 @@ export class Vec2 {
     /**
      * Compares with vector. Returns true if it equals another.
      * @public
-     * @param {og.math.Vec2} p - Vector to compare.
+     * @param {math.Vec2} p - Vector to compare.
      * @returns {boolean}
      */
     equal(p) {
@@ -169,8 +177,8 @@ export class Vec2 {
 
     /**
      * Copy input vector's values.
-     * @param {og.math.Vec2} point2 - Vector to copy.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} point2 - Vector to copy.
+     * @returns {math.Vec2}
      */
     copy(point2) {
         this.x = point2.x;
@@ -199,8 +207,8 @@ export class Vec2 {
     /**
      * Adds vector to the current.
      * @public
-     * @param {og.math.Vec2}
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2}
+     * @returns {math.Vec2}
      */
     addA(v) {
         this.x += v.x;
@@ -211,8 +219,8 @@ export class Vec2 {
     /**
      * Summarize two vectors.
      * @public
-     * @param {og.math.Vec2}
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2}
+     * @returns {math.Vec2}
      */
     add(v) {
         return new Vec2(this.x + v.x, this.y + v.y);
@@ -221,8 +229,8 @@ export class Vec2 {
     /**
      * Subtract vector from the current where results saved on the current instance.
      * @public
-     * @param {og.math.Vec2} v - Subtract vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} v - Subtract vector.
+     * @returns {math.Vec2}
      */
     subA(v) {
         this.x -= v.x;
@@ -233,8 +241,8 @@ export class Vec2 {
     /**
      * Subtract vector from the current.
      * @public
-     * @param {og.math.Vec2} v - Subtract vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} v - Subtract vector.
+     * @returns {math.Vec2}
      */
     sub(v) {
         return new Vec2(this.x - v.x, this.y - v.y);
@@ -244,7 +252,7 @@ export class Vec2 {
      * Scale current vector.
      * @public
      * @param {number} scale - Scale value.
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     scale(scale) {
         this.x *= scale;
@@ -256,7 +264,7 @@ export class Vec2 {
      * Scale current vector to another instance.
      * @public
      * @param {number} scale - Scale value.
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     scaleTo(scale) {
         return new Vec2(this.x * scale, this.y * scale);
@@ -265,8 +273,8 @@ export class Vec2 {
     /**
      * Multiply current vector object to another and store result in the current instance.
      * @public
-     * @param {og.math.Vec2} vec - Multiply vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} vec - Multiply vector.
+     * @returns {math.Vec2}
      */
     mulA(vec) {
         this.x *= vec.x;
@@ -277,8 +285,8 @@ export class Vec2 {
     /**
      * Multiply current vector object to another and returns new vector instance.
      * @public
-     * @param {og.math.Vec2} vec - Multiply vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} vec - Multiply vector.
+     * @returns {math.Vec2}
      */
     mul(vec) {
         return new Vec2(this.x * vec.x, this.y * vec.y);
@@ -287,8 +295,8 @@ export class Vec2 {
     /**
      * Divide current vector's components to another. Results stores in the current vector object.
      * @public
-     * @param {og.math.Vec2}
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2}
+     * @returns {math.Vec2}
      */
     divA(vec) {
         this.x /= vec.x;
@@ -299,7 +307,7 @@ export class Vec2 {
     /**
      * Gets vectors dot production.
      * @public
-     * @param {og.math.Vec2} v - Another vector.
+     * @param {math.Vec2} v - Another vector.
      * @returns {number}
      */
     dot(v) {
@@ -319,8 +327,8 @@ export class Vec2 {
     /**
      * Gets vectors cross production.
      * @public
-     * @param {og.math.Vec2} v - Another vector.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} v - Another vector.
+     * @returns {math.Vec2}
      */
     cross(v) {
         return this.x * v.y - this.y * v.x;
@@ -329,7 +337,7 @@ export class Vec2 {
     /**
      * Sets vector to zero.
      * @public
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     clear() {
         this.x = this.y = 0;
@@ -339,7 +347,7 @@ export class Vec2 {
     /**
      * Returns normalized vector.
      * @public
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     normal() {
         var res = new Vec2();
@@ -356,7 +364,7 @@ export class Vec2 {
     /**
      * Normalize current vector.
      * @public
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     normalize() {
         var length = 1.0 / this.length();
@@ -379,7 +387,7 @@ export class Vec2 {
     /**
      * Gets distance to point.
      * @public
-     * @param {og.math.Vec2} p - Distant point.
+     * @param {math.Vec2} p - Distant point.
      * @returns {number}
      */
     distance(p) {
@@ -392,7 +400,7 @@ export class Vec2 {
      * @public
      * @param {number} x - Value X.
      * @param {number} y - Value Y.
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     set(x, y) {
         this.x = x;
@@ -403,7 +411,7 @@ export class Vec2 {
     /**
      * Negate current vector.
      * @public
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     negate() {
         this.x = -this.x;
@@ -414,7 +422,7 @@ export class Vec2 {
     /**
      * Negate current vector to another instance.
      * @public
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     negateTo() {
         return new Vec2(-this.x, -this.y);
@@ -423,9 +431,9 @@ export class Vec2 {
     /**
      * Gets projected point coordinates of the current vector on the ray.
      * @public
-     * @param {og.math.Vec2} pos - Ray position.
-     * @param {og.math.Vec2} direction - Ray direction.
-     * @returns {og.math.Vec2}
+     * @param {math.Vec2} pos - Ray position.
+     * @param {math.Vec2} direction - Ray direction.
+     * @returns {math.Vec2}
      */
     projToRay(pos, direction) {
         var v = Vec2.proj_b_to_a(Vec2.sub(this, pos), direction);
@@ -436,7 +444,7 @@ export class Vec2 {
     /**
      * Gets angle between two vectors.
      * @public
-     * @param {og.math.Vec2} a - Another vector.
+     * @param {math.Vec2} a - Another vector.
      * @returns {number}
      */
     angle(a) {
@@ -446,9 +454,9 @@ export class Vec2 {
     /**
      * Returns two vectors linear interpolation.
      * @public
-     * @param {og.math.Vec2} v2 - End vector.
+     * @param {math.Vec2} v2 - End vector.
      * @param {number} l - Interpolate value.
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     lerp(v1, v2, l) {
         var res = Vec2.clone(this);
@@ -462,17 +470,19 @@ export class Vec2 {
         return res;
     }
 
-    static get LERP_DELTA() { return 1e-6 }
+    static get LERP_DELTA() {
+        return 1e-6;
+    }
 
     /**
      * Spherically interpolates between two vectors.
-     * Interpolates between current and v2 vector by amount t. The difference between this and linear interpolation (aka, "lerp") is that 
-     * the vectors are treated as directions rather than points in space. The direction of the returned vector is interpolated 
+     * Interpolates between current and v2 vector by amount t. The difference between this and linear interpolation (aka, "lerp") is that
+     * the vectors are treated as directions rather than points in space. The direction of the returned vector is interpolated
      * by the angle and its magnitude is interpolated between the magnitudes of from and to.
      * @public
-     * @param {og.math.Vec2} v2 - 
+     * @param {math.Vec2} v2 -
      * @param {number} t - The parameter t is clamped to the range [0, 1].
-     * @returns {og.math.Vec2}
+     * @returns {math.Vec2}
      */
     slerp(v2, t) {
         var res = new Vec2();
@@ -488,7 +498,7 @@ export class Vec2 {
         var omega, sinom, scale0, scale1;
         var cosom = this.dot(v2);
 
-        if ((1.0 - cosom) > Vec2.LERP_DELTA) {
+        if (1.0 - cosom > Vec2.LERP_DELTA) {
             omega = Math.acos(cosom);
             sinom = Math.sin(omega);
             scale0 = Math.sin((1.0 - t) * omega) / sinom;
@@ -507,7 +517,7 @@ export class Vec2 {
  * @function
  * @param {number} [x] - First cvalue.
  * @param {number} [y] - Second value.
- * @returns {og.math.Vec2}
+ * @returns {math.Vec2}
  */
 export function vec2(x, y) {
     return new Vec2(x, y);