@vertexvis/geometry 0.24.3-testing.0 → 0.24.3

package/dist/cdn/euler.d.ts

@@ -13,41 +13,45 @@ export interface Euler {
     order: EulerOrder;
 }
 /**
- * Creates a new euler angle where each axis of rotation is defined by an angle,
+ * Creates a new set of Euler angles where each axis of rotation is defined by an angle,
  * in radians. If no value is given, then `{x: 0, y: 0, z: 0, order: 'xyz'}` is
  * returned.
  *
- * @param value The values to populate the euler angle with.
- * @returns A euler angle.
+ * @param value The values to populate the Euler angles with.
+ * @returns A set of Euler angles.
  */
 export declare function create(value?: Partial<Euler>): Euler;
 /**
- * Creates a new euler angle where each axis of rotation is defined by an angle,
+ * Creates a new set of Euler angles where each axis of rotation is defined by an angle,
  * in degrees. If no value is given, then `{x: 0, y: 0, z: 0, order: 'xyz'}` is
  * returned.
  *
- * @param value The values to populate the euler angle with.
- * @returns A euler angle.
+ * @param value The values to populate the Euler angles with.
+ * @returns A set of Euler angles.
  */
 export declare function fromDegrees(value?: Partial<Euler>): Euler;
 /**
- * Creates a euler angle from the rotation components of a 4x4 matrix. The
+ * Creates a set of Euler angles from the rotation components of a 4x4 matrix. The
  * rotation components are represented by the upper 3x3 of the matrix.
  *
+ * Note that there are two solutions for the Euler angle of the 2nd applied
+ * rotation (i.e. y for xyz) because sin(theta) = sin(PI-theta).
+ * The returned angle will always be the solution between -PI/2 and PI/2.
+ *
  * @param matrix A pure rotation matrix, unscaled.
  * @param order The order that the rotations are applied.
  */
 export declare function fromRotationMatrix(matrix: Matrix4.Matrix4, order?: EulerOrder): Euler;
 /**
- * Returns a euler angle that was decoded from a JSON string. Supports either
+ * Returns a set of Euler angles that was decoded from a JSON string. Supports either
  * extracting values from an array `[x, y, z, order]` or object `{x, y, z,
  * order}`.
  *
  * @param json A JSON object.
- * @returns A euler angle.
+ * @returns A set of Euler angles.
  */
 export declare function fromJson(json: string): Euler;
 /**
- * Type guard that checks if the given type is a Euler.
+ * Type guard that checks if the given type is a set of Euler angles.
  */
 export declare function isType(obj: unknown): obj is Euler;

package/dist/euler.d.ts

@@ -13,41 +13,45 @@ export interface Euler {
     order: EulerOrder;
 }
 /**
- * Creates a new euler angle where each axis of rotation is defined by an angle,
+ * Creates a new set of Euler angles where each axis of rotation is defined by an angle,
  * in radians. If no value is given, then `{x: 0, y: 0, z: 0, order: 'xyz'}` is
  * returned.
  *
- * @param value The values to populate the euler angle with.
- * @returns A euler angle.
+ * @param value The values to populate the Euler angles with.
+ * @returns A set of Euler angles.
  */
 export declare function create(value?: Partial<Euler>): Euler;
 /**
- * Creates a new euler angle where each axis of rotation is defined by an angle,
+ * Creates a new set of Euler angles where each axis of rotation is defined by an angle,
  * in degrees. If no value is given, then `{x: 0, y: 0, z: 0, order: 'xyz'}` is
  * returned.
  *
- * @param value The values to populate the euler angle with.
- * @returns A euler angle.
+ * @param value The values to populate the Euler angles with.
+ * @returns A set of Euler angles.
  */
 export declare function fromDegrees(value?: Partial<Euler>): Euler;
 /**
- * Creates a euler angle from the rotation components of a 4x4 matrix. The
+ * Creates a set of Euler angles from the rotation components of a 4x4 matrix. The
  * rotation components are represented by the upper 3x3 of the matrix.
  *
+ * Note that there are two solutions for the Euler angle of the 2nd applied
+ * rotation (i.e. y for xyz) because sin(theta) = sin(PI-theta).
+ * The returned angle will always be the solution between -PI/2 and PI/2.
+ *
  * @param matrix A pure rotation matrix, unscaled.
  * @param order The order that the rotations are applied.
  */
 export declare function fromRotationMatrix(matrix: Matrix4.Matrix4, order?: EulerOrder): Euler;
 /**
- * Returns a euler angle that was decoded from a JSON string. Supports either
+ * Returns a set of Euler angles that was decoded from a JSON string. Supports either
  * extracting values from an array `[x, y, z, order]` or object `{x, y, z,
  * order}`.
  *
  * @param json A JSON object.
- * @returns A euler angle.
+ * @returns A set of Euler angles.
  */
 export declare function fromJson(json: string): Euler;
 /**
- * Type guard that checks if the given type is a Euler.
+ * Type guard that checks if the given type is a set of Euler angles.
  */
 export declare function isType(obj: unknown): obj is Euler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/geometry",
-  "version": "0.24.3-testing.0",
+  "version": "0.24.3",
   "description": "Library for 2D and 3D geometric types.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -40,10 +40,10 @@
     "@types/jest": "^27.5.1",
     "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
     "@vertexvis/jest-config-vertexvis": "^0.5.4",
-    "@vertexwebsdk/build": "0.24.3-testing.0",
+    "@vertexwebsdk/build": "0.24.3",
     "eslint": "^8.57.1",
     "jest": "^27.5.1",
-    "rollup": "^2.75.6",
+    "rollup": "^2.80.0",
     "ts-jest": "^27.1.4",
     "tslib": "^2.1.0",
     "typescript": "^4.5.4"
@@ -51,5 +51,5 @@
   "peerDependencies": {
     "tslib": ">=2.1.0"
   },
-  "gitHead": "bcdd87ddda54e86faeca1ae7ad46c00eda67125f"
+  "gitHead": "e542667dfb640e3a27a933f88c11e5681a106fea"
 }