@openglobus/og 0.11.1 → 0.11.6

package/types/math/Vec3.d.ts

@@ -4,9 +4,9 @@
  * @param {number} [x] - First cvalue.
  * @param {number} [y] - Second value.
  * @param {number} [z] - Third value.
- * @returns {og.Vec3} -
+ * @returns {Vec3} -
  */
-export function vec3(x?: number, y?: number, z?: number): any;
+export function vec3(x?: number, y?: number, z?: number): Vec3;
 /**
  * Class represents a 3d vector.
  * @class
@@ -41,116 +41,116 @@ export class Vec3 {
      * @param {number} value - Double type value.
      * @param {Vec3} high - Out vector high values.
      * @param {Vec3} low - Out vector low values.
-     * @returns {Array.<number,number>} Encoded array.
+     * @returns {Array.<number>} Encoded array. (exactly 2 entries)
      */
-    static doubleToTwoFloats(v: any, high: Vec3, low: Vec3): Array<number, number>;
+    static doubleToTwoFloats(v: any, high: Vec3, low: Vec3): Array<number>;
     /**
      * Separate 63 bit Vec3 to two Vec3 32 bit float values.
      * @function
      * @param {number} value - Double type value.
      * @param {Float32Array} high - Out vector high values.
      * @param {Float32Array} low - Out vector low values.
-     * @returns {Array.<number,number>} Encoded array.
+     * @returns {Array.<number>} Encoded array. (exactly 2 entries)
      */
-    static doubleToTwoFloat32Array(v: any, high: Float32Array, low: Float32Array): Array<number, number>;
+    static doubleToTwoFloat32Array(v: any, high: Float32Array, low: Float32Array): Array<number>;
     /**
      * Creates 3d vector from array.
      * @function
-     * @param {Array.<number,number,number>} arr - Input array
-     * @returns {og.Vec3} -
+     * @param {Array.<number>} arr - Input array (exactly 3 entries)
+     * @returns {Vec3} -
      */
-    static fromVec(arr: Array<number, number, number>): any;
+    static fromVec(arr: Array<number>): Vec3;
     /**
      * Gets angle between two vectors.
      * @static
-     * @param {og.Vec3} a - First vector.
-     * @param {og.Vec3} b - Second vector.
+     * @param {Vec3} a - First vector.
+     * @param {Vec3} b - Second vector.
      * @returns {number} -
      */
-    static angle(a: any, b: any): number;
+    static angle(a: Vec3, b: Vec3): number;
     /**
      * Returns two vectors linear interpolation.
      * @static
-     * @param {og.Vec3} v1 - Start vector.
-     * @param {og.Vec3} v2 - End vector.
+     * @param {Vec3} v1 - Start vector.
+     * @param {Vec3} v2 - End vector.
      * @param {number} l - Interpolate value.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    static lerp(v1: any, v2: any, l: number): any;
+    static lerp(v1: Vec3, v2: Vec3, l: number): Vec3;
     /**
      * Returns summary vector.
      * @static
-     * @param {og.Vec3} a - First vector.
-     * @param {og.Vec3} b - Second vector.
-     * @returns {og.Vec3} - Summary vector.
+     * @param {Vec3} a - First vector.
+     * @param {Vec3} b - Second vector.
+     * @returns {Vec3} - Summary vector.
      */
-    static add(a: any, b: any): any;
+    static add(a: Vec3, b: Vec3): Vec3;
     /**
      * Returns two vectors subtraction.
      * @static
-     * @param {og.Vec3} a - First vector.
-     * @param {og.Vec3} b - Second vector.
-     * @returns {og.Vec3} - Vectors subtraction.
+     * @param {Vec3} a - First vector.
+     * @param {Vec3} b - Second vector.
+     * @returns {Vec3} - Vectors subtraction.
      */
-    static sub(a: any, b: any): any;
+    static sub(a: Vec3, b: Vec3): Vec3;
     /**
      * Returns scaled vector.
      * @static
-     * @param {og.Vec3} a - Input vector.
+     * @param {Vec3} a - Input vector.
      * @param {number} scale - Scale value.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    static scale(a: any, scale: number): any;
+    static scale(a: Vec3, scale: number): Vec3;
     /**
      * Returns two vectors production.
      * @static
-     * @param {og.Vec3} a - First vector.
-     * @param {og.Vec3} b - Second vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} a - First vector.
+     * @param {Vec3} b - Second vector.
+     * @returns {Vec3} -
      */
