Class PolygonTree

A polygon tree.

Hierarchy (View Summary)

PolygonTreeNode
- PolygonTree

Constructors

constructor

new PolygonTree(): PolygonTree
Create a PolygonTree.

Returns PolygonTree
Overrides PolygonTreeNode.constructor

Accessors

area

get area(): number
The area of this node.

Returns number
Inherited from PolygonTreeNode.area

bounds

get bounds(): Rectangle
The bounds of the polygon, or the combined bounds of all children in case of the root node.

The value of this property must not be mutated.

Returns Rectangle
Inherited from PolygonTreeNode.bounds

children

get children(): readonly PolygonTreeNode[]
The children of this node.

The value of this property must not be mutated.

Returns readonly PolygonTreeNode[]
Inherited from PolygonTreeNode.children

clipperPath

get clipperPath(): readonly DeepReadonly<types.ClipperPoint>[] | null
The Clipper path of this node. It is empty in case of the root node.

The value of this property must not be mutated.

Returns readonly DeepReadonly<types.ClipperPoint>[] | null
Inherited from PolygonTreeNode.clipperPath

clipperPaths

get clipperPaths(): readonly (readonly DeepReadonly<types.ClipperPoint>[])[]
The Clipper paths of this polygon tree.

The value of this property must not be mutated.

Returns readonly (readonly DeepReadonly<types.ClipperPoint>[])[]

depth

get depth(): number
The depth of this node. The depth of the root node is 0.

Returns number
Inherited from PolygonTreeNode.depth

isEmpty

get isEmpty(): boolean
Is the (sub)tree empty?

Returns boolean
Inherited from PolygonTreeNode.isEmpty

isHole

get isHole(): boolean
Is this a hole? The root node is a hole.

Returns boolean
Inherited from PolygonTreeNode.isHole

parent

get parent(): PolygonTreeNode | null
The parent of this node or null if this is the root node.

Returns PolygonTreeNode | null
Inherited from PolygonTreeNode.parent

path

get path(): readonly Point[] | null
The path of the polygon ([{x: x0, y: y0}, {x: x1, y: y1}, ...]). They are null in case of the root node.

The value of this property must not be mutated.

Returns readonly Point[] | null
Inherited from PolygonTreeNode.path

points

get points(): readonly number[] | null
The points of the polygon ([x0, y0, x1, y1, ...]). They are null in case of the root node.

The value of this property must not be mutated.

Returns readonly number[] | null
Inherited from PolygonTreeNode.points

polygon

get polygon(): Polygon | null
The polygon of this node. It is null in case of the root node.

The value of this property must not be mutated.

Returns Polygon | null
Inherited from PolygonTreeNode.polygon

polygons

get polygons(): readonly Polygon[]
The polygons of this polygon tree.

The value of this property must not be mutated.

Returns readonly Polygon[]

triangulation

get triangulation(): Readonly<
{ indices: Uint16Array
| Uint32Array; vertices: Float32Array },
>
The triangulation of this polygon tree.

The value of this property must not be mutated.

Returns Readonly<{ indices: Uint16Array | Uint32Array; vertices: Float32Array }>

Methods

[iterator]

"[iterator]"(): Generator<PolygonTreeNode, any, any>
Iterate over recursively over the children in depth-first order.

Returns Generator<PolygonTreeNode, any, any>
Yields
Inherited from PolygonTreeNode.[iterator]

drawShape

drawShape(graphics: Graphics): void
Draw the polygon tree into the Graphics element.
Parameters
- graphics: Graphics
  The Graphics element.
Returns void

findClosestPoint

findClosestPoint(point: Point): Point
Find a point inside this polygon tree that is closest to the given reference point.
Parameters
- point: Point
  The reference point.
Returns Point
The closest point to the reference point in the polygon tree.

Inherited from PolygonTreeNode.findClosestPoint

findContainingNode

findContainingNode(point: Point): PolygonTreeNode | null
Find the node in this (sub)tree that contains the given point.
Parameters
- point: Point
  The point.
Returns PolygonTreeNode | null
The (sub)node that contains the point, if any. Cannot return null for PolygonTree; instead the root node (the tree itself) is returned.

Inherited from PolygonTreeNode.findContainingNode

intersectClipper

intersectClipper(
path: types.ClipperPoint[],
options?: { clipType?: number; fillType?: number },
): PolygonTree
Compute the intersection of the polygon tree with the given Clipper path.
Parameters
- path: types.ClipperPoint[]
  The Clipper path to intersect the polygon tree with (the scaling factor must be CONST.CLIPPER_SCALING_FACTOR).
- Optionaloptions: { clipType?: number; fillType?: number } = {}
  Additional options.
  - OptionalclipType?: number
    The Clipper clip type. Default: ClipperLib.ClipType.ctIntersection.
  - OptionalfillType?: number
    The Clipper fill type used for the Clipper path. Default: ClipperLib.PolyFillType.pftEvenOdd.
