@league-of-foundry-developers/foundry-vtt-types 12.331.2-beta → 12.331.4-beta

package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial, ValueOf } from "../../../../types/utils.d.mts";
+import type { Brand, Identity, NullishProps } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -15,6 +15,9 @@ declare global {
    * https://en.wikipedia.org/wiki/Weiler%E2%80%93Atherton_clipping_algorithm
    * https://www.geeksforgeeks.org/weiler-atherton-polygon-clipping-algorithm
    * https://h-educate.in/weiler-atherton-polygon-clipping-algorithm/
+   *
+   * @throws If `!Polygon.isPositive`
+   * @remarks In practice the only thing that uses the constructor is the class's static methods
    */
   class WeilerAthertonClipper {
     /**
@@ -29,7 +32,7 @@ declare global {
     constructor(
       polygon: PIXI.Polygon,
       clipObject: PIXI.Rectangle | PIXI.Circle,
-      clipType?: ValueOf<(typeof WeilerAthertonClipper)["CLIP_TYPES"]>,
+      clipType?: WeilerAthertonClipper.CLIP_TYPES,
       clipOpts?: WeilerAthertonClipper.ClipOpts,
     );
 
@@ -37,19 +40,12 @@ declare global {
      * The supported clip types.
      * Values are equivalent to those in ClipperLib.ClipType.
      */
-    static readonly CLIP_TYPES: Readonly<{
-      INTERSECT: 0;
-      UNION: 1;
-    }>;
+    static CLIP_TYPES: WeilerAthertonClipper.ClipTypes;
 
     /**
      * The supported intersection types.
      */
-    static readonly INTERSECTION_TYPES: Readonly<{
-      OUT_IN: -1;
-      IN_OUT: 1;
-      TANGENT: 0;
-    }>;
+    static INTERSECTION_TYPES: WeilerAthertonClipper.IntersectionTypes;
 
     polygon: PIXI.Polygon;
 
@@ -57,15 +53,8 @@ declare global {
 
     /**
      * Configuration settings
-     * @param clipType  - One of CLIP_TYPES
-     * @param clipOpts  - Object passed to the clippingObject methods
-     *                    toPolygon and pointsBetween
-     * @defaultValue `{}`
      */
-    config: {
-      clipType?: typeof WeilerAthertonClipper.CLIP_TYPES;
-      clipOpts?: WeilerAthertonClipper.ClipOpts;
-    };
+    config: WeilerAthertonClipper.Config;
 
     /**
      * Union a polygon and clipObject using the Weiler Atherton algorithm.
@@ -77,7 +66,7 @@ declare global {
     static union(
       polygon: PIXI.Polygon,
       clipObject: PIXI.Rectangle | PIXI.Circle,
-      clipOpts: WeilerAthertonClipper.ClipOpts,
+      clipOpts?: WeilerAthertonClipper.ClipOpts,
     ): PIXI.Polygon[];
 
     /**
@@ -90,7 +79,7 @@ declare global {
     static intersect(
       polygon: PIXI.Polygon,
       clipObject: PIXI.Rectangle | PIXI.Circle,
-      clipOpts: WeilerAthertonClipper.ClipOpts,
+      clipOpts?: WeilerAthertonClipper.ClipOpts,
     ): PIXI.Polygon[];
 
     /**
@@ -108,23 +97,8 @@ declare global {
     static combine(
       polygon: PIXI.Polygon,
       clipObject: PIXI.Rectangle | PIXI.Circle,
-      options?: InexactPartial<{
-        /**
-         * One of CLIP_TYPES
-         * @defaultValue `0`
-         */
-        clipType: ValueOf<typeof WeilerAthertonClipper.CLIP_TYPES>;
-
-        /**
-         * If the WeilerAtherton constructor could mutate or not the subject polygon points
-         */
-        canMutate: boolean;
-
-        /**
-         * Options passed to the WeilerAthertonClipper constructor
-         */
-        clipOpts: WeilerAthertonClipper.ClipOpts;
-      }>,
+      /** @remarks Despite foundry marking this parameter optional, if an object with a valid `clipType` property is not passed, this will throw */
+      options: WeilerAthertonClipper.CombineOptions,
     ): PIXI.Polygon[];
 
     /**
@@ -141,12 +115,76 @@ declare global {
     static testForEnvelopment(
       polygon: PIXI.Polygon,
       clipObject: PIXI.Rectangle | PIXI.Circle,
-      clipType: typeof WeilerAthertonClipper.CLIP_TYPES,
+      clipType: WeilerAthertonClipper.CLIP_TYPES,
       clipOpts: WeilerAthertonClipper.ClipOpts,
     ): PIXI.Polygon[];
   }
 
   namespace WeilerAthertonClipper {
+    interface Any extends AnyWeilerAthertonClipper {}
+    interface AnyConstructor extends Identity<typeof AnyWeilerAthertonClipper> {}
+
+    type CLIP_TYPES = Brand<number, "WeilerAthertonClipper.CLIP_TYPES">;
+
+    interface ClipTypes {
+      readonly INTERSECT: 0 & CLIP_TYPES;
+      readonly UNION: 1 & CLIP_TYPES;
+    }
+
+    type INTERSECTION_TYPES = Brand<number, "WeilerAthertonClipper.INTERSECTION_TYPES">;
+
+    interface IntersectionTypes {
+      readonly OUT_IN: -1 & INTERSECTION_TYPES;
+      readonly IN_OUT: 1 & INTERSECTION_TYPES;
+      readonly TANGENT: 0 & INTERSECTION_TYPES;
+    }
+
+    /** Configuration settings */
+    interface Config {
+      /**
+       * One of CLIP_TYPES
+       * @defaultValue `WeilerAthertonClipper.CLIP_TYPES.INTERSECT`
+       * @remarks Set to the value of the equivalent constructor parameter. Default provided by `??=` in the constructor body
+       */
+      clipType: WeilerAthertonClipper.CLIP_TYPES;
+
+      /**
+       * Object passed to the clippingObject methods `toPolygon` and `pointsBetween`
+       * @defaultValue `{}`
+       * @remarks Set to the value of the equivalent constructor parameter. Default provided by `??=` in the constructor body
+       */
+      clipOpts: WeilerAthertonClipper.ClipOpts;
+    }
+
+    /**
+     * @internal
+     * @privateRemarks does *not* contain:
+     * - a `scalingFactor` property, despite one being passed in `PIXI.Rectangle#intersectPolygon` in v12
+     * - a `density` property, despite one being passed in `PIXI.Circle#intersectPolygon` in v12
+     */
+    type _CombineOptions = NullishProps<{
+      /**
+       * If the WeilerAtherton constructor could mutate or not the subject polygon points
+       */
+      canMutate: boolean;
+    }>;
+
+    interface CombineOptions extends _CombineOptions, ClipOpts {
+      /**
+       * One of CLIP_TYPES
+       */
+      clipType: WeilerAthertonClipper.CLIP_TYPES;
+    }
+
+    /**
+     * @remarks These are ultimately only consumed by the `#toPolygon` and `#pointsBetween` methods
+     * of `PIXI.Rectangle` or `PIXI.Circle`. Only the `Circle` methods actually take options and those are
+     * only passed on to `#pointsForArc`.
+     */
     type ClipOpts = PIXI.Circle.PointsForArcOptions;
   }
 }
+
+declare abstract class AnyWeilerAthertonClipper extends WeilerAthertonClipper {
+  constructor(...args: never);
+}