editor › Globals › RasterizingPolygonClipper

Class: RasterizingPolygonClipper

Hierarchy

• RasterizingPolygonClipper

Index

Methods

• booleanOperation
• difference
• intersection
• union

Methods

booleanOperation

▸ booleanOperation(polyA: Polygon, polyB: Polygon, operation: function, pixelBudget: number): RasterizedPolygon

Defined in src/util/polygon/RasterizingPolygonClipper.ts:27

Applies a binary operation to the two polygon rasterization. Returns null if there is no intersection which may happen because there is actually no intersection or due to a too low pixelBudget.

Parameters:

▪ polyA: Polygon

-

▪ polyB: Polygon

-

▪ operation: function

-

▸ (a: boolean, b: boolean): boolean

Parameters:

Name	Type
a	boolean
b	boolean

▪Default value pixelBudget: number= 100

-

Returns: RasterizedPolygon

---

difference

▸ difference(polyA: Polygon, polyB: Polygon, pixelBudget?: number): RasterizedPolygon

Defined in src/util/polygon/RasterizingPolygonClipper.ts:15

Parameters:

Name	Type
polyA	Polygon
polyB	Polygon
pixelBudget?	number

Returns: RasterizedPolygon

---

intersection

▸ intersection(polyA: Polygon, polyB: Polygon, pixelBudget?: number): RasterizedPolygon

Defined in src/util/polygon/RasterizingPolygonClipper.ts:7

Parameters:

Name	Type
polyA	Polygon
polyB	Polygon
pixelBudget?	number

Returns: RasterizedPolygon

---

union

▸ union(polyA: Polygon, polyB: Polygon, pixelBudget?: number): RasterizedPolygon

Defined in src/util/polygon/RasterizingPolygonClipper.ts:11

Parameters:

Name	Type
polyA	Polygon
polyB	Polygon
pixelBudget?	number

Returns: RasterizedPolygon