@openglobus/og 0.17.2 → 0.18.1

package/lib/js/math/Vec4.d.ts

@@ -0,0 +1,163 @@
+import { Vec3 } from "./Vec3";
+export type NumberArray4 = [number, number, number, number];
+/**
+ * Class represents a 4d vector.
+ * @class
+ * @param {number} [x] - First value.
+ * @param {number} [y] - Second value.
+ * @param {number} [z] - Third value.
+ * @param {number} [w] - Fourth value.
+ */
+export declare class Vec4 {
+    /**
+     * @public
+     * @type {number}
+     */
+    x: number;
+    /**
+     * @public
+     * @type {number}
+     */
+    y: number;
+    /**
+     * @public
+     * @type {number}
+     */
+    z: number;
+    /**
+     * @public
+     * @type {number}
+     */
+    w: number;
+    constructor(x?: number, y?: number, z?: number, w?: number);
+    /**
+     * Identity vector [0,0,0,1].
+     * @const
+     * @type {Vec4}
+     */
+    static get identity(): Vec4;
+    /**
+     * Creates 4d vector from array.
+     * @function
+     * @param {Array.<number>} arr - Array of four values
+     * @returns {Vec4}
+     */
+    static fromVec(arr: NumberArray4): Vec4;
+    /**
+     * Converts to Vec3, without fourth value.
+     * @public
+     * @returns {Vec3}
+     */
+    toVec3(): Vec3;
+    /**
+     * Returns clone vector.
+     * @public
+     * @returns {Vec4}
+     */
+    clone(): Vec4;
+    /**
+     * Compares with vector. Returns true if it equals another.
+     * @public
+     * @param {Vec4} v - Vector to compare.
+     * @returns {boolean}
+     */
+    equal(v: Vec4): boolean;
+    /**
+     * Copy input vector's values.
+     * @param {Vec4} v - Vector to copy.
+     * @returns {Vec4}
+     */
+    copy(v: Vec4): Vec4;
+    /**
+     * Converts vector to a number array.
+     * @public
+     * @returns {Array.<number>} - (exactly 4 entries)
+     */
+    toArray(): NumberArray4;
+    /**
+     * Converts vector to a number array.
+     * @public
+     * @returns {Array.<number>} - (exactly 4 entries)
+     */
+    toArray3(): [number, number, number];
+    /**
+     * Sets vector's values.
+     * @public
+     * @param {number} x - Value X.
+     * @param {number} y - Value Y.
+     * @param {number} z - Value Z.
+     * @param {number} w - Value W.
+     * @returns {Vec4}
+     */
+    set(x: number, y: number, z: number, w: number): Vec4;
+    /**
+     * Adds vector to the current.
+     * @public
+     * @param {Vec4} v - Vector to add.
+     * @returns {Vec4}
+     */
+    addA(v: Vec4): Vec4;
+    /**
+     * Subtract vector from the current.
+     * @public
+     * @param {Vec4} v - Subtract vector.
+     * @returns {Vec4}
+     */
+    subA(v: Vec4): Vec4;
+    /**
+     * Scale current vector.
+     * @public
+     * @param {number} scale - Scale value.
+     * @returns {Vec4}
+     */
+    scale(scale: number): Vec4;
+    /**
+     * Makes vector affinity. Thereby fourth component becomes to 1.0.
+     * @public
+     * @returns {Vec4}
+     */
+    affinity(): Vec4;
+    /**
+     * Scale current vector to another instance.
+     * @public
+     * @param {number} scale - Scale value.
+     * @returns {Vec3}
+     */
+    scaleTo(scale: number): Vec4;
+    /**
+     * Vector's edge function that returns vector where each component is 0.0 if it's smaller than edge and otherwise 1.0.
+     * @public
+     * @returns {Vec4}
+     */
+    getStep(edge: number): Vec4;
+    /**
+     * The vector frac function returns the vector of fractional parts of each value, i.e. x minus floor(x).
+     * @public
+     * @param {Vec4} v - Input vector
+     * @returns {Vec4}
+     */
+    getFrac(v: Vec4): Vec4;
+    /**
+     * Gets vectors dot production.
+     * @public
+     * @param {Vec4} v - Another vector.
+     * @returns {number} - Dot product.
+     */
+    dot(v: Vec4): number;
+    /**
+     * Returns true if vector's values are zero.
+     * @public
+     * @returns {boolean} -
+     */
+    isZero(): boolean;
+}
+/**
+ * Vector 4d object creator.
+ * @function
+ * @param {number} [x] - First value.
+ * @param {number} [y] - Second value.
+ * @param {number} [z] - Third value.
+ * @param {number} [w] - Fourth value.
+ * @returns {Vec4}
+ */
+export declare function vec4(x?: number, y?: number, z?: number, w?: number): Vec4;

