linearly 0.36.0 → 0.37.0

package/lib/cjs/quat.d.ts

@@ -1,334 +0,0 @@
-import * as Common from './common';
-import type { mat3 } from './mat3';
-import { mat4 } from './mat4';
-import { vec3 } from './vec3';
-import { vec4 } from './vec4';
-/**
- * Represents rotation in 3D space with the quaternion format XYZW.
- * @category Types
- */
-export type quat = readonly [x: number, y: number, z: number, w: number];
-/**
- * Functions for {@link quat}, a format for representing rotation in 3D space.
- * @category Modules
- */
-export declare namespace quat {
-    /**
-     * Mutable version of {@link quat}
-     * @category Types
-     */
-    type Mutable = [x: number, y: number, z: number, w: number];
-    /**
-     * Creates a new quaternion from given elements
-     * @category Generators
-     */
-    function of(x: number, y: number, z: number, w: number): quat;
-    /**
-     * Creates a mutable clone of given quat
-     * @category Generators
-     */
-    function clone(a: quat): Mutable;
-    /**
-     * Constrain each component to lie between min and max
-     * @see https://thebookofshaders.com/glossary/?search=clamp
-     */
-    function clamp(q: quat, min: number, max: number): quat;
-    /**
-     * Clamps each component to [0, 1]
-     */
-    function clamp01(q: quat): quat;
-    /**
-     * Clamps each component to [-1, 1]
-     */
-    function clamp11(q: quat): quat;
-    /**
-     * The identity quaternion.
-     * @category Constants
-     *
-     * @shorthands
-     * - {@link id}
-     * - {@link ident}
-     */
-    const identity: quat;
-    /**
-     * Alias for {@link identity}
-     * @category Shorthands
-     */
-    const I: quat;
-    /**
-     * Alias for {@link identity}
-     * @category Shorthands
-     */
-    const id: quat;
-    /**
-     * Alias for {@link identity}
-     * @category Shorthands
-     */
-    const ident: quat;
-    /**
-     * The zero quaternion.
-     * @category Constants
-     */
-    const zero: quat;
-    /**
-     * Sets a quat from the given angle and rotation axis,
-     * then returns it.
-     * @category Generators
-     * @param axis the axis around which to rotate
-     * @param deg the angle in degrees
-     **/
-    function fromAxisAngle(axis: vec3, deg: number): quat;
-    /**
-     * Gets the rotation axis and angle for a given
-     *  quaternion. If a quaternion is created with
-     *  fromAxisAngle, this method will return the same
-     *  values as provided in the original parameter list
-     *  OR functionally equivalent values.
-     * Example: The quaternion formed by axis [0, 0, 1] and
-     *  angle -90 is the same as the quaternion formed by
-     *  [0, 0, 1] and 270. This method favors the latter.
-     *
-     * @param  q Quaternion to be decomposed
-     */
-    function axisAngle(q: quat): {
-        axis: vec3;
-        deg: number;
-    };
-    /**
-     * Gets the angular distance between two unit quaternions
-     *
-     * @param  a     Origin unit quaternion
-     * @param  b     Destination unit quaternion
-     * @return  Angle, in degrees, between the two quaternions
-     */
-    function angle(a: quat, b: quat): number;
-    /**
-     * Multiplies given quat's
-     *
-     * @param a the first operand
-     * @param b the second operand
-     *
-     * @shorthands
-     * - {@link mul}
-     */
-    function multiply(...qs: quat[]): quat;
-    /**
-     * Alias for {@link multiply}
-     * @category Shorthands
-     */
-    const mul: typeof multiply;
-    /**
-     * Rotates a quaternion by the given angle about the X axis
-     *
-     * @param a quat to rotate
-     * @param deg angle to rotate, in degrees
-     */
-    function rotateX(a: quat, deg: number): quat;
-    /**
-     * Rotates a quaternion by the given angle about the Y axis
-     *
-     * @param a quat to rotate
-     * @param deg angle to rotate, in degrees
-     */
-    function rotateY(a: quat, deg: number): quat;
-    /**
-     * Rotates a quaternion by the given angle about the Z axis
-     *
-     * @param a quat to rotate
-     * @param deg angle (in degrees) to rotate
-     */
-    function rotateZ(a: quat, deg: number): quat;
-    /**
-     * Calculates the W component of a quat from the X, Y, and Z components.
-     * Assumes that quaternion is 1 unit in length.
-     * Any existing W component will be ignored.
-     */
-    function calculateW(q: quat): quat;
-    /**
-     * Calculate the exponential of a unit quaternion.
-     */
-    function exp(q: quat): quat;
-    /**
-     * Calculate the natural logarithm of a unit quaternion.
-     */
-    function ln(a: quat): quat;
-    /**
-     * Calculate the scalar power of a unit quaternion.
-     */
-    function pow(a: quat, b: number): quat;
-    /**
-     * Performs a spherical linear interpolation between two quat
-     *
-     * @param a the first operand
-     * @param b the second operand
-     * @param t interpolation amount, in the range [0-1], between the two inputs
-     */
-    function slerp(a: quat, b: quat, t: number): quat;
-    /**
-     * Calculates the inverse of a quat
-     */
-    function invert(q: quat): quat;
-    /**
-     * Calculates the conjugate of a quat
-     * If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.
-     */
-    function conjugate(a: quat): quat;
-    /**
-     * Creates a quaternion from the given 3x3 rotation matrix.
-     *
-     * NOTE: The resultant quaternion is not normalized, so you should be sure
-     * to renormalize the quaternion yourself where necessary.
-     * @category Generators
-     */
-    function fromMat3(m: mat3): quat;
-    /**
-     * Creates a quaternion from the given 4x4 affine matrix. The translation portion of the matrix is ignored. Same as mat4. Alias for {@link mat4.getRotation}.
-     */
-    const fromMat4: typeof mat4.getRotation;
-    /**
-     * Creates a quaternion from a normalized direction vector and an up vector.
-     * Equivalent to GLM's `glm::quatLookAt`.
-     *
-     * @param direction Normalized direction vector (forward)
-     * @param up Up vector, default is vec3.unitY
-     * @category Generators
-     */
-    function lookAt(direction: vec3, up?: vec3): quat;
-    /**
-     * Creates a quaternion from the given euler angle x, y, z using the provided intrinsic order for the conversion.
-     *
-     * @param deg Angles to rotate around X, Y, Z axes in degree.
-     * @param order Intrinsic order for conversion, default is zyx.
-     * @category Generators
-     */
-    function fromEuler(deg: vec3, order?: Common.AngleOrder): number[];
-    /**
-     * Extracts Euler angles from a quaternion. This is the inverse of {@link fromEuler}.
-     * Equivalent to GLM's `glm::eulerAngles`.
-     *
-     * @param q The quaternion to extract Euler angles from
-     * @param order Intrinsic order for conversion, default is zyx
-     * @returns Euler angles in degrees as vec3 [x, y, z]
-     */
-    function toEuler(q: quat, order?: Common.AngleOrder): vec3;
-    /**
-     * Performs a normalized linear interpolation (nlerp) between two quaternions.
-     * Faster than {@link slerp} and sufficient for small rotation differences.
-     *
-     * @param a the first operand
-     * @param b the second operand
-     * @param t interpolation amount, in the range [0-1], between the two inputs
-     */
-    function lerp(a: quat, b: quat, t: number): quat;
-    /**
-     * Adds given quat's
-     */
-    const add: (a: quat, b: quat) => quat;
-    /**
-     * Scales a quat by a scalar number
-     */
-    const scale: (a: quat, b: number) => quat;
-    /**
-     * Calculates the dot product of two quat's
-     */
-    const dot: (a: quat, b: quat) => number;
-    /**
-     * Calculates the length of a quat
-     *
-     * @param a vector to calculate length of
-     * @returns length of a
-     *
-     * @shorthands
-     * - {@link len}
-     */
-    const length: typeof vec4.length;
-    /**
-     * Alias for {@link length}
-     * @category Shorthands
-     */
-    const len: typeof vec4.length;
-    /**
-     * Calculates the squared length of a quat
-     *
-     * @param a vector to calculate squared length of
-     * @returns squared length of a
-     *
-     * @shorthands
-     * - {@link sqrLen}
-     */
-    const squaredLength: typeof vec4.squaredLength;
-    /**
-     * Alias for {@link squaredLength}
-     * @category Shorthands
-     */
-    const sqrLen: typeof vec4.squaredLength;
-    /**
-     * Normalize a quat
-     *
-     * @param a quaternion to normalize
-     */
-    const normalize: typeof vec4.normalize;
-    /**
-     * Returns whether or not the quaternions have exactly the same elements in the same position (when compared with `===`)
-     *
-     * @shorthands
-     * - {@link eq}
-     */
-    const exactEquals: typeof vec4.exactEquals;
-    /**
-     * Alias for {@link exactEquals}
-     * @category Shorthands
-     */
-    const eq: typeof vec4.exactEquals;
-    /**
-     * Returns whether or not the quaternions point approximately to the same direction. Both quaternions are assumed to be unit length.
-     *
-     * @shorthands
-     * - {@link approx}
-     * - {@link equals}
-     */
-    function approxEquals(a: quat, b: quat): boolean;
-    /**
-     * Alias for {@link approxEquals}
-     * @category Shorthands
-     */
-    const approx: typeof approxEquals;
-    /**
-     * Alias for {@link approxEquals}. This is provided for compatibility with gl-matrix.
-     * @category Shorthands
-     * @deprecated Use {@link approxEquals} instead
-     */
-    const equals: typeof approxEquals;
-    /**
-     * Sets a quaternion to represent the shortest rotation from one
-     * vector to another.
-     *
-     * Both vectors are assumed to be unit length.
-     *
-     * @param a the initial vector
-     * @param b the destination vector
-     * @category Generators
-     */
-    const rotationTo: (a: vec3, b: vec3) => quat;
-    /**
-     * Performs a spherical linear interpolation with two control points
-     *
-     * @param a the first operand
-     * @param b the second operand
-     * @param c the third operand
-     * @param d the fourth operand
-     * @param t interpolation amount, in the range [0-1], between the two inputs
-     */
-    function sqlerp(a: quat, b: quat, c: quat, d: quat, t: number): quat;
-    /**
-     * Sets the specified quaternion with values corresponding to the given
-     * axes. Each axis is a vec3 and is expected to be unit length and
-     * perpendicular to all other specified axes.
-     *
-     * @param view  the vector representing the viewing direction
-     * @param right the vector representing the local "right" direction
-     * @param up    the vector representing the local "up" direction
-     */
-    function setAxes(view: vec3, right: vec3, up: vec3): quat;
-}
-//# sourceMappingURL=quat.d.ts.map

