@vertexvis/geometry 0.24.5-canary.6 → 1.0.0-testing.1

package/dist/matrix2.d.ts

@@ -1,29 +1,29 @@
-import * as Point from './point';
-/**
- * A 2x2 matrix. The contents are mapped as follows:
- *
- * ```
- * a  b
- * c  d
- * ```
- */
-export interface Matrix {
-    a: number;
-    b: number;
-    c: number;
-    d: number;
-}
-/**
- * Creates a new matrix.
- */
-export declare function create(a: Point.Point, b: Point.Point): Matrix;
-export declare function create(a: number, b: number, c: number, d: number): Matrix;
-export declare function create(): Matrix;
-/**
- * Returns the determinant of the provided matrix.
- */
-export declare function determinant(matrix: Matrix): number;
-/**
- * Returns the dot product of the two vectors represented in this matrix.
- */
-export declare function dot(matrix: Matrix): number;
+import * as Point from './point';
+/**
+ * A 2x2 matrix. The contents are mapped as follows:
+ *
+ * ```
+ * a  b
+ * c  d
+ * ```
+ */
+export interface Matrix {
+    a: number;
+    b: number;
+    c: number;
+    d: number;
+}
+/**
+ * Creates a new matrix.
+ */
+export declare function create(a: Point.Point, b: Point.Point): Matrix;
+export declare function create(a: number, b: number, c: number, d: number): Matrix;
+export declare function create(): Matrix;
+/**
+ * Returns the determinant of the provided matrix.
+ */
+export declare function determinant(matrix: Matrix): number;
+/**
+ * Returns the dot product of the two vectors represented in this matrix.
+ */
+export declare function dot(matrix: Matrix): number;

package/dist/matrix4.d.ts