package/lib/js/math/Vec4.js

@@ -0,0 +1,211 @@
+import { frac } from "../math";
+import { Vec3 } from "./Vec3";
+/**
+ * Class represents a 4d vector.
+ * @class
+ * @param {number} [x] - First value.
+ * @param {number} [y] - Second value.
+ * @param {number} [z] - Third value.
+ * @param {number} [w] - Fourth value.
+ */
+export class Vec4 {
+    constructor(x = 0.0, y = 0.0, z = 0.0, w = 0.0) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+        this.w = w;
+    }
+    /**
+     * Identity vector [0,0,0,1].
+     * @const
+     * @type {Vec4}
+     */
+    static get identity() {
+        return new Vec4(0, 0, 0, 1);
+    }
+    /**
+     * Creates 4d vector from array.
+     * @function
+     * @param {Array.<number>} arr - Array of four values
+     * @returns {Vec4}
+     */
+    static fromVec(arr) {
+        return new Vec4(arr[0], arr[1], arr[2], arr[3]);
+    }
+    /**
+     * Converts to Vec3, without fourth value.
+     * @public
+     * @returns {Vec3}
+     */
+    toVec3() {
+        return new Vec3(this.x, this.y, this.z);
+    }
+    /**
+     * Returns clone vector.
+     * @public
+     * @returns {Vec4}
+     */
+    clone() {
+        return new Vec4(this.x, this.y, this.z, this.w);
+    }
+    /**
+     * Compares with vector. Returns true if it equals another.
+     * @public
+     * @param {Vec4} v - Vector to compare.
+     * @returns {boolean}
+     */
+    equal(v) {
+        return this.x === v.x && this.y === v.y && this.z === v.z && this.w === v.w;
+    }
+    /**
+     * Copy input vector's values.
+     * @param {Vec4} v - Vector to copy.
+     * @returns {Vec4}
+     */
+    copy(v) {
+        this.x = v.x;
+        this.y = v.y;
+        this.z = v.z;
+        this.w = v.w;
+        return this;
+    }
+    /**
+     * Converts vector to a number array.
+     * @public
+     * @returns {Array.<number>} - (exactly 4 entries)
+     */
+    toArray() {
+        return [this.x, this.y, this.z, this.w];
+    }
+    /**
+     * Converts vector to a number array.
+     * @public
+     * @returns {Array.<number>} - (exactly 4 entries)
+     */
+    toArray3() {
+        return [this.x, this.y, this.z];
+    }
+    /**
+     * Sets vector's values.
+     * @public
+     * @param {number} x - Value X.
+     * @param {number} y - Value Y.
+     * @param {number} z - Value Z.
+     * @param {number} w - Value W.
+     * @returns {Vec4}
+     */
+    set(x, y, z, w) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+        this.w = w;
+        return this;
+    }
+    /**
+     * Adds vector to the current.
+     * @public
+     * @param {Vec4} v - Vector to add.
+     * @returns {Vec4}
+     */
+    addA(v) {
+        this.x += v.x;
+        this.y += v.y;
+        this.z += v.z;
+        this.w += v.w;
+        return this;
+    }
+    /**
+     * Subtract vector from the current.
+     * @public
+     * @param {Vec4} v - Subtract vector.
+     * @returns {Vec4}
+     */
+    subA(v) {
+        this.x -= v.x;
+        this.y -= v.y;
+        this.z -= v.z;
+        this.w -= v.w;
+        return this;
+    }
+    /**
+     * Scale current vector.
+     * @public
+     * @param {number} scale - Scale value.
+     * @returns {Vec4}
+     */
+    scale(scale) {
+        this.x *= scale;
+        this.y *= scale;
+        this.z *= scale;
+        this.w *= scale;
+        return this;
+    }
+    /**
+     * Makes vector affinity. Thereby fourth component becomes to 1.0.
+     * @public
+     * @returns {Vec4}
+     */
+    affinity() {
+        let iw = 1.0 / this.w;
+        this.x *= iw;
+        this.y *= iw;
+        this.z *= iw;
+        this.w = 1.0;
+        return this;
+    }
+    /**
+     * Scale current vector to another instance.
+     * @public
+     * @param {number} scale - Scale value.
+     * @returns {Vec3}
+     */
+    scaleTo(scale) {
+        return new Vec4(this.x * scale, this.y * scale, this.z * scale, this.w * scale);
+    }
+    /**
+     * Vector's edge function that returns vector where each component is 0.0 if it's smaller than edge and otherwise 1.0.
+     * @public
+     * @returns {Vec4}
+     */
+    getStep(edge) {
+        return new Vec4(this.x < edge ? 0.0 : 1.0, this.y < edge ? 0.0 : 1.0, this.z < edge ? 0.0 : 1.0, this.w < edge ? 0.0 : 1.0);
+    }
+    /**
+     * The vector frac function returns the vector of fractional parts of each value, i.e. x minus floor(x).
+     * @public
+     * @param {Vec4} v - Input vector
+     * @returns {Vec4}
+     */
+    getFrac(v) {
+        return new Vec4(frac(v.x), frac(v.y), frac(v.z), frac(v.w));
+    }
+    /**
+     * Gets vectors dot production.
+     * @public
+     * @param {Vec4} v - Another vector.
+     * @returns {number} - Dot product.
+     */
+    dot(v) {
+        return v.x * this.x + v.y * this.y + v.z * this.z + v.w * this.w;
+    }
+    /**
+     * Returns true if vector's values are zero.
+     * @public
+     * @returns {boolean} -
+     */
+    isZero() {
+        return !(this.x || this.y || this.z || this.w);
+    }
+}
+/**
+ * Vector 4d object creator.
+ * @function
+ * @param {number} [x] - First value.
+ * @param {number} [y] - Second value.
+ * @param {number} [z] - Third value.
+ * @param {number} [w] - Fourth value.
+ * @returns {Vec4}
+ */
+export function vec4(x = 0, y = 0, z = 0, w = 0) {
+    return new Vec4(x, y, z, w);
+}