-    static mul(a: any, b: any): any;
+    static mul(a: Vec3, b: Vec3): Vec3;
     /**
      * Returns true if two vectors are non collinear.
      * @public
-     * @param {og.Vec3} a - First vector.
-     * @param {og.Vec3} b - Second vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} a - First vector.
+     * @param {Vec3} b - Second vector.
+     * @returns {Vec3} -
      */
-    public static noncollinear(a: any, b: any): any;
+    public static noncollinear(a: Vec3, b: Vec3): Vec3;
     /**
      * Get projection of the vector to plane where n - normal to the plane.
      * @static
-     * @param {og.Vec3} b - Vector to project.
-     * @param {og.Vec3} n - Plane normal.
-    * @param {og.Vec3} [def] - Default value for non existed result.
-     * @returns {og.Vec3} -
+     * @param {Vec3} b - Vector to project.
+     * @param {Vec3} n - Plane normal.
+     * @param {Vec3} [def] - Default value for non existed result.
+     * @returns {Vec3} -
      */
-    static proj_b_to_plane(b: any, n: any, def?: any): any;
+    static proj_b_to_plane(b: Vec3, n: Vec3, def?: Vec3): Vec3;
     /**
      * Get projection of the first vector to the second.
      * @static
-     * @param {og.Vec3} b - First vector.
-     * @param {og.Vec3} a - Second vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} b - First vector.
+     * @param {Vec3} a - Second vector.
+     * @returns {Vec3} -
      */
-    static proj_b_to_a(b: any, a: any): any;
+    static proj_b_to_a(b: Vec3, a: Vec3): Vec3;
     /**
      * Makes vectors normalized and orthogonal to each other.
      * Normalizes normal. Normalizes tangent and makes sure it is orthogonal to normal (that is, angle between them is 90 degrees).
      * @static
-     * @param {og.Vec3} normal - Normal vector.
-     * @param {og.Vec3} tangent - Tangent vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} normal - Normal vector.
+     * @param {Vec3} tangent - Tangent vector.
+     * @returns {Vec3} -
      */
-    static orthoNormalize(normal: any, tangent: any): any;
+    static orthoNormalize(normal: Vec3, tangent: Vec3): Vec3;
     /**
      * Returns vector components division product one to another.
      * @static
-     * @param {og.Vec3} a - First vector.
-     * @param {og.Vec3} b - Second vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} a - First vector.
+     * @param {Vec3} b - Second vector.
+     * @returns {Vec3} -
      */
-    static div(a: any, b: any): any;
+    static div(a: Vec3, b: Vec3): Vec3;
     static get LERP_DELTA(): number;
     constructor(x: any, y: any, z: any);
     /**
@@ -171,15 +171,15 @@ export class Vec3 {
     /**
      * Converts to 4d vector, Fourth value is 1.0.
      * @public
-     * @returns {og.Vec4} -
+     * @returns {Vec4} -
      */
-    public toVec4(): any;
+    public toVec4(): Vec4;
     /**
      * Returns clone vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public clone(): any;
+    public clone(): Vec3;
     /**
      * Converts vector to text string.
      * @public
@@ -195,23 +195,23 @@ export class Vec3 {
     /**
      * Get projection of the first vector to the second.
      * @static
-     * @param {og.Vec3} a - Project vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} a - Project vector.
+     * @returns {Vec3} -
      */
-    projToVec(a: any): any;
+    projToVec(a: Vec3): Vec3;
     /**
      * Compares with vector. Returns true if it equals another.
      * @public
-     * @param {og.Vec3} p - Vector to compare.
+     * @param {Vec3} p - Vector to compare.
      * @returns {boolean} -
      */
-    public equal(p: any): boolean;
+    public equal(p: Vec3): boolean;
     /**
      * Copy input vector's values.
-     * @param {og.Vec3} point3 - Vector to copy.
-     * @returns {og.Vec3} -
+     * @param {Vec3} point3 - Vector to copy.
+     * @returns {Vec3} -
      */