Returns PolygonTree
The result of the intersection.

intersectPolygon

intersectPolygon(
polygon: Polygon,
options?: { clipType?: number; fillType?: number },
): PolygonTree
Compute the intersection of the polygon tree with the given polygon.
Parameters
- polygon: Polygon
  The polygon to intersect the polygon tree with.
- Optionaloptions: { clipType?: number; fillType?: number }
  Additional options.
  - OptionalclipType?: number
    The Clipper clip type. Default: ClipperLib.ClipType.ctIntersection.
  - OptionalfillType?: number
    The Clipper fill type used for the polygon. Default: ClipperLib.PolyFillType.pftEvenOdd.
Returns PolygonTree
The result of the intersection.

testCircle

testCircle(center: Point, radius: number): -1 | 0 | 1
Test circle containment/intersection with this (sub)tree.
Parameters
- center: Point
  The center point of the circle.
- radius: number
  The radius of the circle.
Returns -1 | 0 | 1
- -1: the circle is in the exterior and does not intersect the boundary. - 0: the circle is intersects the boundary. - 1: the circle is in the interior and does not intersect the boundary.
Inherited from PolygonTreeNode.testCircle

testPoint

testPoint(point: Point, distance?: number): boolean
Test whether given point is contained within this (sub)tree. If distance is is nonzero, true is returned if and only if the signed distance from the point to the boundary of the (sub)tree is less than or equal to distance. The signed distance is positive for points in the exterior of the (sub)tree and negative for points within the interior of the (sub)tree.
Parameters
- point: Point
  The point.
- Optionaldistance: number = 0
  The tolerance of the containment test.
Returns boolean
Example: Test whether the point (x, y) is contained within the polygon tree
```
polygonTree.testPoint({x, y}, r);
```
Example: Test whether the circle at (x, y) with radius r (positive) intersects the polygon tree
```
polygonTree.testPoint({x, y}, r);
```
Example: Test whether the circle at (x, y) with radius r (positive) is contained within the polygon tree
```
polygonTree.testPoint({x, y}, -r);
```
Inherited from PolygonTreeNode.testPoint

`Static`_fromClipperPath

_fromClipperPath(
clipperPath: types.ClipperPoint[],
parent: PolygonTreeNode | null,
): PolygonTreeNode
Internal
Create a node from the Clipper path and add it to the children of the parent.
Parameters
- clipperPath: types.ClipperPoint[]
  The clipper path of this node.
- parent: PolygonTreeNode | null
  The parent node or null if root.
Returns PolygonTreeNode
Inherited from PolygonTreeNode._fromClipperPath

`Static`fromClipperPolyTree

fromClipperPolyTree(clipperPolyTree: PolyTree): PolygonTree
Create the tree from a Clipper polygon tree.
Parameters
- clipperPolyTree: PolyTree
Returns PolygonTree

Class PolygonTree

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns PolygonTree

Accessors

area

Returns number

bounds

Returns Rectangle

children

Returns readonly PolygonTreeNode[]

clipperPath

Returns readonly DeepReadonly<types.ClipperPoint>[] | null

clipperPaths

Returns readonly (readonly DeepReadonly<types.ClipperPoint>[])[]

depth

Returns number

isEmpty

Returns boolean

isHole

Returns boolean

parent

Returns PolygonTreeNode | null

path

Returns readonly Point[] | null

points

Returns readonly number[] | null

polygon

Returns Polygon | null

polygons

Returns readonly Polygon[]

triangulation

Returns Readonly<{ indices: Uint16Array | Uint32Array; vertices: Float32Array }>

Methods

[iterator]

Returns Generator<PolygonTreeNode, any, any>

Yields

drawShape

Parameters

Returns void

findClosestPoint

Parameters

Returns Point

findContainingNode

Parameters

Returns PolygonTreeNode | null

intersectClipper

Parameters

OptionalclipType?: number

OptionalfillType?: number

Returns PolygonTree

intersectPolygon

Parameters

OptionalclipType?: number

OptionalfillType?: number

Returns PolygonTree

testCircle

Parameters

Returns -1 | 0 | 1

testPoint

Parameters

Returns boolean

Example: Test whether the point (x, y) is contained within the polygon tree

Example: Test whether the circle at (x, y) with radius r (positive) intersects the polygon tree

Example: Test whether the circle at (x, y) with radius r (positive) is contained within the polygon tree

Static_fromClipperPath

Parameters

Returns PolygonTreeNode

StaticfromClipperPolyTree

Parameters

Returns PolygonTree

Settings

On This Page

`Optional`clipType?: number

`Optional`fillType?: number

`Optional`clipType?: number

`Optional`fillType?: number

`Static`_fromClipperPath

`Static`fromClipperPolyTree