package/lib/js/math/coder.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @module og/math/coder
+ */
+import { NumberArray4, Vec4 } from "./Vec4";
+import { NumberArray3 } from "./Vec3";
+import { NumberArray2, Vec2 } from "./Vec2";
+/**
+ * Encode 32 bit float value to the RGBA vector.
+ * @function
+ * @param {number} v - 32 bit float value.
+ * @returns {Vec4} - RGBA vector value.
+ */
+export declare function encodeFloatToRGBA(v: number): Vec4;
+/**
+ * Decode RGBA vector to 32 bit float value.
+ * @function
+ * @param {Vec4} rgba - RGBA encoded 32 bit float value.
+ * @returns {number} - Float value.
+ */
+export declare function decodeFloatFromRGBA(rgba: Vec4): number;
+/**
+ * Decode RGBA vector to 32 bit float value.
+ * @function
+ * @param {NumberArray4 | NumberArray3} arr - RGBA encoded 32 bit float value.
+ * @param {boolean} [use32=false] Use 32 bit result
+ * @returns {number} - Float value.
+ */
+export declare function decodeFloatFromRGBAArr(arr: NumberArray4 | NumberArray3 | Uint8Array, use32?: boolean): number;
+/**
+ * Separate 64 bit value to two 32-bit float values.
+ * @function
+ * @param {number} value - Double type value.
+ * @returns {Float32Array} Encoded array. (exactly 2 entries)
+ */
+export declare function doubleToTwoFloats(value: number): Float32Array;
+/**
+ * Separate 64 bit value to two 32-bit float values.
+ * @function
+ * @param {number} value - Double type value.
+ * @param {NumberArray2 | Float32Array} - Reference out array.
+ * @returns {NumberArray2 | Float32Array} Encoded array. (exactly 2 entries)
+ */
+export declare function doubleToTwoFloats2(value: number, highLowArr: NumberArray2 | Float32Array): NumberArray2 | Float32Array;
+/**
+ * Separate 64 bit value to two 32-bit float values.
+ * @function
+ * @param {number} value - Double type value.
+ * @param {Vec2} highLowVec - Reference out vector object.
+ * @returns {Vec2} Encoded array. (exactly 2 entries)
+ */
+export declare function doubleToTwoFloatsV2(value: number, highLowVec: Vec2): Vec2;

package/lib/js/math/coder.js

