@vertexvis/geometry 0.24.3-testing.1 → 0.24.3

package/dist/cdn/bundle.esm.js

@@ -835,12 +835,12 @@ var matrix4 = /*#__PURE__*/Object.freeze({
 });
 
 /**
- * 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.
  */
 function create$c(value) {
     var _a, _b, _c, _d;
@@ -853,12 +853,12 @@ function create$c(value) {
     };
 }
 /**
- * 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.
  */
 function fromDegrees(value) {
     if (value === void 0) { value = {}; }
@@ -871,9 +871,13 @@ function fromDegrees(value) {
     });
 }
 /**
- * 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.
  */
@@ -950,12 +954,12 @@ function fromRotationMatrix(matrix, order) {
     return { x: x, y: y, z: z, order: order };
 }
 /**
- * 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.
  */
 function fromJson$4(json) {
     var obj = JSON.parse(json);
@@ -969,7 +973,7 @@ function fromJson$4(json) {
     }
 }
 /**
- * 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.
  */
 function isType$1(obj) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any