Class WeilerAthertonClipper

constructor

• new WeilerAthertonClipper(
      polygon: Polygon,
      clipObject: Rectangle | Circle,
      clipType: number,
      clipOpts: object,
  ): WeilerAthertonClipper

  Construct a WeilerAthertonClipper instance used to perform the calculation.

  Parameters

  • polygon: Polygon

    Polygon to clip

  • clipObject: Rectangle | Circle

    Object used to clip the polygon

  • clipType: number

    Type of clip to use

  • clipOpts: object

    Object passed to the clippingObject methods toPolygon and pointsBetween

  Returns WeilerAthertonClipper

clipObject

config

polygon

StaticCLIP_TYPES

StaticINTERSECTION_TYPES

Staticcombine

• combine(
      polygon: Polygon,
      clipObject: Rectangle | Circle,
      options?: { canMutate?: boolean; clipType: number },
  ): Polygon[]

  Clip a given clipObject using the Weiler-Atherton algorithm.

  At the moment, this will return a single PIXI.Polygon in the array unless clipType is a union and the polygon and clipObject do not overlap, in which case the [polygon, clipObject.toPolygon()] array will be returned. If this algorithm is expanded in the future to handle holes, an array of polygons may be returned.

  Parameters

  • polygon: Polygon

    Polygon to clip

  • clipObject: Rectangle | Circle

    Object to clip against the polygon

  • options: { canMutate?: boolean; clipType: number } = {}

    Options which configure how the union or intersection is computed

    • OptionalcanMutate?: boolean

      If the WeilerAtherton constructor could mutate or not the subject polygon points

      • Any additional properties in options (besides clipType and canMutate) are captured by the rest operator (...clipOpts) and passed to the WeilerAthertonClipper constructor.

    • clipType: number

      One of foundry.canvas.geometry.WeilerAthertonClipper.CLIP_TYPES

  Returns Polygon[]

  Array of polygons and clipObjects

Staticintersect

• intersect(
      polygon: Polygon,
      clipObject: Rectangle | Circle,
      clipOpts?: object,
  ): Polygon[]

  Intersect a polygon and clipObject using the Weiler Atherton algorithm.

  Parameters

  • polygon: Polygon

    Polygon to clip

  • clipObject: Rectangle | Circle

    Object to clip against the polygon

  • clipOpts: object = {}

    Options passed to the clipping object methods toPolygon and pointsBetween

  Returns Polygon[]

StatictestForEnvelopment

• testForEnvelopment(
      polygon: Polygon,
      clipObject: Rectangle | Circle,
      clipType: Readonly<{ INTERSECT: 0; UNION: 1 }>,
      clipOpts: object,
  ): Polygon[]

  Test if one shape envelops the other. Assumes the shapes do not intersect.

  1. Polygon is contained within the clip object. Union: clip object; Intersect: polygon
  2. Clip object is contained with polygon. Union: polygon; Intersect: clip object
  3. Polygon and clip object are outside one another. Union: both; Intersect: null

  Parameters

  • polygon: Polygon

    Polygon to clip

  • clipObject: Rectangle | Circle

    Object to clip against the polygon

  • clipType: Readonly<{ INTERSECT: 0; UNION: 1 }>

    One of CLIP_TYPES

  • clipOpts: object

    Clip options which are forwarded to toPolygon methods

  Returns Polygon[]

  Returns the polygon, the clipObject.toPolygon(), both, or neither.

Staticunion

• union(
      polygon: Polygon,
      clipObject: Rectangle | Circle,
      clipOpts?: object,
  ): Polygon[]

  Union a polygon and clipObject using the Weiler Atherton algorithm.

  Parameters

  • polygon: Polygon

    Polygon to clip

  • clipObject: Rectangle | Circle

    Object to clip against the polygon

  • clipOpts: object = {}

    Options passed to the clipping object methods toPolygon and pointsBetween

  Returns Polygon[]