@@ -0,0 +1,101 @@
+/**
+ * @module og/math/coder
+ */
+import * as math from "../math";
+import { Vec4 } from "./Vec4";
+/**
+ * Encode 32 bit float value to the RGBA vector.
+ * @function
+ * @param {number} v - 32 bit float value.
+ * @returns {Vec4} - RGBA vector value.
+ */
+export function encodeFloatToRGBA(v) {
+    let enc = new Vec4((1.0 * v) % 1, (255.0 * v) % 1, (65025.0 * v) % 1, (160581375.0 * v) % 1);
+    let yzww = new Vec4(enc.y / 255, enc.z / 255, enc.w / 255, 0);
+    return enc.subA(yzww);
+}
+/**
+ * Decode RGBA vector to 32 bit float value.
+ * @function
+ * @param {Vec4} rgba - RGBA encoded 32 bit float value.
+ * @returns {number} - Float value.
+ */
+export function decodeFloatFromRGBA(rgba) {
+    let s = 1.0 - math.step(128.0, rgba.x) * 2.0;
+    let e = 2.0 * math.mod(rgba.x, 128.0) + math.step(128.0, rgba.y) - 127.0;
+    let m = math.mod(rgba.y, 128.0) * 65536.0 + rgba.z * 256.0 + rgba.w + 8388608.0;
+    return s * math.exp2(e) * (m * 1.1920928955078125e-7);
+}
+/**
+ * Decode RGBA vector to 32 bit float value.
+ * @function
+ * @param {NumberArray4 | NumberArray3} arr - RGBA encoded 32 bit float value.
+ * @param {boolean} [use32=false] Use 32 bit result
+ * @returns {number} - Float value.
+ */
+export function decodeFloatFromRGBAArr(arr, use32 = false) {
+    let s = 1.0 - math.step(128.0, arr[0]) * 2.0;
+    let e = 2.0 * math.mod(arr[0], 128.0) + math.step(128.0, arr[1]) - 127.0;
+    let m = math.mod(arr[1], 128.0) * 65536.0 + arr[2] * 256.0 + (use32 ? arr[3] || 0.0 : 0.0) + 8388608.0;
+    return s * math.exp2(e) * (m * 1.1920928955078125e-7);
+}
+/**
+ * Separate 64 bit value to two 32-bit float values.
+ * @function
+ * @param {number} value - Double type value.
+ * @returns {Float32Array} Encoded array. (exactly 2 entries)
+ */
+export function doubleToTwoFloats(value) {
+    let high, low;
+    if (value >= 0.0) {
+        let doubleHigh = Math.floor(value / 65536.0) * 65536.0;
+        high = Math.fround(doubleHigh);
+        low = Math.fround(value - doubleHigh);
+    }
+    else {
+        let doubleHigh = Math.floor(-value / 65536.0) * 65536.0;
+        high = Math.fround(-doubleHigh);
+        low = Math.fround(value + doubleHigh);
+    }
+    return new Float32Array([high, low]);
+}
+/**
+ * Separate 64 bit value to two 32-bit float values.
+ * @function
+ * @param {number} value - Double type value.
+ * @param {NumberArray2 | Float32Array} - Reference out array.
+ * @returns {NumberArray2 | Float32Array} Encoded array. (exactly 2 entries)
+ */
+export function doubleToTwoFloats2(value, highLowArr) {
+    if (value >= 0.0) {
+        let doubleHigh = Math.floor(value / 65536.0) * 65536.0;
+        highLowArr[0] = Math.fround(doubleHigh);
+        highLowArr[1] = Math.fround(value - doubleHigh);
+    }
+    else {
+        let doubleHigh = Math.floor(-value / 65536.0) * 65536.0;
+        highLowArr[0] = Math.fround(-doubleHigh);
+        highLowArr[1] = Math.fround(value + doubleHigh);
+    }
+    return highLowArr;
+}
+/**
+ * Separate 64 bit value to two 32-bit float values.
+ * @function
+ * @param {number} value - Double type value.
+ * @param {Vec2} highLowVec - Reference out vector object.
+ * @returns {Vec2} Encoded array. (exactly 2 entries)
+ */
+export function doubleToTwoFloatsV2(value, highLowVec) {
+    if (value >= 0.0) {
+        let doubleHigh = Math.floor(value / 65536.0) * 65536.0;
+        highLowVec.x = Math.fround(doubleHigh);
+        highLowVec.y = Math.fround(value - doubleHigh);
+    }
+    else {
+        let doubleHigh = Math.floor(-value / 65536.0) * 65536.0;
+        highLowVec.x = Math.fround(-doubleHigh);
+        highLowVec.y = Math.fround(value + doubleHigh);
+    }
+    return highLowVec;
+}

package/lib/js/math/index.d.ts

@@ -0,0 +1,11 @@
+import { Line2 } from './Line2';
+import { Line3 } from './Line3';
+import { Mat3 } from './Mat3';
+import { Mat4 } from './Mat4';
+import { Plane } from './Plane';
+import { Quat } from './Quat';
+import { Ray } from './Ray';
+import { Vec2, NumberArray2 } from './Vec2';
+import { Vec3, NumberArray3 } from './Vec3';
+import { Vec4, NumberArray4 } from './Vec4';
+export { Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4, type NumberArray2, type NumberArray3, type NumberArray4 };

package/lib/js/math/index.js

@@ -0,0 +1,11 @@
+import { Line2 } from './Line2';
+import { Line3 } from './Line3';
+import { Mat3 } from './Mat3';
+import { Mat4 } from './Mat4';
+import { Plane } from './Plane';
+import { Quat } from './Quat';
+import { Ray } from './Ray';
+import { Vec2 } from './Vec2';
+import { Vec3 } from './Vec3';
+import { Vec4 } from './Vec4';
+export { Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4 };