@vertexvis/geometry 1.0.2-canary.7 → 1.0.2-canary.9

package/dist/matrix4.d.ts

@@ -1,13 +1,12 @@
 import * as Quaternion from './quaternion';
 import * as Vector3 from './vector3';
 /**
- * A type alias representing a 4x4 column-major matrix.
+ * A type alias representing a 4x4 row-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.
+ * [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,
@@ -117,12 +116,12 @@ export declare function makeRotation(rotation: Quaternion.Quaternion): Matrix4;
  */
 export declare function makeScale(scale: Vector3.Vector3): Matrix4;
 /**
- * Creates a matrix that has translation, rotation and scale applied to it.
+ * 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.
+ * @returns A transformed matrix in column-major form.
  */
 export declare function makeTRS(translation: Vector3.Vector3, rotation: Quaternion.Quaternion, scale: Vector3.Vector3): Matrix4;
 /**
@@ -130,27 +129,18 @@ export declare function makeTRS(translation: Vector3.Vector3, rotation: Quaterni
  * 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
+ * x.x  x.y  x.z  0
+ * y.x  y.y  y.z  0
+ * z.x  z.y  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.
+ * @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).
@@ -258,7 +248,7 @@ export declare function invert(matrix: Matrix4): Matrix4;
  */
 export declare function lookAt(m: Matrix4, position: Vector3.Vector3, target: Vector3.Vector3, up: Vector3.Vector3): Matrix4;
 /**
- * Returns a post-multiplied matrix.
+ * Returns a post-multiplied matrix equal to ab.
  */
 export declare function multiply(a: Matrix4, b: Matrix4): Matrix4;
 /**
@@ -267,18 +257,36 @@ export declare function multiply(a: Matrix4, b: Matrix4): Matrix4;
  */
 export declare function transpose(matrix: Matrix4): Matrix4;
 /**
- * Multiplies the columns of a matrix by the given vector.
+ * Multiplies the columns of a row-major matrix by the given vector.
  */
 export declare function scale(matrix: Matrix4, scale: Vector3.Vector3): Matrix4;
-export declare function position(matrix: Matrix4, other: Matrix4): Matrix4;
+/**
+ * Sets the position of the matrix given as the first parameter
+ * to the position of the matrix given as the second parameter.
+ * Both matrices should have row-major format.
+ */
+export declare function position(originalMatrix: Matrix4, matrixWithDesiredPosition: 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`.
+ * @param m A Matrix4 item written in column-major form.
+ *
+ * @deprecated Use {@link toObjectColumnMajor} or {@link toObjectRowMajor} instead.
  */
 export declare function toObject(m: Matrix4): Matrix4AsObject;
+/**
+ * Returns an object representation of a `Matrix4`.
+ * @param m A Matrix4 item written in column-major form.
+ */
+export declare function toObjectColumnMajor(m: Matrix4): Matrix4AsObject;
+/**
+ * Returns an object representation of a `Matrix4`.
+ * @param m A Matrix4 item written in row-major form.
+ */
+export declare function toObjectRowMajor(m: Matrix4): Matrix4AsObject;
 /**
  * A type guard to check if `obj` is of type `Matrix4`.
  */

package/dist/vector3.d.ts

@@ -177,9 +177,25 @@ export declare function project(vector: Vector3, onNormal: Vector3): Vector3;
  */
 export declare function rotateAboutAxis(angle: number, point: Vector3, axisDirection: Vector3, axisPosition: Vector3): Vector3;
 /**
- * Returns a vector that is multiplied with a matrix.
+ * Returns a vector that is multiplied with a matrix in column-major form.
+ * @param vector A Vector3 item.
+ * @param m A Matrix4 item written in column-major form.
+ *
+ * @deprecated Use {@link multiplyByTransformMatrixColumnMajor} or {@link multiplyByTransformMatrixRowMajor} instead.
  */
 export declare function transformMatrix(vector: Vector3, m: Matrix4.Matrix4): Vector3;
+/**
+ * Returns a vector that is multiplied with a matrix in column-major form.
+ * @param vector A Vector3 item.
+ * @param m A Matrix4 item written in column-major form.
+ */
+export declare function multiplyByTransformMatrixColumnMajor(vector: Vector3, m: Matrix4.Matrix4): Vector3;
+/**
+ * Returns a vector that is multiplied with a matrix in row-major form.
+ * @param vector A Vector3 item.
+ * @param m A Matrix4 item written in row-major form.
+ */
+export declare function multiplyByTransformMatrixRowMajor(vector: Vector3, m: Matrix4.Matrix4): Vector3;
 /**
  * Euclidean distance between two vectors
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/geometry",
-  "version": "1.0.2-canary.7",
+  "version": "1.0.2-canary.9",
   "description": "Library for 2D and 3D geometric types.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertex3d.com> (https://developer.vertex3d.com)",
@@ -49,7 +49,7 @@
     "@types/jest": "^29.5.14",
     "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
     "@vertexvis/jest-config-vertexvis": "^0.5.4",
-    "@vertexwebsdk/build": "1.0.2-canary.7",
+    "@vertexwebsdk/build": "1.0.2-canary.9",
     "eslint": "^8.57.1",
     "jest": "^29.5.14",
     "jest-cli": "^29.5.14",
@@ -61,5 +61,5 @@
   "peerDependencies": {
     "tslib": ">=2.4.0"
   },
-  "gitHead": "56b22dbd761f5c66b5bb7280893e8b67de766f2e"
+  "gitHead": "366f5fddf21134632e865d3f50ea23804a54a4fa"
 }