package/lib/cjs/quat.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"quat.d.ts","sourceRoot":"","sources":["../../src/quat.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,UAAU,CAAA;AAClC,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAChC,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC3B,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC3B,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAE3B;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;AAExE;;;GAGG;AACH,yBAAiB,IAAI,CAAC;IACrB;;;OAGG;IACH,KAAY,OAAO,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;IAElE;;;OAGG;IACH,SAAgB,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAEnE;IAED;;;OAGG;IACH,SAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,CAEtC;IAED;;;OAGG;IACH,SAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAO7D;IAED;;OAEG;IACH,SAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAErC;IAED;;OAEG;IACH,SAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAErC;IAED;;;;;;;OAOG;IACI,MAAM,QAAQ,EAAE,IAAkC,CAAA;IAEzD;;;OAGG;IACI,MAAM,CAAC,MAAW,CAAA;IAEzB;;;OAGG;IACI,MAAM,EAAE,MAAW,CAAA;IAE1B;;;OAGG;IACI,MAAM,KAAK,MAAW,CAAA;IAE7B;;;OAGG;IACI,MAAM,IAAI,EAAE,IAAkC,CAAA;IAErD;;;;;;QAMI;IACJ,SAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAU3D;IAED;;;;;;;;;;;OAWG;IACH,SAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,GAAG;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAa5D;IAED;;;;;;OAMG;IACH,SAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,GAAG,MAAM,CAI9C;IAED;;;;;;;;OAQG;IACH,SAAgB,QAAQ,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,CAmB5C;IAED;;;OAGG;IACI,MAAM,GAAG,iBAAW,CAAA;IAE3B;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAgBlD;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAgBlD;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAiBlD;IAED;;;;OAIG;IACH,SAAgB,UAAU,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAIxC;IAED;;OAEG;IACH,SAAgB,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAQjC;IAED;;OAEG;IACH,SAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAOhC;IAED;;OAEG;IACH,SAAgB,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAE5C;IAED;;;;;;OAMG;IACH,SAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAsCvD;IAED;;OAEG;IACH,SAAgB,MAAM,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAOpC;IAED;;;OAGG;IACH,SAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAEvC;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAgCtC;IAED;;OAEG;IACI,MAAM,QAAQ,yBAAmB,CAAA;IAExC;;;;;;;OAOG;IACH,SAAgB,MAAM,CACrB,SAAS,EAAE,IAAI,EACf,EAAE,GAAE,IAAiB,GACnB,IAAI,CAiBN;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,oBAA6B,YAgEtE;IAED;;;;;;;OAOG;IACH,SAAgB,OAAO,CACtB,CAAC,EAAE,IAAI,EACP,KAAK,oBAA6B,GAChC,IAAI,CA6GN;IAED;;;;;;;OAOG;IACH,SAAgB,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CActD;IAED;;OAEG;IACI,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,KAAK,IAAe,CAAA;IAEvD;;OAEG;IACI,MAAM,KAAK,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,KAAK,IAAiB,CAAA;IAE7D;;OAEG;IACI,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,KAAK,MAAiB,CAAA;IAEzD;;;;;;;;OAQG;IACI,MAAM,MAAM,oBAAc,CAAA;IAEjC;;;OAGG;IACI,MAAM,GAAG,oBAAS,CAAA;IAEzB;;;;;;;;OAQG;IACI,MAAM,aAAa,2BAAqB,CAAA;IAE/C;;;OAGG;IACI,MAAM,MAAM,2BAAgB,CAAA;IAEnC;;;;OAIG;IACI,MAAM,SAAS,uBAAiB,CAAA;IAEvC;;;;;OAKG;IACI,MAAM,WAAW,yBAAmB,CAAA;IAE3C;;;OAGG;IACI,MAAM,EAAE,yBAAc,CAAA;IAE7B;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,WAE5C;IAED;;;OAGG;IACI,MAAM,MAAM,qBAAe,CAAA;IAElC;;;;OAIG;IACI,MAAM,MAAM,qBAAe,CAAA;IAClC;;;;;;;;;OASG;IACI,MAAM,UAAU,MACX,IAAI,KAAK,IAAI,KAAG,IAuBxB,CAAA;IAEJ;;;;;;;;OAQG;IACH,SAAgB,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAI1E;IAED;;;;;;;;OAQG;IACH,SAAgB,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,CAc/D;CACD"}