-    copy(point3: any): any;
+    copy(point3: Vec3): Vec3;
     /**
      * Gets vector's length.
      * @public
@@ -227,226 +227,226 @@ export class Vec3 {
     /**
      * Converts vector's values to a quaternion object.
      * @public
-     * @returns {og.Quat} -
+     * @returns {Quat} -
      */
-    public getQuat(): any;
+    public getQuat(): Quat;
     /**
      * Adds vector to the current.
      * @public
-     * @param {og.Vec3} point3 - Point to add.
-     * @returns {og.Vec3} -
+     * @param {Vec3} point3 - Point to add.
+     * @returns {Vec3} -
      */
-    public addA(point3: any): any;
+    public addA(point3: Vec3): Vec3;
     /**
      * Gets two vectors summarization.
      * @public
-     * @param {og.Vec3} point3 - Vector to add.
-     * @returns {og.Vec3} Returns a sum vector.
+     * @param {Vec3} point3 - Vector to add.
+     * @returns {Vec3} Returns a sum vector.
      */
-    public add(point3: any): any;
+    public add(point3: Vec3): Vec3;
     /**
      * Subtract vector from the current.
      * @public
-     * @param {og.Vec3} point3 - Subtract vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} point3 - Subtract vector.
+     * @returns {Vec3} -
      */
-    public subA(point3: any): any;
+    public subA(point3: Vec3): Vec3;
     /**
      * Gets vector subtraction.
      * @public
-     * @param {og.Vec3} point3 - Subtract vector.
-     * @return {og.Vec3} Returns new instance of a subtraction
+     * @param {Vec3} point3 - Subtract vector.
+     * @return {Vec3} Returns new instance of a subtraction
      */
-    public sub(point3: any): any;
+    public sub(point3: Vec3): Vec3;
     /**
      * Scale current vector.
      * @public
      * @param {number} scale - Scale value.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public scale(scale: number): any;
+    public scale(scale: number): Vec3;
     /**
      * Scale current vector to another instance.
      * @public
      * @param {number} scale - Scale value.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public scaleTo(scale: number): any;
+    public scaleTo(scale: number): Vec3;
     /**
      * Multiply current vector object to another and store result in the current instance.
      * @public
-     * @param {og.Vec3} vec - Multiply vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} vec - Multiply vector.
+     * @returns {Vec3} -
      */
-    public mulA(vec: any): any;
+    public mulA(vec: Vec3): Vec3;
     /**
      * Multiply current vector object to another and returns new vector instance.
      * @public
-     * @param {og.Vec3} vec - Multiply vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} vec - Multiply vector.
+     * @returns {Vec3} -
      */
-    public mul(vec: any): any;
+    public mul(vec: Vec3): Vec3;
     /**
      * Divide current vector's components to another. Results stores in the current vector object.
      * @public
-     * @param {og.Vec3} vec - Div vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} vec - Div vector.
+     * @returns {Vec3} -
      */
-    public divA(vec: any): any;
+    public divA(vec: Vec3): Vec3;
     /**
      * Divide current vector's components to another and returns new vector instance.
      * @public
-     * @param {og.Vec3} vec - Div vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} vec - Div vector.
+     * @returns {Vec3} -
      */
-    public div(vec: any): any;
+    public div(vec: Vec3): Vec3;
     /**
      * Gets vectors dot production.
      * @public
-     * @param {og.Vec3} point3 - Another vector.
+     * @param {Vec3} point3 - Another vector.
      * @returns {number} -
      */
-    public dot(point3: any): number;
+    public dot(point3: Vec3): number;
     /**
      * Gets vectors dot production.
      * @public
-     * @param {Array.<number,number,number>} arr - Array vector.
+     * @param {Array.<number>} arr - Array vector. (exactly 3 entries)
      * @returns {number} -
      */
-    public dotArr(arr: Array<number, number, number>): number;
+    public dotArr(arr: Array<number>): number;
     /**
      * Gets vectors cross production.
      * @public
-     * @param {og.Vec3} point3 - Another vector.
-     * @returns {og.Vec3} -
+     * @param {Vec3} point3 - Another vector.
+     * @returns {Vec3} -
      */
