@vertexvis/geometry 0.24.5-canary.4 → 1.0.0-testing.0

package/dist/dimensions.d.ts

@@ -1,94 +1,94 @@
-import * as Point from './point';
-import * as Rectangle from './rectangle';
-/**
- * `Dimensions` represent an object with a length of `width` and `height`.
- */
-export interface Dimensions {
-    width: number;
-    height: number;
-}
-/**
- * Returns a `Dimensions` with the given width and height.
- *
- */
-export declare const create: (width: number, height: number) => Dimensions;
-/**
- * Returns a `Dimensions` with the same width and height.
- */
-export declare const square: (size: number) => Dimensions;
-/**
- * Returns `true` if two dimensions have the same width and height. Otherwise
- * `false`.
- */
-export declare const isEqual: (a: Dimensions, b: Dimensions) => boolean;
-/**
- * Returns a scaled dimensions, where the width is scaled by `scaleX` and height
- * is scaled by `scaleY`.
- */
-export declare const scale: (scaleX: number, scaleY: number, dimensions: Dimensions) => Dimensions;
-/**
- * Returns a dimension where each length is scaled by `scaleFactor`.
- */
-export declare const proportionalScale: (scaleFactor: number, dimensions: Dimensions) => Dimensions;
-/**
- * Returns a `Dimensions` where the lengths of `dimensions` are trimmed to fit
- * into `to`.
- */
-export declare const trim: (to: Dimensions, dimensions: Dimensions) => Dimensions;
-/**
- * Returns a `Dimensions` where the longest length of `dimensions` will be equal
- * to the shortest length of `to`. The shortest length of `dimensions` will be
- * proportionally scaled to match the aspect ratio of `dimensions`.
- *
- * @see #cropFit()
- */
-export declare const containFit: (to: Dimensions, dimensions: Dimensions) => Dimensions;
-/**
- * Returns a `Dimensions` where the shortest length of `dimensions` will be
- * equal to the longest length of `to`. The longest length of `dimensions` will
- * be proportionally scaled to match the aspect ratio of `dimensions`.
- *
- * @see #containFit()
- */
-export declare const cropFit: (to: Dimensions, dimensions: Dimensions) => Dimensions;
-/**
- * Returns a `Dimensions` where each side of `dimensions` will be reduced proportionally
- * to have an area less than or equal to the provided `to` value. The returned
- * dimensions will be centered within the original bounds of `dimensions`.
- *
- * @param to - the maximum area this dimensions can have
- * @param dimensions - the dimensions to scale to fit the specified area
- */
-export declare const scaleFit: (to: number, dimensions: Dimensions) => Dimensions;
-/**
- * Returns a `Dimensions` with each length rounded.
- */
-export declare const round: (dimensions: Dimensions) => Dimensions;
-/**
- * Returns a `Dimensions` with each length rounded down.
- */
-export declare const floor: (dimensions: Dimensions) => Dimensions;
-/**
- * Returns the center point of the given `dimensions`.
- */
-export declare const center: (dimensions: Dimensions) => Point.Point;
-/**
- * Returns the aspect ratio of the given `dimensions`, as defined by width over
- * height.
- */
-export declare const aspectRatio: ({ width, height }: Dimensions) => number;
-/**
- * Returns the area of the given `dimensions`.
- */
-export declare const area: ({ width, height }: Dimensions) => number;
-/**
- * Returns a `Dimensions` fitted to the provided aspect ratio.
- *
- * @param ratio - Aspect ratio to fit the provided Dimensions to
- * @param dimensions - Dimensions to fit to the specified ratio
- */
-export declare const fitToRatio: (ratio: number, dimensions: Dimensions) => Dimensions;
-/**
- * Converts a dimension to a rectangle, with an optional position.
- */
-export declare function toRectangle(dimensions: Dimensions, position?: Point.Point): Rectangle.Rectangle;
+import * as Point from './point';
+import * as Rectangle from './rectangle';
+/**
+ * `Dimensions` represent an object with a length of `width` and `height`.
+ */
+export interface Dimensions {
+    width: number;
+    height: number;
+}
+/**
+ * Returns a `Dimensions` with the given width and height.
+ *
+ */
+export declare const create: (width: number, height: number) => Dimensions;
+/**
+ * Returns a `Dimensions` with the same width and height.
+ */
+export declare const square: (size: number) => Dimensions;
+/**
+ * Returns `true` if two dimensions have the same width and height. Otherwise
+ * `false`.
+ */
+export declare const isEqual: (a: Dimensions, b: Dimensions) => boolean;
+/**
+ * Returns a scaled dimensions, where the width is scaled by `scaleX` and height
+ * is scaled by `scaleY`.
+ */
+export declare const scale: (scaleX: number, scaleY: number, dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a dimension where each length is scaled by `scaleFactor`.
+ */
+export declare const proportionalScale: (scaleFactor: number, dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a `Dimensions` where the lengths of `dimensions` are trimmed to fit
+ * into `to`.
+ */
+export declare const trim: (to: Dimensions, dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a `Dimensions` where the longest length of `dimensions` will be equal
+ * to the shortest length of `to`. The shortest length of `dimensions` will be
+ * proportionally scaled to match the aspect ratio of `dimensions`.
+ *
+ * @see #cropFit()
+ */
+export declare const containFit: (to: Dimensions, dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a `Dimensions` where the shortest length of `dimensions` will be
+ * equal to the longest length of `to`. The longest length of `dimensions` will
+ * be proportionally scaled to match the aspect ratio of `dimensions`.
+ *
+ * @see #containFit()
+ */
+export declare const cropFit: (to: Dimensions, dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a `Dimensions` where each side of `dimensions` will be reduced proportionally
+ * to have an area less than or equal to the provided `to` value. The returned
+ * dimensions will be centered within the original bounds of `dimensions`.
+ *
+ * @param to - the maximum area this dimensions can have
+ * @param dimensions - the dimensions to scale to fit the specified area
+ */
+export declare const scaleFit: (to: number, dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a `Dimensions` with each length rounded.
+ */
+export declare const round: (dimensions: Dimensions) => Dimensions;
+/**
+ * Returns a `Dimensions` with each length rounded down.
+ */
+export declare const floor: (dimensions: Dimensions) => Dimensions;
+/**
+ * Returns the center point of the given `dimensions`.
+ */
+export declare const center: (dimensions: Dimensions) => Point.Point;
+/**
+ * Returns the aspect ratio of the given `dimensions`, as defined by width over
+ * height.
+ */
+export declare const aspectRatio: ({ width, height }: Dimensions) => number;
+/**
+ * Returns the area of the given `dimensions`.
+ */
+export declare const area: ({ width, height }: Dimensions) => number;
+/**
+ * Returns a `Dimensions` fitted to the provided aspect ratio.
+ *
+ * @param ratio - Aspect ratio to fit the provided Dimensions to
+ * @param dimensions - Dimensions to fit to the specified ratio
+ */
+export declare const fitToRatio: (ratio: number, dimensions: Dimensions) => Dimensions;
+/**
+ * Converts a dimension to a rectangle, with an optional position.
+ */
+export declare function toRectangle(dimensions: Dimensions, position?: Point.Point): Rectangle.Rectangle;

package/dist/euler.d.ts

@@ -1,57 +1,57 @@
-import * as Matrix4 from './matrix4';
-/**
- * A string representing the axis order of rotation.
- */
-export declare type EulerOrder = 'xyz' | 'yzx' | 'zxy' | 'xzy' | 'yxz' | 'zyx';
-/**
- * A type that represents [Euler Angles](http://en.wikipedia.org/wiki/Euler_angles).
- */
-export interface Euler {
-    x: number;
-    y: number;
-    z: number;
-    order: EulerOrder;
-}
-/**
- * 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 angles with.
- * @returns A set of Euler angles.
- */
-export declare function create(value?: Partial<Euler>): Euler;
-/**
- * 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 angles with.
- * @returns A set of Euler angles.
- */
-export declare function fromDegrees(value?: Partial<Euler>): Euler;
-/**
- * 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 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 set of Euler angles.
- */
-export declare function fromJson(json: string): Euler;
-/**
- * Type guard that checks if the given type is a set of Euler angles.
- */
-export declare function isType(obj: unknown): obj is Euler;
+import * as Matrix4 from './matrix4';
+/**
+ * A string representing the axis order of rotation.
+ */
+export type EulerOrder = 'xyz' | 'yzx' | 'zxy' | 'xzy' | 'yxz' | 'zyx';
+/**
+ * A type that represents [Euler Angles](http://en.wikipedia.org/wiki/Euler_angles).
+ */
+export interface Euler {
+    x: number;
+    y: number;
+    z: number;
+    order: EulerOrder;
+}
+/**
+ * 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 angles with.
+ * @returns A set of Euler angles.
+ */
+export declare function create(value?: Partial<Euler>): Euler;
+/**
+ * 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 angles with.
+ * @returns A set of Euler angles.
+ */
+export declare function fromDegrees(value?: Partial<Euler>): Euler;
+/**
+ * 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 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 set of Euler angles.
+ */
+export declare function fromJson(json: string): 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/index.d.ts

@@ -1,21 +1,21 @@
-/**
- * @module Geometry
- */
-import * as Angle from './angle';
-import * as BoundingBox from './boundingBox';
-import * as BoundingSphere from './boundingSphere';
-import * as Dimensions from './dimensions';
-import * as Euler from './euler';
-import * as Line3 from './line3';
-import * as Matrix from './matrix';
-import * as Matrix2 from './matrix2';
-import * as Matrix4 from './matrix4';
-import * as Plane from './plane';
-import * as Point from './point';
-import * as Quaternion from './quaternion';
-import * as Ray from './ray';
-import * as Rectangle from './rectangle';
-import * as Vector3 from './vector3';
-import * as Vector4 from './vector4';
-export * from './math';
-export { Angle, BoundingBox, BoundingSphere, Dimensions, Euler, Line3, Matrix, Matrix2, Matrix4, Plane, Point, Quaternion, Ray, Rectangle, Vector3, Vector4, };
+/**
+ * @module Geometry
+ */
+import * as Angle from './angle';
+import * as BoundingBox from './boundingBox';
+import * as BoundingSphere from './boundingSphere';
+import * as Dimensions from './dimensions';
+import * as Euler from './euler';
+import * as Line3 from './line3';
+import * as Matrix from './matrix';
+import * as Matrix2 from './matrix2';
+import * as Matrix4 from './matrix4';
+import * as Plane from './plane';
+import * as Point from './point';
+import * as Quaternion from './quaternion';
+import * as Ray from './ray';
+import * as Rectangle from './rectangle';
+import * as Vector3 from './vector3';
+import * as Vector4 from './vector4';
+export * from './math';
+export { Angle, BoundingBox, BoundingSphere, Dimensions, Euler, Line3, Matrix, Matrix2, Matrix4, Plane, Point, Quaternion, Ray, Rectangle, Vector3, Vector4, };

package/dist/line3.d.ts

@@ -1,48 +1,48 @@
-import * as Matrix4 from './matrix4';
-import * as Vector3 from './vector3';
-/**
- * A `Line3` represents a line segment between a `start` and `end` point.
- */
-export interface Line3 {
-    /**
-     * The start of the line segment.
-     */
-    start: Vector3.Vector3;
-    /**
-     * The end of the line segment.
-     */
-    end: Vector3.Vector3;
-}
-/**
- * Creates a new `Line3`. If unspecified, the start and end values of the line
- * will be at origin.
- *
- * @param values The values to assign to the line.
- */
-export declare function create(values?: Partial<Line3>): Line3;
-/**
- * Returns the point that is halfway between start and end.
- */
-export declare function center(line: Line3): Vector3.Vector3;
-/**
- * Returns a line where the start and end points are transformed with the given
- * matrix.
- *
- * @param line The line to transform.
- * @param matrix The matrix to apply.
- * @returns A transformed line.
- */
-export declare function transformMatrix(line: Line3, matrix: Matrix4.Matrix4): Line3;
-/**
- * Euclidean distance between the start and end points of the line.
- */
-export declare function distance(line: Line3): number;
-/**
- * Returns the squared distance between a line's start and end point. If you're
- * just comparing distances, this is slightly more efficient than `distanceTo`.
- */
-export declare function distanceSquared(line: Line3): number;
-/**
- * Returns a vector describing the direction of the line from start to end.
- */
-export declare function direction(line: Line3): Vector3.Vector3;
+import * as Matrix4 from './matrix4';
+import * as Vector3 from './vector3';
+/**
+ * A `Line3` represents a line segment between a `start` and `end` point.
+ */
+export interface Line3 {
+    /**
+     * The start of the line segment.
+     */
+    start: Vector3.Vector3;
+    /**
+     * The end of the line segment.
+     */
+    end: Vector3.Vector3;
+}
+/**
+ * Creates a new `Line3`. If unspecified, the start and end values of the line
+ * will be at origin.
+ *
+ * @param values The values to assign to the line.
+ */
+export declare function create(values?: Partial<Line3>): Line3;
+/**
+ * Returns the point that is halfway between start and end.
+ */
+export declare function center(line: Line3): Vector3.Vector3;
+/**
+ * Returns a line where the start and end points are transformed with the given
+ * matrix.
+ *
+ * @param line The line to transform.
+ * @param matrix The matrix to apply.
+ * @returns A transformed line.
+ */
+export declare function transformMatrix(line: Line3, matrix: Matrix4.Matrix4): Line3;
+/**
+ * Euclidean distance between the start and end points of the line.
+ */
+export declare function distance(line: Line3): number;
+/**
+ * Returns the squared distance between a line's start and end point. If you're
+ * just comparing distances, this is slightly more efficient than `distanceTo`.
+ */
+export declare function distanceSquared(line: Line3): number;
+/**
+ * Returns a vector describing the direction of the line from start to end.
+ */
+export declare function direction(line: Line3): Vector3.Vector3;

package/dist/math.d.ts

@@ -1,20 +1,20 @@
-/**
- * Clamps the given value between `min` and `max`.
- *
- * @param value The value to clamp.
- * @param min The min possible value.
- * @param max The max possible value.
- * @returns `value` or a value clamped to `min` or `max`.
- */
-export declare function clamp(value: number, min: number, max: number): number;
-/**
- * Linear interpolates a value between `a` and `b` by `t`. If `t` is 0, then the
- * result will be `a`. If `t` is 1, then the result will be `b`. `t` will be
- * clamped to a value between 0 and 1.
- *
- * @param a The start value.
- * @param b The end value.
- * @param t The interpolation value between 0 and 1.
- * @returns The interpolated value between `a` and `b`.
- */
-export declare function lerp(a: number, b: number, t: number): number;
+/**
+ * Clamps the given value between `min` and `max`.
+ *
+ * @param value The value to clamp.
+ * @param min The min possible value.
+ * @param max The max possible value.
+ * @returns `value` or a value clamped to `min` or `max`.
+ */
+export declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Linear interpolates a value between `a` and `b` by `t`. If `t` is 0, then the
+ * result will be `a`. If `t` is 1, then the result will be `b`. `t` will be
+ * clamped to a value between 0 and 1.
+ *
+ * @param a The start value.
+ * @param b The end value.
+ * @param t The interpolation value between 0 and 1.
+ * @returns The interpolated value between `a` and `b`.
+ */
+export declare function lerp(a: number, b: number, t: number): number;

package/dist/matrix.d.ts

@@ -1,73 +1,73 @@
-import * as Point from './point';
-/**
- * Represents a 2D transformation matrix.
- *
- * The values of this matrix are meant to represent a 3x3 matrix where the
- * contents are mapped as the following:
- *
- * ```
- * a  b  tx
- * c  d  ty
- * u  v  w
- * ```
- */
-export interface Matrix {
-    /**
-     * Value that affects the positioning along the x axis when scaling or
-     * rotating.
-     */
-    a: number;
-    /**
-     * Value that affects the positioning along the y axis when rotating or
-     * skewing.
-     */
-    b: number;
-    /**
-     * Value that affects the positioning along the x axis when rotating or
-     * skewing.
-     */
-    c: number;
-    /**
-     * Value that affects the positioning along the y axis when scaling or
-     * rotating.
-     */
-    d: number;
-    /**
-     * The distance to translate along the x axis.
-     */
-    tx: number;
-    /**
-     * The distance to translate along the y axis.
-     */
-    ty: number;
-}
-/**
- * Creates a new matrix. If arguments are undefined, returns an identity matrix.
- */
-export declare const create: (a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number) => Matrix;
-/**
- * Returns an identity matrix.
- */
-export declare const identity: () => Matrix;
-/**
- * Creates a matrix that is translated by the given `tx` and `ty` values.
- */
-export declare const translation: (tx: number, ty: number) => Matrix;
-/**
- * Creates a matrix that is rotated by the given degrees.
- */
-export declare const rotation: (degrees: number) => Matrix;
-/**
- * Rotates the given matrix by the given degrees.
- */
-export declare const rotate: (degrees: number, matrix: Matrix) => Matrix;
-/**
- * Translates the given matrix along the horizontal and vertical axis by the
- * given `dx` and `dy` delta values.
- */
-export declare const translate: (dx: number, dy: number, matrix: Matrix) => Matrix;
-/**
- * Returns the result of applying a geometric transformation of a matrix on the
- * given point.
- */
-export declare const transformPoint: (matrix: Matrix, pt: Point.Point) => Point.Point;
+import * as Point from './point';
+/**
+ * Represents a 2D transformation matrix.
+ *
+ * The values of this matrix are meant to represent a 3x3 matrix where the
+ * contents are mapped as the following:
+ *
+ * ```
+ * a  b  tx
+ * c  d  ty
+ * u  v  w
+ * ```
+ */
+export interface Matrix {
+    /**
+     * Value that affects the positioning along the x axis when scaling or
+     * rotating.
+     */
+    a: number;
+    /**
+     * Value that affects the positioning along the y axis when rotating or
+     * skewing.
+     */
+    b: number;
+    /**
+     * Value that affects the positioning along the x axis when rotating or
+     * skewing.
+     */
+    c: number;
+    /**
+     * Value that affects the positioning along the y axis when scaling or
+     * rotating.
+     */
+    d: number;
+    /**
+     * The distance to translate along the x axis.
+     */
+    tx: number;
+    /**
+     * The distance to translate along the y axis.
+     */
+    ty: number;
+}
+/**
+ * Creates a new matrix. If arguments are undefined, returns an identity matrix.
+ */
+export declare const create: (a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number) => Matrix;
+/**
+ * Returns an identity matrix.
+ */
+export declare const identity: () => Matrix;
+/**
+ * Creates a matrix that is translated by the given `tx` and `ty` values.
+ */
+export declare const translation: (tx: number, ty: number) => Matrix;
+/**
+ * Creates a matrix that is rotated by the given degrees.
+ */
+export declare const rotation: (degrees: number) => Matrix;
+/**
+ * Rotates the given matrix by the given degrees.
+ */
+export declare const rotate: (degrees: number, matrix: Matrix) => Matrix;
+/**
+ * Translates the given matrix along the horizontal and vertical axis by the
+ * given `dx` and `dy` delta values.
+ */
+export declare const translate: (dx: number, dy: number, matrix: Matrix) => Matrix;
+/**
+ * Returns the result of applying a geometric transformation of a matrix on the
+ * given point.
+ */
+export declare const transformPoint: (matrix: Matrix, pt: Point.Point) => Point.Point;