@@ -1,285 +1,285 @@
-import * as Quaternion from './quaternion';
-import * as Vector3 from './vector3';
-/**
- * A type alias representing a 4x4 column-major matrix.
- *
- * The common use-case for 4x4 matrices in 3D computer graphics are for
- * [transformation
- * matrices](https://en.wikipedia.org/wiki/Transformation_matrix). This allows a
- * point in 3D space to be projected onto a 2D screen using transformations such
- * as translation, rotation and scale.
- */
-export declare type Matrix4 = [
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number
-];
-/**
- * An object representation of a `Matrix4`, where each value is represented as:
- *
- * ```
- * m11 m12 m13 m14
- * m21 m22 m23 m24
- * m31 m32 m33 m34
- * m41 m42 m43 m44
- * ```
- *
- * `Matrix4` arrays can be converted to an object using {@link toObject}.
- */
-export interface Matrix4AsObject {
-    m11: number;
-    m12: number;
-    m13: number;
-    m14: number;
-    m21: number;
-    m22: number;
-    m23: number;
-    m24: number;
-    m31: number;
-    m32: number;
-    m33: number;
-    m34: number;
-    m41: number;
-    m42: number;
-    m43: number;
-    m44: number;
-}
-/**
- * Creates a 4x4 matrix from a set of row-major components.
- */
-export declare function fromValues(m11: number, m12: number, m13: number, m14: number, m21: number, m22: number, m23: number, m24: number, m31: number, m32: number, m33: number, m34: number, m41: number, m42: number, m43: number, m44: number): Matrix4;
-/**
- * Creates a `Matrix4` from an object representation.
- */
-export declare function fromObject(obj: Matrix4AsObject): Matrix4;
-/**
- * Returns a new [identity matrix](https://en.wikipedia.org/wiki/Identity_matrix).
- */
-export declare function makeIdentity(): Matrix4;
-/**
- * Returns a matrix with all values as 0.
- */
-export declare function makeZero(): Matrix4;
-/**
- * Creates a translation matrix.
- *
- * ```
- * 1, 0, 0, 0,
- * 0, 1, 0, 0,
- * 0, 0, 1, 0,
- * x, y, z, 1
- * ```
- *
- * @param translation A vector representing the translation components.
- * @returns A translation matrix.
- */
-export declare function makeTranslation(translation: Vector3.Vector3): Matrix4;
-/**
- * Creates a rotation matrix.
- *
- * ```
- * 1-2y²-2z²,    2xy-2zw,    2xz+2yw,    0,
- * 2xy+2zw,      1-2x²-2z²,  2yz-2xw,    0,
- * 2xz-2yw,      2yz+2xw,    1-2x²-2y²,  0,
- * 0,            0,          0,          1,
- * ```
- *
- * @param rotation A quaternion representing the rotation.
- * @see https://en.wikipedia.org/wiki/Rotation_matrix#Quaternion
- * @returns A rotation matrix.
- */
-export declare function makeRotation(rotation: Quaternion.Quaternion): Matrix4;
-/**
- * Creates a scale matrix.
- *
- * ```
- * x, 0, 0, 0,
- * 0, y, 0, 0,
- * 0, 0, z, 0,
- * 0, 0, 0, 1
- * ```
- *
- * @param scale A vector representing the different scale components.
- * @returns A scale matrix.
- */
-export declare function makeScale(scale: Vector3.Vector3): Matrix4;
-/**
- * Creates a matrix that has translation, rotation and scale applied to it.
- *
- * @param translation The translation applied to the matrix.
- * @param rotation The rotation applied to the matrix.
- * @param scale The scale applied to the matrix.
- * @returns A transformed matrix.
- */
-export declare function makeTRS(translation: Vector3.Vector3, rotation: Quaternion.Quaternion, scale: Vector3.Vector3): Matrix4;
-/**
- * Returns a matrix that has the basis components (upper left 3x3 matrix) set to
- * the following x, y, and z axis.
- *
- * ```
- * x.x  y.x  z.x  0
- * x.y  y.y  z.y  0
- * x.z  y.z  z.z  0
- * 0    0    0    0
- * ```
- *
- * @param x The x axis to set.
- * @param y The y axis to set.
- * @param z The z axis to set.
- * @returns A matrix with its basis components populated.
- */
-export declare function makeBasis(x: Vector3.Vector3, y: Vector3.Vector3, z: Vector3.Vector3): Matrix4;
-/**
- * Creates a rotation matrix that is rotated around a given axis by the given
- * angle.
- *
- * @param axis The axis of rotation.
- * @param radians The angle of rotation.
- * @returns A rotation matrix.
- */
-export declare function makeRotationAxis(axis: Vector3.Vector3, radians: number): Matrix4;
-/**
- * Creates a matrix used for [perspective
- * projections](https://en.wikipedia.org/wiki/3D_projection#Perspective_projection).
- *
- * The viewing volume is frustum-shaped and defined by the six parameters. Left,
- * right, top, and bottom specify coordinates in the near clipping plane where
- * the frustum edges intersect it, and the near and far parameters define the
- * forward distances of the view volume. The resulting volume can be vertically
- * and horizontally asymmetrical around the center of the near plane.
- *
- * @param left The left coordinate at the near plane.
- * @param right The right coordinate at the near plane.
- * @param top The top coordinate at the near plane.
- * @param bottom The bottom coordinate at the near plane.
- * @param near The near distance.
- * @param far The far distance.
- * @returns A matrix representing a view frustum.
- */
-export declare function makeFrustum(left: number, right: number, top: number, bottom: number, near: number, far: number): Matrix4;
-/**
- * Creates a perspective projection matrix.
- *
- * Related to: gluPerspective. The viewing volume is frustum-shaped amd defined
- * by the four parameters. The fovy and aspect ratio are used to compute the
- * positions of the left, right, top, and bottom sides of the viewing volume in
- * the zNear plane. The fovy is the y field-of-view, the angle made by the top
- * and bottom sides of frustum if they were to intersect. The aspect ratio is
- * the width of the frustum divided by its height. Note that the resulting
- * volume is both vertically and horizontally symmetrical around the center of
- * the near plane.
- *
- * @param near The near Z value.
- * @param far The far Z value.
- * @param fovY The field of view.
- * @param aspect The aspect ratio.
- * @returns A matrix.
- */
-export declare function makePerspective(near: number, far: number, fovY: number, aspect: number): Matrix4;
-/**
- * Creates an orthographic projection matrix.
- *
- * Related to: gluOrtho. The viewing volume is cube-shaped and defined by
- * the six parameters. The left and right values represent the coordinates of
- * the vertical clipping planes, top and bottom values represent the coordinates
- * of the horizontal clipping planes, and near and far values represent the
- * coordinates of the depth clipping planes.
- *
- * @param left The coordinate of the left horizontal clipping plane.
- * @param right The coordinate of the right horizontal clipping plane.
- * @param bottom The coordinate of the bottom vertical clipping plane.
- * @param top The coordinate of the top vertical clipping plane.
- * @param near The coordinate of the near depth clipping plane.
- * @param far The coordinate of the far depth clipping plane.
- * @returns A matrix.
- */
-export declare function makeOrthographic(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4;
-/**
- * Matrix becomes a combination of an inverse translation and rotation.
- *
- * Related to: gluLookAt. This creates the inverse of makeLookAtMatrix. The
- * matrix will be an opposite translation from the 'eye' position, and it will
- * rotate things in the opposite direction of the eye-to-center orientation.
- * This is definitely confusing, but the main reason to use this transform is to
- * set up a view matrix for a camera that's looking at a certain point. To
- * achieve the effect of moving the camera somewhere and rotating it so that it
- * points at something, the rest of the world is moved in the opposite direction
- * and rotated in the opposite way around the camera. This way, you get the same
- * effect as moving the actual camera, but all the projection math can still be
- * done with the camera positioned at the origin (which makes it way simpler).
- *
- * @param position The position of the object.
- * @param lookAt The point which the object is looking at.
- * @param up The direction which the object considers up.
- * @returns A matrix.
- */
-export declare function makeLookAtView(position: Vector3.Vector3, lookAt: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
-/**
- * Matrix becomes a combination of translation and rotation.
- *
- * Matrix becomes a combination of a translation to the position of 'eye' and a
- * rotation matrix which orients an object to point towards 'center' along its
- * z-axis. Use this function if you want an object to look at a point from
- * another point in space.
- *
- * @param position The position of the object.
- * @param lookAt The point which the object is looking at.
- * @param up The direction which the object considers up.
- * @returns A matrix.
- */
-export declare function makeLookAt(position: Vector3.Vector3, lookAt: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
-/**
- * Returns the inverse of the given matrix. If the determinate of the matrix is
- * zero, then a zero matrix is returned.
- */
-export declare function invert(matrix: Matrix4): Matrix4;
-/**
- * Returns a rotation matrix looking from position towards target and oriented
- * by an up vector.
- *
- * @param m The matrix to transform.
- * @param position The point from which to look at target.
- * @param target The point to look at.
- * @param up The orientation.
- * @returns A rotation matrix.
- */
-export declare function lookAt(m: Matrix4, position: Vector3.Vector3, target: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
-/**
- * Returns a post-multiplied matrix.
- */
-export declare function multiply(a: Matrix4, b: Matrix4): Matrix4;
-/**
- * Returns the [transpose](https://en.wikipedia.org/wiki/Transpose) of the given
- * matrix.
- */
-export declare function transpose(matrix: Matrix4): Matrix4;
-/**
- * Multiplies the columns of a matrix by the given vector.
- */
-export declare function scale(matrix: Matrix4, scale: Vector3.Vector3): Matrix4;
-export declare function position(matrix: Matrix4, other: Matrix4): Matrix4;
-/**
- * Returns true if the matrix is an identity matrix.
- */
-export declare function isIdentity(matrix: Matrix4): boolean;
-/**
- * Returns an object representation of a `Matrix4`.
- */
-export declare function toObject(m: Matrix4): Matrix4AsObject;
-/**
- * A type guard to check if `obj` is of type `Matrix4`.
- */
-export declare function isType(obj: unknown): obj is Matrix4;
+import * as Quaternion from './quaternion';
+import * as Vector3 from './vector3';
+/**
+ * A type alias representing a 4x4 column-major matrix.
+ *
+ * The common use-case for 4x4 matrices in 3D computer graphics are for
+ * [transformation
+ * matrices](https://en.wikipedia.org/wiki/Transformation_matrix). This allows a
+ * point in 3D space to be projected onto a 2D screen using transformations such
+ * as translation, rotation and scale.
+ */
+export type Matrix4 = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+/**
+ * An object representation of a `Matrix4`, where each value is represented as:
+ *
+ * ```
+ * m11 m12 m13 m14
+ * m21 m22 m23 m24
+ * m31 m32 m33 m34
+ * m41 m42 m43 m44
+ * ```
+ *
+ * `Matrix4` arrays can be converted to an object using {@link toObject}.
+ */
+export interface Matrix4AsObject {
+    m11: number;
+    m12: number;
+    m13: number;
+    m14: number;
+    m21: number;
+    m22: number;
+    m23: number;
+    m24: number;
+    m31: number;
+    m32: number;
+    m33: number;
+    m34: number;
+    m41: number;
+    m42: number;
+    m43: number;
+    m44: number;
+}
+/**
+ * Creates a 4x4 matrix from a set of row-major components.
+ */
+export declare function fromValues(m11: number, m12: number, m13: number, m14: number, m21: number, m22: number, m23: number, m24: number, m31: number, m32: number, m33: number, m34: number, m41: number, m42: number, m43: number, m44: number): Matrix4;
+/**
+ * Creates a `Matrix4` from an object representation.
+ */
+export declare function fromObject(obj: Matrix4AsObject): Matrix4;
+/**
+ * Returns a new [identity matrix](https://en.wikipedia.org/wiki/Identity_matrix).
+ */
+export declare function makeIdentity(): Matrix4;
+/**
+ * Returns a matrix with all values as 0.
+ */
+export declare function makeZero(): Matrix4;
+/**
+ * Creates a translation matrix.
+ *
+ * ```
+ * 1, 0, 0, 0,
+ * 0, 1, 0, 0,
+ * 0, 0, 1, 0,
+ * x, y, z, 1
+ * ```
+ *
+ * @param translation A vector representing the translation components.
+ * @returns A translation matrix.
+ */
+export declare function makeTranslation(translation: Vector3.Vector3): Matrix4;
+/**
+ * Creates a rotation matrix.
+ *
+ * ```
+ * 1-2y²-2z²,    2xy-2zw,    2xz+2yw,    0,
+ * 2xy+2zw,      1-2x²-2z²,  2yz-2xw,    0,
+ * 2xz-2yw,      2yz+2xw,    1-2x²-2y²,  0,
+ * 0,            0,          0,          1,
+ * ```
+ *
+ * @param rotation A quaternion representing the rotation.
+ * @see https://en.wikipedia.org/wiki/Rotation_matrix#Quaternion
+ * @returns A rotation matrix.
+ */
+export declare function makeRotation(rotation: Quaternion.Quaternion): Matrix4;
+/**
+ * Creates a scale matrix.
+ *
+ * ```
+ * x, 0, 0, 0,
+ * 0, y, 0, 0,
+ * 0, 0, z, 0,
+ * 0, 0, 0, 1
+ * ```
+ *
+ * @param scale A vector representing the different scale components.
+ * @returns A scale matrix.
+ */
+export declare function makeScale(scale: Vector3.Vector3): Matrix4;
+/**
+ * Creates a matrix that has translation, rotation and scale applied to it.
+ *
+ * @param translation The translation applied to the matrix.
+ * @param rotation The rotation applied to the matrix.
+ * @param scale The scale applied to the matrix.
+ * @returns A transformed matrix.
+ */
+export declare function makeTRS(translation: Vector3.Vector3, rotation: Quaternion.Quaternion, scale: Vector3.Vector3): Matrix4;
+/**
+ * Returns a matrix that has the basis components (upper left 3x3 matrix) set to
+ * the following x, y, and z axis.
+ *
+ * ```
+ * x.x  y.x  z.x  0
+ * x.y  y.y  z.y  0
+ * x.z  y.z  z.z  0
+ * 0    0    0    0
+ * ```
+ *
+ * @param x The x axis to set.
+ * @param y The y axis to set.
+ * @param z The z axis to set.
+ * @returns A matrix with its basis components populated.
+ */
+export declare function makeBasis(x: Vector3.Vector3, y: Vector3.Vector3, z: Vector3.Vector3): Matrix4;
+/**
+ * Creates a rotation matrix that is rotated around a given axis by the given
+ * angle.
+ *
+ * @param axis The axis of rotation.
+ * @param radians The angle of rotation.
+ * @returns A rotation matrix.
+ */
+export declare function makeRotationAxis(axis: Vector3.Vector3, radians: number): Matrix4;
+/**
+ * Creates a matrix used for [perspective
+ * projections](https://en.wikipedia.org/wiki/3D_projection#Perspective_projection).
+ *
+ * The viewing volume is frustum-shaped and defined by the six parameters. Left,
+ * right, top, and bottom specify coordinates in the near clipping plane where
+ * the frustum edges intersect it, and the near and far parameters define the
+ * forward distances of the view volume. The resulting volume can be vertically
+ * and horizontally asymmetrical around the center of the near plane.
+ *
+ * @param left The left coordinate at the near plane.
+ * @param right The right coordinate at the near plane.
+ * @param top The top coordinate at the near plane.
+ * @param bottom The bottom coordinate at the near plane.
+ * @param near The near distance.
+ * @param far The far distance.
+ * @returns A matrix representing a view frustum.
+ */
+export declare function makeFrustum(left: number, right: number, top: number, bottom: number, near: number, far: number): Matrix4;
+/**
+ * Creates a perspective projection matrix.
+ *
+ * Related to: gluPerspective. The viewing volume is frustum-shaped amd defined
+ * by the four parameters. The fovy and aspect ratio are used to compute the
+ * positions of the left, right, top, and bottom sides of the viewing volume in
+ * the zNear plane. The fovy is the y field-of-view, the angle made by the top
+ * and bottom sides of frustum if they were to intersect. The aspect ratio is
+ * the width of the frustum divided by its height. Note that the resulting
+ * volume is both vertically and horizontally symmetrical around the center of
+ * the near plane.
+ *
+ * @param near The near Z value.
+ * @param far The far Z value.
+ * @param fovY The field of view.
+ * @param aspect The aspect ratio.
+ * @returns A matrix.
+ */
+export declare function makePerspective(near: number, far: number, fovY: number, aspect: number): Matrix4;
+/**
+ * Creates an orthographic projection matrix.
+ *
+ * Related to: gluOrtho. The viewing volume is cube-shaped and defined by
+ * the six parameters. The left and right values represent the coordinates of
+ * the vertical clipping planes, top and bottom values represent the coordinates
+ * of the horizontal clipping planes, and near and far values represent the
+ * coordinates of the depth clipping planes.
+ *
+ * @param left The coordinate of the left horizontal clipping plane.
+ * @param right The coordinate of the right horizontal clipping plane.
+ * @param bottom The coordinate of the bottom vertical clipping plane.
+ * @param top The coordinate of the top vertical clipping plane.
+ * @param near The coordinate of the near depth clipping plane.
+ * @param far The coordinate of the far depth clipping plane.
+ * @returns A matrix.
+ */
+export declare function makeOrthographic(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4;
+/**
+ * Matrix becomes a combination of an inverse translation and rotation.
+ *
+ * Related to: gluLookAt. This creates the inverse of makeLookAtMatrix. The
+ * matrix will be an opposite translation from the 'eye' position, and it will
+ * rotate things in the opposite direction of the eye-to-center orientation.
+ * This is definitely confusing, but the main reason to use this transform is to
+ * set up a view matrix for a camera that's looking at a certain point. To
+ * achieve the effect of moving the camera somewhere and rotating it so that it
+ * points at something, the rest of the world is moved in the opposite direction
+ * and rotated in the opposite way around the camera. This way, you get the same
+ * effect as moving the actual camera, but all the projection math can still be
+ * done with the camera positioned at the origin (which makes it way simpler).
+ *
+ * @param position The position of the object.
+ * @param lookAt The point which the object is looking at.
+ * @param up The direction which the object considers up.
+ * @returns A matrix.
+ */
+export declare function makeLookAtView(position: Vector3.Vector3, lookAt: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
+/**
+ * Matrix becomes a combination of translation and rotation.
+ *
+ * Matrix becomes a combination of a translation to the position of 'eye' and a
+ * rotation matrix which orients an object to point towards 'center' along its
+ * z-axis. Use this function if you want an object to look at a point from
+ * another point in space.
+ *
+ * @param position The position of the object.
+ * @param lookAt The point which the object is looking at.
+ * @param up The direction which the object considers up.
+ * @returns A matrix.
+ */
+export declare function makeLookAt(position: Vector3.Vector3, lookAt: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
+/**
+ * Returns the inverse of the given matrix. If the determinate of the matrix is
+ * zero, then a zero matrix is returned.
+ */
+export declare function invert(matrix: Matrix4): Matrix4;
+/**
+ * Returns a rotation matrix looking from position towards target and oriented
+ * by an up vector.
+ *
+ * @param m The matrix to transform.
+ * @param position The point from which to look at target.
+ * @param target The point to look at.
+ * @param up The orientation.
+ * @returns A rotation matrix.
+ */
+export declare function lookAt(m: Matrix4, position: Vector3.Vector3, target: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
+/**
+ * Returns a post-multiplied matrix.
+ */
+export declare function multiply(a: Matrix4, b: Matrix4): Matrix4;
+/**
+ * Returns the [transpose](https://en.wikipedia.org/wiki/Transpose) of the given
+ * matrix.
+ */
+export declare function transpose(matrix: Matrix4): Matrix4;
+/**
+ * Multiplies the columns of a matrix by the given vector.
+ */
+export declare function scale(matrix: Matrix4, scale: Vector3.Vector3): Matrix4;
+export declare function position(matrix: Matrix4, other: Matrix4): Matrix4;
+/**
+ * Returns true if the matrix is an identity matrix.
+ */
+export declare function isIdentity(matrix: Matrix4): boolean;
+/**
+ * Returns an object representation of a `Matrix4`.
+ */
+export declare function toObject(m: Matrix4): Matrix4AsObject;
+/**
+ * A type guard to check if `obj` is of type `Matrix4`.
+ */
+export declare function isType(obj: unknown): obj is Matrix4;