-    public cross(point3: any): any;
+    public cross(point3: Vec3): Vec3;
     /**
      * Sets vector to zero.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public clear(): any;
+    public clear(): Vec3;
     /**
      * Returns normalized vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public getNormal(): any;
+    public getNormal(): Vec3;
     /**
      * Returns normalized vector.
      * @deprecated
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public normal(): any;
+    public normal(): Vec3;
     /**
      * Returns normalized negate vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public normalNegate(): any;
+    public normalNegate(): Vec3;
     /**
      * Returns normalized negate scale vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public normalNegateScale(scale: any): any;
+    public normalNegateScale(scale: any): Vec3;
     /**
      * Returns normalized scale vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public normalScale(scale: any): any;
+    public normalScale(scale: any): Vec3;
     /**
      * Normalize current vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public normalize(): any;
+    public normalize(): Vec3;
     /**
      * Converts vector to a number array.
      * @public
-     * @returns {Array.<number,number,number>} -
+     * @returns {Array.<number>} - (exactly 3 entries)
      * @deprecated
      */
-    public toVec(): Array<number, number, number>;
+    public toVec(): Array<number>;
     /**
      * Converts vector to a number array.
      * @public
-     * @returns {Array.<number,number,number>} -
+     * @returns {Array.<number>} - (exactly 3 entries)
      */
-    public toArray(): Array<number, number, number>;
+    public toArray(): Array<number>;
     /**
      * Gets distance to point.
      * @public
-     * @param {og.Vec3} point3 - Distant point.
+     * @param {Vec3} point3 - Distant point.
      * @returns {number} -
      */
-    public distance(point3: any): number;
+    public distance(point3: Vec3): number;
     /**
      * Sets vector's values.
      * @public
      * @param {number} x - Value X.
      * @param {number} y - Value Y.
      * @param {number} z - Value Z.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public set(x: number, y: number, z: number): any;
+    public set(x: number, y: number, z: number): Vec3;
     /**
      * Negate current vector.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public negate(): any;
+    public negate(): Vec3;
     /**
      * Negate current vector to another instance.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public negateTo(): any;
+    public negateTo(): Vec3;
     /**
      * Gets projected point coordinates of the current vector on the ray.
      * @public
-     * @param {og.Vec3} pos - Ray position.
-     * @param {og.Vec3} direction - Ray direction.
-     * @returns {og.Vec3} -
+     * @param {Vec3} pos - Ray position.
+     * @param {Vec3} direction - Ray direction.
+     * @returns {Vec3} -
      */
-    public projToRay(pos: any, direction: any): any;
+    public projToRay(pos: Vec3, direction: Vec3): Vec3;
     /**
      * Gets angle between two vectors.
      * @public
-     * @param {og.Vec3} a - Another vector.
+     * @param {Vec3} a - Another vector.
      * @returns {number} -
      */
-    public angle(a: any): number;
+    public angle(a: Vec3): number;
     /**
      * Returns two vectors linear interpolation.
      * @public
-     * @param {og.Vec3} v2 - End vector.
+     * @param {Vec3} v2 - End vector.
      * @param {number} l - Interpolate value.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public lerp(v2: any, l: number): any;
+    public lerp(v2: Vec3, l: number): Vec3;
     /**
      * Returns vector interpolation by v(t) = v1 * t + v2 * (1 - t)
      * @public
-     * @param {og.Vec3} v2 - End vector.
+     * @param {Vec3} v2 - End vector.
      * @param {number} t - Interpolate value.
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public smerp(v2: any, t: number): any;
+    public smerp(v2: Vec3, t: number): Vec3;
     /**
      * 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
      * by the angle and its magnitude is interpolated between the magnitudes of from and to.
      * @public
-     * @param {og.Vec3} v2 -
+     * @param {Vec3} v2 -
      * @param {number} t - The parameter t is clamped to the range [0, 1].
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
-    public slerp(v2: any, t: number): any;
+    public slerp(v2: Vec3, t: number): Vec3;
     /**
      * Gets the shortest arc quaternion to rotate this vector to the destination vector.
      * @param {Vec3} dest -
@@ -456,4 +456,5 @@ export class Vec3 {
      */
     getRotationTo(dest: Vec3, fallbackAxis: Vec3): Quat;
 }
+import { Vec4 } from "./Vec4.js";
 import { Quat } from "./Quat.js";