@vertexvis/geometry 0.24.5 → 1.0.0-canary.0

package/dist/point.d.ts

@@ -1,80 +1,80 @@
-import * as Angle from './angle';
-/**
- * A `Point` represents a cartesian coordinate with a horizontal and vertical
- * position or length.
- */
-export interface Point {
-    x: number;
-    y: number;
-}
-/**
- * Returns a new `Point` with the given horizontal and vertical position.
- */
-export declare function create(x?: number, y?: number): Point;
-/**
- * Converts a polar coordinate (length and angle) into a Cartesian coordinate.
- */
-export declare function polar(length: number, radians: Angle.Angle): Point;
-/**
- * Returns the distance between two points.
- */
-export declare function distance(a: Point, b: Point): number;
-/**
- * Returns a new `Point` where `b` is subtracted from `a`.
- */
-export declare function subtract(a: Point, b: Point): Point;
-/**
- * Returns a new `Point` where `b` is added to `a`.
- */
-export declare function add(a: Point, b: Point): Point;
-/**
- * Returns `true` if the `x` and `y` positions of `a` and `b` are equal.
- */
-export declare function isEqual(a: Point, b: Point): boolean;
-/**
- * Performs a linear interpolation between `a` and `b` and returns the result.
- * The value of `t` is clamped between `[0, 1]`.
- *
- * @param a The start value.
- * @param b The end value.
- * @param t A value between 0 and 1.
- * @returns A point between `a` and `b`.
- */
-export declare function lerp(a: Point, b: Point, t: number): Point;
-/**
- * Returns a new `Point` where `x` and `y` are inverted.
- */
-export declare function negate(pt: Point): Point;
-/**
- * Returns a new `Point` where `x` and `y` are multiplied by the given scale
- * factors.
- */
-export declare function scale(pt: Point, scaleX: number, scaleY: number): Point;
-/**
- * Returns a new `Point` where `x` and `y` are multiplied by the given scale
- * factor.
- */
-export declare function scaleProportional(pt: Point, scale: number): Point;
-/**
- * Returns the magnitude of a point.
- */
-export declare function magnitude(pt: Point): number;
-/**
- * Transforms a vector into the corresponding normal (unit) vector.
- */
-export declare function normalizeVector(pt: Point): Point;
-/**
- * Returns a new normal (unit) vector pointing between the two given points.
- */
-export declare function normalDirectionVector(ptA: Point, ptB: Point): Point;
-/**
- * Returns a vector orthogonal to the vector between the two given points.
- */
-export declare function orthogonalVector(ptA: Point, ptB: Point): Point;
-/**
- * Parses a JSON string representation of a Point and returns an object.
- *
- * @param json A JSON string, either in the form `[x,y]` or `{"x": 0, "y": 0}`
- * @returns A parsed Point.
- */
-export declare function fromJson(json: string): Point;
+import * as Angle from './angle';
+/**
+ * A `Point` represents a cartesian coordinate with a horizontal and vertical
+ * position or length.
+ */
+export interface Point {
+    x: number;
+    y: number;
+}
+/**
+ * Returns a new `Point` with the given horizontal and vertical position.
+ */
+export declare function create(x?: number, y?: number): Point;
+/**
+ * Converts a polar coordinate (length and angle) into a Cartesian coordinate.
+ */
+export declare function polar(length: number, radians: Angle.Angle): Point;
+/**
+ * Returns the distance between two points.
+ */
+export declare function distance(a: Point, b: Point): number;
+/**
+ * Returns a new `Point` where `b` is subtracted from `a`.
+ */
+export declare function subtract(a: Point, b: Point): Point;
+/**
+ * Returns a new `Point` where `b` is added to `a`.
+ */
+export declare function add(a: Point, b: Point): Point;
+/**
+ * Returns `true` if the `x` and `y` positions of `a` and `b` are equal.
+ */
+export declare function isEqual(a: Point, b: Point): boolean;
+/**
+ * Performs a linear interpolation between `a` and `b` and returns the result.
+ * The value of `t` is clamped between `[0, 1]`.
+ *
+ * @param a The start value.
+ * @param b The end value.
+ * @param t A value between 0 and 1.
+ * @returns A point between `a` and `b`.
+ */
+export declare function lerp(a: Point, b: Point, t: number): Point;
+/**
+ * Returns a new `Point` where `x` and `y` are inverted.
+ */
+export declare function negate(pt: Point): Point;
+/**
+ * Returns a new `Point` where `x` and `y` are multiplied by the given scale
+ * factors.
+ */
+export declare function scale(pt: Point, scaleX: number, scaleY: number): Point;
+/**
+ * Returns a new `Point` where `x` and `y` are multiplied by the given scale
+ * factor.
+ */
+export declare function scaleProportional(pt: Point, scale: number): Point;
+/**
+ * Returns the magnitude of a point.
+ */
+export declare function magnitude(pt: Point): number;
+/**
+ * Transforms a vector into the corresponding normal (unit) vector.
+ */
+export declare function normalizeVector(pt: Point): Point;
+/**
+ * Returns a new normal (unit) vector pointing between the two given points.
+ */
+export declare function normalDirectionVector(ptA: Point, ptB: Point): Point;
+/**
+ * Returns a vector orthogonal to the vector between the two given points.
+ */
+export declare function orthogonalVector(ptA: Point, ptB: Point): Point;
+/**
+ * Parses a JSON string representation of a Point and returns an object.
+ *
+ * @param json A JSON string, either in the form `[x,y]` or `{"x": 0, "y": 0}`
+ * @returns A parsed Point.
+ */
+export declare function fromJson(json: string): Point;

