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

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;