@tspro/ts-utils-lib 1.20.0 → 1.21.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.21.0] - 2025-10-30
+### Added
+- Rect
+- AnchoredRect
+
+## Deprecated
+- DivRect (-> AnchoredRect)
+
 ## [1.20.0] - 2025-10-29
 ### Added
 - Guard.isNotThrowing(), Assert.isNotThrowing().

package/dist/index.d.mts

@@ -773,9 +773,65 @@ declare class Vec extends BaseContainer {
 }
 
 /**
- * DivRect class is a rectangle (left, top, right, bottom) with an anchor point (anchorX, anchorY).
+ * An immutable 2D rectangle defined by its top-left corner (x, y) and size (width, height).
+ * Provides geometric utilities like intersection, containment, scaling, etc.
  */
-declare class DivRect {
+declare class Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    constructor();
+    constructor(width: number, height: number);
+    constructor(x: number, y: number, width: number, height: number);
+    set(): Rect;
+    set(width: number, height: number): Rect;
+    set(x: number, y: number, width: number, height: number): Rect;
+    static fromPoints(p1: {
+        x: number;
+        y: number;
+    }, p2: {
+        x: number;
+        y: number;
+    }): Rect;
+    static fromCenter(cx: number, cy: number, width: number, height: number): Rect;
+    get left(): number;
+    get top(): number;
+    get right(): number;
+    get bottom(): number;
+    get centerX(): number;
+    get centerY(): number;
+    get center(): {
+        x: number;
+        y: number;
+    };
+    get area(): number;
+    get isEmpty(): boolean;
+    containsPoint(px: number, py: number): boolean;
+    containsRect(other: Rect): boolean;
+    intersects(other: Rect): boolean;
+    intersectionCopy(other: Rect): Rect;
+    unionCopy(other: Rect): Rect;
+    insetCopy(dx: number, dy: number): Rect;
+    inflateCopy(dx: number, dy: number): Rect;
+    offsetInPlace(dx: number, dy: number): Rect;
+    offsetCopy(dx: number, dy: number): Rect;
+    scaleInPlace(scaleX: number, scaleY?: number): Rect;
+    scaleCopy(scaleX: number, scaleY?: number): Rect;
+    roundCopy(): Rect;
+    floorCopy(): Rect;
+    ceilCopy(): Rect;
+    expandCopy(px: number, py: number): Rect;
+    equals(other: Rect): boolean;
+    clone(): Rect;
+    toString(): string;
+    toAnchoredRect(): AnchoredRect;
+}
+
+/**
+ * A mutable AnchoredRect class is a rectangle (left, top, right, bottom) with an anchor point (anchorX, anchorY).
+ */
+declare class AnchoredRect {
     left: number;
     anchorX: number;
     right: number;
@@ -807,6 +863,31 @@ declare class DivRect {
      * @param bottom - Bottom coordinate.
      */
     constructor(left: number, anchorX: number, right: number, top: number, anchorY: number, bottom: number);
+    /**
+     * Set rectangle with all zero values.
+     */
+    set(): AnchoredRect;
+    /**
+     * Set rectangle with left, right, top, bottom.
+     * Properties anchorX and anchorY will be centered in the middle.
+     *
+     * @param left - Left coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    set(left: number, right: number, top: number, bottom: number): AnchoredRect;
+    /**
+     * Set rectangle with full arguments.
+     *
+     * @param left - Left coordinate.
+     * @param anchorX - Center x-coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param anchorY - Center y-coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    set(left: number, anchorX: number, right: number, top: number, anchorY: number, bottom: number): AnchoredRect;
     /**
      * Create rect from basic left, top, width and height arguments.
      *
@@ -814,9 +895,9 @@ declare class DivRect {
      * @param top - Top coordinate.
      * @param width - Width.
      * @param height - Height.
-     * @returns - DivRect.
+     * @returns - AnchoredRect.
      */
-    static create(left: number, top: number, width: number, height: number): DivRect;
+    static create(left: number, top: number, width: number, height: number): AnchoredRect;
     /**
      * Create rect from anchorX, anchorY, width, height arguments.
      *
@@ -824,9 +905,9 @@ declare class DivRect {
      * @param centerY - Center y-coordinate.
      * @param width - Width.
      * @param height - Height.
-     * @returns - DivRect.
+     * @returns - AnchoredRect.
      */
-    static createCentered(centerX: number, centerY: number, width: number, height: number): DivRect;
+    static createCentered(centerX: number, centerY: number, width: number, height: number): AnchoredRect;
     /**
      * Create rect from sections.
      *
@@ -834,29 +915,17 @@ declare class DivRect {
      * @param rightw - Right section width.
      * @param toph - Top section height.
      * @param bottomh - Bottomsection height.
-     * @returns - DivRect.
+     * @returns - AnchoredRect.
      */
-    static createSections(leftw: number, rightw: number, toph: number, bottomh: number): DivRect;
+    static createSections(leftw: number, rightw: number, toph: number, bottomh: number): AnchoredRect;
     /**
-     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
-     * @private
-     * */
+     * Get center x-coordinate.
+     */
     get centerX(): number;
     /**
-     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
-     * @private
-     * */
-    set centerX(x: number);
-    /**
-     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
-     * @private
-     * */
+     * Get center ycoordinate.
+     */
     get centerY(): number;
-    /**
-     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
-     * @private
-     * */
-    set centerY(y: number);
     /**
      * Width getter.
      */
@@ -892,123 +961,118 @@ declare class DivRect {
     /**
      * Do a and b rects overlap?
      *
-     * @param a - DivRect a.
-     * @param b - DivRect b.
+     * @param a - AnchoredRect a.
+     * @param b - AnchoredRect b.
      * @returns - True/false.
      */
-    static overlap(a: DivRect, b: DivRect): boolean;
+    static overlap(a: AnchoredRect, b: AnchoredRect): boolean;
     /**
      * Do horizontal measures of a and b rects overlap?
      *
-     * @param a - DivRect a.
-     * @param b - DivRect b.
+     * @param a - AnchoredRect a.
+     * @param b - AnchoredRect b.
      * @returns - True/false.
      */
-    static overlapX(a: DivRect, b: DivRect): boolean;
+    static overlapX(a: AnchoredRect, b: AnchoredRect): boolean;
     /**
      * Check if given rects are equal.
-     * @param a - DivRect a.
-     * @param b - DivRect b.
+     * @param a - AnchoredRect a.
+     * @param b - AnchoredRect b.
      * @returns - True/false.
      */
-    static equals(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    static equals(a: AnchoredRect | null | undefined, b: AnchoredRect | null | undefined): boolean;
     /**
      * Check if this rect equals with another rect.
      * @param other - The other rect.
      * @returns - True/false.
      */
-    equals(other: DivRect): boolean;
+    equals(other: AnchoredRect): boolean;
     /**
      * Check if edges of given rects are equal, ignoring anchorX and anchorY.
      *
-     * @param a - DivRect a.
-     * @param b - DivRect b.
+     * @param a - AnchoredRect a.
+     * @param b - AnchoredRect b.
      * @returns - True/false.
      */
-    static equalsEdges(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    static equalsEdges(a: AnchoredRect | null | undefined, b: AnchoredRect | null | undefined): boolean;
     /**
      * Check if edges of this Rect equals with given Rect, ignoring anchorX and anchorY.
      *
-     * @param other - The other DivRect.
+     * @param other - The other AnchoredRect.
      * @returns - True/false.
      */
-    equalsEdges(other: DivRect): boolean;
-    /**
-     * @deprecated - Use `DivRect.equalsEdges()` instead. Will be removed in v2.0.0.
-     * @private
-     */
-    static equalsFrame(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    equalsEdges(other: AnchoredRect): boolean;
     /**
      * Created duplicate of this Rect.
-     *
      * @returns - Duplicate.
      */
-    copy(): DivRect;
+    clone(): AnchoredRect;
     /**
      * Move this rect by (dx, dy). Modifies this Rect.
      *
      * @param dx - Offset amount in x-direction.
      * @param dy - Offset amount in y-direction.
-     * @returns - This DivRect instance.
+     * @returns - This AnchoredRect instance.
      */
-    offsetInPlace(dx: number, dy: number): DivRect;
+    offsetInPlace(dx: number, dy: number): AnchoredRect;
     /**
      * Move this rect by (dx, dy). Immutable, returns modified copy.
      *
      * @param dx - Offset amount in x-direction.
      * @param dy - Offset amount in y-direction.
-     * @returns - DivRect copy with applied offset.
+     * @returns - AnchoredRect copy with applied offset.
      */
-    offsetCopy(dx: number, dy: number): DivRect;
+    offsetCopy(dx: number, dy: number): AnchoredRect;
     /**
      * Expand this Rect by given Rect. Modifies this Rect.
      *
-     * @param rect - DivRect to expand this instance with.
-     * @returns - This DivRect instance.
+     * @param rect - AnchoredRect to expand this instance with.
+     * @returns - This AnchoredRect instance.
      */
-    expandInPlace(rect: DivRect): DivRect;
+    expandInPlace(rect: AnchoredRect): AnchoredRect;
     /**
      * Expand this Rect by given Rect. Immutable, returns modified copy.
      *
-     * @param rect - DivRect to expand this instance with.
-     * @returns - Expanded copy of this DivRect.
+     * @param rect - AnchoredRect to expand this instance with.
+     * @returns - Expanded copy of this AnchoredRect.
      */
-    expandCopy(rect: DivRect): DivRect;
+    expandCopy(rect: AnchoredRect): AnchoredRect;
     /**
      * Clip this Rect by given Rect. Mmodifies this Rect.
      *
-     * @param clipRect - DivRect to clip this instance with.
-     * @returns - This DivRect instance.
+     * @param clipRect - AnchoredRect to clip this instance with.
+     * @returns - This AnchoredRect instance.
      */
-    clipInPlace(clipRect: DivRect): DivRect;
+    clipInPlace(clipRect: AnchoredRect): AnchoredRect;
     /**
      * Clip this Rect by given Rect. Immutable, return modified copy.
      *
-     * @param clipRect - DivRecto to clip this instance with.
-     * @returns - Clipped DivRect copy.
+     * @param clipRect - AnchoredRecto to clip this instance with.
+     * @returns - Clipped AnchoredRect copy.
      */
-    clipCopy(clipRect: DivRect): DivRect;
+    clipCopy(clipRect: AnchoredRect): AnchoredRect;
     /**
      * Scale Rect. Anchor pos is (anchorX, anchorY). Modifies this Rect.
      *
      * @param scaleX - Scale x-amount.
      * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
-     * @returns This DivRect instance.
+     * @returns This AnchoredRect instance.
      */
-    scaleInPlace(scaleX: number, scaleY?: number): DivRect;
+    scaleInPlace(scaleX: number, scaleY?: number): AnchoredRect;
     /**
      * Scale Rect. Anchor pos is (anchorX, anchorY). Immutable, returns modified copy.
      *
      * @param scaleX - Scale x-amount.
      * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
-     * @returns Scaled copy of this DivRect.
+     * @returns Scaled copy of this AnchoredRect.
      */
-    scaleCopy(scaleX: number, scaleY?: number): DivRect;
+    scaleCopy(scaleX: number, scaleY?: number): AnchoredRect;
     /**
-     * Get this DivRect instance.
-     * @returns - This DivRect instance.
+     * Get this AnchoredRect instance.
+     * @returns - This AnchoredRect instance.
      */
-    getRect(): DivRect;
+    getRect(): AnchoredRect;
+    toRect(): Rect;
 }
 
 /**
@@ -1737,4 +1801,276 @@ declare class DeepSet<VALUE> extends SetBase<VALUE, DeepSet<VALUE>> {
     protected valueEquals(a: VALUE, b: VALUE): boolean;
 }
 
-export { index$7 as Assert, BaseContainer, BiMap, cookies as Cookies, DeepSet, DefaultArray, DefaultEqualityFn, device as Device, DivRect, type EqualityFn, Guard, IndexArray, type KVComponent, LRUCache, LinkedList, Map1, Map2, Map3, MultiContainer, Set1, SetBase, SignedIndexArray, SmallIntCache, Stack, TriMap, UniMap, index as Utils, ValueSet, Vec, Vec2, asMulti };
+/**
+ * @deprecated - Use {@link AnchoredRect} instead. Will be removed in v2.0.0.
+ * @private
+ *
+ * A mutable DivRect class is a rectangle (left, top, right, bottom) with an anchor point (anchorX, anchorY).
+ */
+declare class DivRect {
+    left: number;
+    anchorX: number;
+    right: number;
+    top: number;
+    anchorY: number;
+    bottom: number;
+    /**
+     * Create rectangle with all zero values.
+     */
+    constructor();
+    /**
+     * Create rectangle with left, right, top, bottom.
+     * Properties anchorX and anchorY will be centered in the middle.
+     *
+     * @param left - Left coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    constructor(left: number, right: number, top: number, bottom: number);
+    /**
+     * Create rectangle with full arguments.
+     *
+     * @param left - Left coordinate.
+     * @param anchorX - Center x-coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param anchorY - Center y-coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    constructor(left: number, anchorX: number, right: number, top: number, anchorY: number, bottom: number);
+    /**
+     * Set rectangle with all zero values.
+     */
+    set(): DivRect;
+    /**
+     * Set rectangle with left, right, top, bottom.
+     * Properties anchorX and anchorY will be centered in the middle.
+     *
+     * @param left - Left coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    set(left: number, right: number, top: number, bottom: number): DivRect;
+    /**
+     * Set rectangle with full arguments.
+     *
+     * @param left - Left coordinate.
+     * @param anchorX - Center x-coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param anchorY - Center y-coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    set(left: number, anchorX: number, right: number, top: number, anchorY: number, bottom: number): DivRect;
+    /**
+     * Create rect from basic left, top, width and height arguments.
+     *
+     * @param left - Left coordinate.
+     * @param top - Top coordinate.
+     * @param width - Width.
+     * @param height - Height.
+     * @returns - DivRect.
+     */
+    static create(left: number, top: number, width: number, height: number): DivRect;
+    /**
+     * Create rect from anchorX, anchorY, width, height arguments.
+     *
+     * @param centerX - Center x-coordinate.
+     * @param centerY - Center y-coordinate.
+     * @param width - Width.
+     * @param height - Height.
+     * @returns - DivRect.
+     */
+    static createCentered(centerX: number, centerY: number, width: number, height: number): DivRect;
+    /**
+     * Create rect from sections.
+     *
+     * @param leftw - Left section width.
+     * @param rightw - Right section width.
+     * @param toph - Top section height.
+     * @param bottomh - Bottomsection height.
+     * @returns - DivRect.
+     */
+    static createSections(leftw: number, rightw: number, toph: number, bottomh: number): DivRect;
+    /**
+     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
+     * @private
+     * */
+    get centerX(): number;
+    /**
+     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
+     * @private
+     * */
+    set centerX(x: number);
+    /**
+     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
+     * @private
+     * */
+    get centerY(): number;
+    /**
+     * @deprecated - Renamed to anchorX. Will be removed in v2.0.0.
+     * @private
+     * */
+    set centerY(y: number);
+    /**
+     * Width getter.
+     */
+    get width(): number;
+    /**
+     * Height getter.
+     */
+    get height(): number;
+    /**
+     * Left section width getter.
+     */
+    get leftw(): number;
+    /**
+     * Right section width getter.
+     */
+    get rightw(): number;
+    /**
+     * Top section height getter.
+     */
+    get toph(): number;
+    /**
+     * Bottom section height getter.
+     */
+    get bottomh(): number;
+    /**
+     * Does this Rect contain given (x, y)-point?
+     *
+     * @param x - X-coordinate.
+     * @param y - Y-coordinate.
+     * @returns - True/false.
+     */
+    contains(x: number, y: number): boolean;
+    /**
+     * Do a and b rects overlap?
+     *
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static overlap(a: DivRect, b: DivRect): boolean;
+    /**
+     * Do horizontal measures of a and b rects overlap?
+     *
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static overlapX(a: DivRect, b: DivRect): boolean;
+    /**
+     * Check if given rects are equal.
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static equals(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    /**
+     * Check if this rect equals with another rect.
+     * @param other - The other rect.
+     * @returns - True/false.
+     */
+    equals(other: DivRect): boolean;
+    /**
+     * Check if edges of given rects are equal, ignoring anchorX and anchorY.
+     *
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static equalsEdges(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    /**
+     * Check if edges of this Rect equals with given Rect, ignoring anchorX and anchorY.
+     *
+     * @param other - The other DivRect.
+     * @returns - True/false.
+     */
+    equalsEdges(other: DivRect): boolean;
+    /**
+     * @deprecated - Use {@link equalsEdges()} instead. Will be removed in v2.0.0.
+     * @private
+     */
+    static equalsFrame(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    /**
+     * @deprecated - Use {@link clone()} instead. Will be removed in v2.0.0.
+     * @private
+     */
+    copy(): DivRect;
+    /**
+     * Created duplicate of this Rect.
+     * @returns - Duplicate.
+     */
+    clone(): DivRect;
+    /**
+     * Move this rect by (dx, dy). Modifies this Rect.
+     *
+     * @param dx - Offset amount in x-direction.
+     * @param dy - Offset amount in y-direction.
+     * @returns - This DivRect instance.
+     */
+    offsetInPlace(dx: number, dy: number): DivRect;
+    /**
+     * Move this rect by (dx, dy). Immutable, returns modified copy.
+     *
+     * @param dx - Offset amount in x-direction.
+     * @param dy - Offset amount in y-direction.
+     * @returns - DivRect copy with applied offset.
+     */
+    offsetCopy(dx: number, dy: number): DivRect;
+    /**
+     * Expand this Rect by given Rect. Modifies this Rect.
+     *
+     * @param rect - DivRect to expand this instance with.
+     * @returns - This DivRect instance.
+     */
+    expandInPlace(rect: DivRect): DivRect;
+    /**
+     * Expand this Rect by given Rect. Immutable, returns modified copy.
+     *
+     * @param rect - DivRect to expand this instance with.
+     * @returns - Expanded copy of this DivRect.
+     */
+    expandCopy(rect: DivRect): DivRect;
+    /**
+     * Clip this Rect by given Rect. Mmodifies this Rect.
+     *
+     * @param clipRect - DivRect to clip this instance with.
+     * @returns - This DivRect instance.
+     */
+    clipInPlace(clipRect: DivRect): DivRect;
+    /**
+     * Clip this Rect by given Rect. Immutable, return modified copy.
+     *
+     * @param clipRect - DivRecto to clip this instance with.
+     * @returns - Clipped DivRect copy.
+     */
+    clipCopy(clipRect: DivRect): DivRect;
+    /**
+     * Scale Rect. Anchor pos is (anchorX, anchorY). Modifies this Rect.
+     *
+     * @param scaleX - Scale x-amount.
+     * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
+     * @returns This DivRect instance.
+     */
+    scaleInPlace(scaleX: number, scaleY?: number): DivRect;
+    /**
+     * Scale Rect. Anchor pos is (anchorX, anchorY). Immutable, returns modified copy.
+     *
+     * @param scaleX - Scale x-amount.
+     * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
+     * @returns Scaled copy of this DivRect.
+     */
+    scaleCopy(scaleX: number, scaleY?: number): DivRect;
+    /**
+     * Get this DivRect instance.
+     * @returns - This DivRect instance.
+     */
+    getRect(): DivRect;
+    toRect(): Rect;
+}
+
+export { AnchoredRect, index$7 as Assert, BaseContainer, BiMap, cookies as Cookies, DeepSet, DefaultArray, DefaultEqualityFn, device as Device, DivRect, type EqualityFn, Guard, IndexArray, type KVComponent, LRUCache, LinkedList, Map1, Map2, Map3, MultiContainer, Rect, Set1, SetBase, SignedIndexArray, SmallIntCache, Stack, TriMap, UniMap, index as Utils, ValueSet, Vec, Vec2, asMulti };