package/dist/quaternion.d.ts

@@ -1,65 +1,65 @@
-import * as Euler from './euler';
-import * as Matrix4 from './matrix4';
-import * as Vector3 from './vector3';
-/**
- * A type that represents a
- * [quaternion](http://en.wikipedia.org/wiki/Quaternion). Quaternions are used
- * in 3D graphics to represent
- * [rotations](https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation).
- */
-export interface Quaternion {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-}
-/**
- * An array representation of a `Quaternion`.
- */
-export declare type QuaternionAsArray = [x: number, y: number, z: number, w: number];
-/**
- * Returns a new quaternion. If `value` is undefined, then `{x: 0, y: 0, z: 0,
- * w: 1}` is returned.
- */
-export declare function create(value?: Partial<Quaternion>): Quaternion;
-/**
- * Parses a JSON string representation of a `Quaternion`.
- *
- * @param json A JSON string either in the form of `[x, y, z, w]` or `{"x": 0, "y": 0, "z": 0, "w": 0}`.
- * @returns A parsed `Quaternion`.
- */
-export declare function fromJson(json: string): Quaternion;
-/**
- * Returns a quaternion with that will have a magnitude of 1.
- */
-export declare function normalize(q: Quaternion): Quaternion;
-/**
- * Returns the magnitude of the provided quaternion.
- */
-export declare function magnitude(q: Quaternion): number;
-/**
- * Returns a quaternion where each component is multiplied by the `scalar`.
- */
-export declare function scale(scalar: number, q: Quaternion): Quaternion;
-/**
- * Creates a `Quaternion` that is rotated the given radians around an axis.
- *
- * @param axis The axis to rotate around.
- * @param radians The rotation, in radians.
- * @returns A rotated quaternion.
- */
-export declare function fromAxisAngle(axis: Vector3.Vector3, radians: number): Quaternion;
-/**
- * Returns a quaternion using the upper 3x3 of a pure rotation matrix
- * (unscaled).
- */
-export declare function fromMatrixRotation(matrix: Matrix4.Matrix4): Quaternion;
-export declare function fromEuler(euler: Euler.Euler): Quaternion;
-/**
- * Multiplies `a` x `b` and returns a new quaternion with the result.
- */
-export declare function multiply(a: Quaternion, b: Quaternion): Quaternion;
-/**
- * Type guard that checks if the given type is a Quaternion.
- */
-export declare function isType(obj: unknown): obj is Quaternion;
+import * as Euler from './euler';
+import * as Matrix4 from './matrix4';
+import * as Vector3 from './vector3';
+/**
+ * A type that represents a
+ * [quaternion](http://en.wikipedia.org/wiki/Quaternion). Quaternions are used
+ * in 3D graphics to represent
+ * [rotations](https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation).
+ */
+export interface Quaternion {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+/**
+ * An array representation of a `Quaternion`.
+ */
+export type QuaternionAsArray = [x: number, y: number, z: number, w: number];
+/**
+ * Returns a new quaternion. If `value` is undefined, then `{x: 0, y: 0, z: 0,
+ * w: 1}` is returned.
+ */
+export declare function create(value?: Partial<Quaternion>): Quaternion;
+/**
+ * Parses a JSON string representation of a `Quaternion`.
+ *
+ * @param json A JSON string either in the form of `[x, y, z, w]` or `{"x": 0, "y": 0, "z": 0, "w": 0}`.
+ * @returns A parsed `Quaternion`.
+ */
+export declare function fromJson(json: string): Quaternion;
+/**
+ * Returns a quaternion with that will have a magnitude of 1.
+ */
+export declare function normalize(q: Quaternion): Quaternion;
+/**
+ * Returns the magnitude of the provided quaternion.
+ */
+export declare function magnitude(q: Quaternion): number;
+/**
+ * Returns a quaternion where each component is multiplied by the `scalar`.
+ */
+export declare function scale(scalar: number, q: Quaternion): Quaternion;
+/**
+ * Creates a `Quaternion` that is rotated the given radians around an axis.
+ *
+ * @param axis The axis to rotate around.
+ * @param radians The rotation, in radians.
+ * @returns A rotated quaternion.
+ */
+export declare function fromAxisAngle(axis: Vector3.Vector3, radians: number): Quaternion;
+/**
+ * Returns a quaternion using the upper 3x3 of a pure rotation matrix
+ * (unscaled).
+ */
+export declare function fromMatrixRotation(matrix: Matrix4.Matrix4): Quaternion;
+export declare function fromEuler(euler: Euler.Euler): Quaternion;
+/**
+ * Multiplies `a` x `b` and returns a new quaternion with the result.
+ */
+export declare function multiply(a: Quaternion, b: Quaternion): Quaternion;
+/**
+ * Type guard that checks if the given type is a Quaternion.
+ */
+export declare function isType(obj: unknown): obj is Quaternion;

package/dist/ray.d.ts

@@ -1,52 +1,52 @@
-import * as Plane from './plane';
-import * as Vector3 from './vector3';
-/**
- * A `Ray` represents an infinite line starting at `origin` and going in
- * `direction`.
- */
-export interface Ray {
-    /**
-     * The origin point of the ray.
-     */
-    origin: Vector3.Vector3;
-    /**
-     * A normal that describes the direction of the ray from origin.
-     */
-    direction: Vector3.Vector3;
-}
-/**
- * Creates a new ray with the given values, or using default values if none are
- * provided. The direction defaults to `{x: 0, y: 0, z: -1}` if undefined.
- *
- * @param value The values of the ray.
- * @returns A new ray.
- */
-export declare function create(value?: Partial<Ray>): Ray;
-/**
- * Returns a point at the given distance along this ray.
- *
- * @param ray The ray to get the point on.
- * @param distance A distance from origin along the ray's direction.
- * @returns A point on the ray.
- */
-export declare function at(ray: Ray, distance: number): Vector3.Vector3;
-/**
- * Computes the distance of the `ray`s origin to the given `plane`. Returns a
- * distance of 0 if the ray is coplanar and returns `undefined` if the ray does
- * not intersect with the plane.
- *
- * @param ray The ray to get the distance for.
- * @param plane The plane to compute the distance to.
- * @returns The distance to the plane, or `undefined` if it cannot be computed.
- */
-export declare function distanceToPlane(ray: Ray, plane: Plane.Plane): number | undefined;
-/**
- * Computes the intersection point of the given `ray` to the given `plane`. If
- * the ray does not intersect with the plane, then `undefined` is returned.
- *
- * @param ray The ray to intersect.
- * @param plane The plane to intersect with.
- * @returns The intersection point, or `undefined` if the ray does not
- * intersect.
- */
-export declare function intersectPlane(ray: Ray, plane: Plane.Plane): Vector3.Vector3 | undefined;
+import * as Plane from './plane';
+import * as Vector3 from './vector3';
+/**
+ * A `Ray` represents an infinite line starting at `origin` and going in
+ * `direction`.
+ */
+export interface Ray {
+    /**
+     * The origin point of the ray.
+     */
+    origin: Vector3.Vector3;
+    /**
+     * A normal that describes the direction of the ray from origin.
+     */
+    direction: Vector3.Vector3;
+}
+/**
+ * Creates a new ray with the given values, or using default values if none are
+ * provided. The direction defaults to `{x: 0, y: 0, z: -1}` if undefined.
+ *
+ * @param value The values of the ray.
+ * @returns A new ray.
+ */
+export declare function create(value?: Partial<Ray>): Ray;
+/**
+ * Returns a point at the given distance along this ray.
+ *
+ * @param ray The ray to get the point on.
+ * @param distance A distance from origin along the ray's direction.
+ * @returns A point on the ray.
+ */
+export declare function at(ray: Ray, distance: number): Vector3.Vector3;
+/**
+ * Computes the distance of the `ray`s origin to the given `plane`. Returns a
+ * distance of 0 if the ray is coplanar and returns `undefined` if the ray does
+ * not intersect with the plane.
+ *
+ * @param ray The ray to get the distance for.
+ * @param plane The plane to compute the distance to.
+ * @returns The distance to the plane, or `undefined` if it cannot be computed.
+ */
+export declare function distanceToPlane(ray: Ray, plane: Plane.Plane): number | undefined;
+/**
+ * Computes the intersection point of the given `ray` to the given `plane`. If
+ * the ray does not intersect with the plane, then `undefined` is returned.
+ *
+ * @param ray The ray to intersect.
+ * @param plane The plane to intersect with.
+ * @returns The intersection point, or `undefined` if the ray does not
+ * intersect.
+ */
+export declare function intersectPlane(ray: Ray, plane: Plane.Plane): Vector3.Vector3 | undefined;

package/dist/rectangle.d.ts

@@ -1,125 +1,125 @@
-import * as Dimensions from './dimensions';
-import * as Point from './point';
-/**
- * A `Rectangle` is an object with position and size.
- */
-export interface Rectangle {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-/**
- * Returns a new `Rectangle` with the given position and size.
- */
-export declare function create(x: number, y: number, width: number, height: number): Rectangle;
-/**
- * Returns a new `Rectangle` at the origin point and given size.
- */
-export declare function fromDimensions(dimensions: Dimensions.Dimensions): Rectangle;
-/**
- * Returns a new `Rectangle` with the given position and size.
- */
-export declare function fromPointAndDimensions(point: Point.Point, dimensions: Dimensions.Dimensions): Rectangle;
-/**
- * Returns a new `Rectangle` with the given top-left and bottom-right positions.
- * The returned rectangle will always returns a positive width and height.
- */
-export declare function fromPoints(topLeftPt: Point.Point, bottomRightPt: Point.Point): Rectangle;
-/**
- * Returns a rectangle where the longest length of `rect` will be equal to the
- * shortest length of `to`. The shortest length of `rect` will be proportionally
- * scaled to match the aspect ratio of `rect`. The returned rectangle will be
- * centered within `to`.
- *
- * @see {@link cropFit}
- */
-export declare function containFit(to: Rectangle, rect: Rectangle): Rectangle;
-/**
- * Returns a rectangle where the shortest length of `rect` will be equal to the
- * longest length of `to`. The longest length of `rect` will be proportionally
- * scaled to match the aspect ratio of `rect`. The returned rectangle will be
- * centered within `to`.
- *
- * @see {@link containFit}
- */
-export declare function cropFit(to: Rectangle, rect: Rectangle): Rectangle;
-/**
- * Returns a rectangle where each side of `rect` will be reduced proportionally
- * to have an area less than or equal to the provided `to` value. The returned
- * rectangle will be centered within the original bounds of `rect`.
- *
- * @param to - the maximum area this rectangle can have
- * @param rect - the rectangle to scale to fit the specified area
- */
-export declare function scaleFit(to: number, rect: Rectangle): Rectangle;
-/**
- * Returns a rectangle where the position and dimensions are scaled by the given
- * factors. If `scaleY` is omitted, then the position and dimensions are scaled
- * uniformly by `scaleOrScaleX`.
- *
- * @param rect The rectangle to scale.
- * @param scaleOrScaleX The uniform scale factor, or the horizontal scale
- *  factor.
- * @param scaleY The vertical scale factor.
- * @returns A scaled rectangle.
- */
-export declare function scale(rect: Rectangle, scaleOrScaleX: number, scaleY?: number): Rectangle;
-/**
- * Returns true if two rectangles are equal in position and size.
- */
-export declare function isEqual(a: Rectangle, b: Rectangle): boolean;
-/**
- * Returns a rectangle that has its position shifted by a given offset. The
- * size of the rectangle is unchanged.
- */
-export declare function offset(delta: Point.Point, rect: Rectangle): Rectangle;
-/**
- * Returns the area of the rectangle.
- */
-export declare function area(rect: Rectangle): number;
-/**
- * Returns the center point of the rectangle.
- */
-export declare function center(rect: Rectangle): Point.Point;
-/**
- * Returns the top-left position of the rectangle, as a point.
- */
-export declare function topLeft(rect: Rectangle): Point.Point;
-/**
- * Returns the bottom-right position of the rectangle, as a point.
- */
-export declare function bottomRight(rect: Rectangle): Point.Point;
-/**
- * Returns `true` if the given rectangle has a portrait aspect ratio.
- */
-export declare function isPortrait(rect: Rectangle): boolean;
-/**
- * Returns `true` if the given rectangle has a landscape aspect ratio.
- */
-export declare function isLandscape(rect: Rectangle): boolean;
-/**
- * Returns `true` if the given rectangle has a square aspect ratio.
- */
-export declare function isSquare(rect: Rectangle): boolean;
-/**
- * Pads a rectangle by the given amount, maintaining the center position.
- *
- * @param rect The rectangle to apply padding to.
- * @param padding The padding to add.
- */
-export declare function pad(rect: Rectangle, padding: number): Rectangle;
-/**
- * Returns `true` if the given rectangle contains all the given `points`.
- *
- * @param rect The rectangle to check against.
- * @param points The points to check.
- */
-export declare function containsPoints(rect: Rectangle, ...points: Point.Point[]): boolean;
-/**
- * Parses a JSON string representation of a Rectangle and returns an object.
- *
- * @param json A JSON string, either in the form `[x,y,width,height]` or `{"x": 0, "y": 0, "width": 10, "height": 10}`
- * @returns A parsed Point.
- */
-export declare function fromJson(json: string): Rectangle;
+import * as Dimensions from './dimensions';
+import * as Point from './point';
+/**
+ * A `Rectangle` is an object with position and size.
+ */
+export interface Rectangle {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/**
+ * Returns a new `Rectangle` with the given position and size.
+ */
+export declare function create(x: number, y: number, width: number, height: number): Rectangle;
+/**
+ * Returns a new `Rectangle` at the origin point and given size.
+ */
+export declare function fromDimensions(dimensions: Dimensions.Dimensions): Rectangle;
+/**
+ * Returns a new `Rectangle` with the given position and size.
+ */
+export declare function fromPointAndDimensions(point: Point.Point, dimensions: Dimensions.Dimensions): Rectangle;
+/**
+ * Returns a new `Rectangle` with the given top-left and bottom-right positions.
+ * The returned rectangle will always returns a positive width and height.
+ */
+export declare function fromPoints(topLeftPt: Point.Point, bottomRightPt: Point.Point): Rectangle;
+/**
+ * Returns a rectangle where the longest length of `rect` will be equal to the
+ * shortest length of `to`. The shortest length of `rect` will be proportionally
+ * scaled to match the aspect ratio of `rect`. The returned rectangle will be
+ * centered within `to`.
+ *
+ * @see {@link cropFit}
+ */
+export declare function containFit(to: Rectangle, rect: Rectangle): Rectangle;
+/**
+ * Returns a rectangle where the shortest length of `rect` will be equal to the
+ * longest length of `to`. The longest length of `rect` will be proportionally
+ * scaled to match the aspect ratio of `rect`. The returned rectangle will be
+ * centered within `to`.
+ *
+ * @see {@link containFit}
+ */
+export declare function cropFit(to: Rectangle, rect: Rectangle): Rectangle;
+/**
+ * Returns a rectangle where each side of `rect` will be reduced proportionally
+ * to have an area less than or equal to the provided `to` value. The returned
+ * rectangle will be centered within the original bounds of `rect`.
+ *
+ * @param to - the maximum area this rectangle can have
+ * @param rect - the rectangle to scale to fit the specified area
+ */
+export declare function scaleFit(to: number, rect: Rectangle): Rectangle;
+/**
+ * Returns a rectangle where the position and dimensions are scaled by the given
+ * factors. If `scaleY` is omitted, then the position and dimensions are scaled
+ * uniformly by `scaleOrScaleX`.
+ *
+ * @param rect The rectangle to scale.
+ * @param scaleOrScaleX The uniform scale factor, or the horizontal scale
+ *  factor.
+ * @param scaleY The vertical scale factor.
+ * @returns A scaled rectangle.
+ */
+export declare function scale(rect: Rectangle, scaleOrScaleX: number, scaleY?: number): Rectangle;
+/**
+ * Returns true if two rectangles are equal in position and size.
+ */
+export declare function isEqual(a: Rectangle, b: Rectangle): boolean;
+/**
+ * Returns a rectangle that has its position shifted by a given offset. The
+ * size of the rectangle is unchanged.
+ */
+export declare function offset(delta: Point.Point, rect: Rectangle): Rectangle;
+/**
+ * Returns the area of the rectangle.
+ */
+export declare function area(rect: Rectangle): number;
+/**
+ * Returns the center point of the rectangle.
+ */
+export declare function center(rect: Rectangle): Point.Point;
+/**
+ * Returns the top-left position of the rectangle, as a point.
+ */
+export declare function topLeft(rect: Rectangle): Point.Point;
+/**
+ * Returns the bottom-right position of the rectangle, as a point.
+ */
+export declare function bottomRight(rect: Rectangle): Point.Point;
+/**
+ * Returns `true` if the given rectangle has a portrait aspect ratio.
+ */
+export declare function isPortrait(rect: Rectangle): boolean;
+/**
+ * Returns `true` if the given rectangle has a landscape aspect ratio.
+ */
+export declare function isLandscape(rect: Rectangle): boolean;
+/**
+ * Returns `true` if the given rectangle has a square aspect ratio.
+ */
+export declare function isSquare(rect: Rectangle): boolean;
+/**
+ * Pads a rectangle by the given amount, maintaining the center position.
+ *
+ * @param rect The rectangle to apply padding to.
+ * @param padding The padding to add.
+ */
+export declare function pad(rect: Rectangle, padding: number): Rectangle;
+/**
+ * Returns `true` if the given rectangle contains all the given `points`.
+ *
+ * @param rect The rectangle to check against.
+ * @param points The points to check.
+ */
+export declare function containsPoints(rect: Rectangle, ...points: Point.Point[]): boolean;
+/**
+ * Parses a JSON string representation of a Rectangle and returns an object.
+ *
+ * @param json A JSON string, either in the form `[x,y,width,height]` or `{"x": 0, "y": 0, "width": 10, "height": 10}`
+ * @returns A parsed Point.
+ */
+export declare function fromJson(json: string): Rectangle;