Containment

This class is used to gather information about which paths contain other paths. It represents the containment hierarchy of a set of paths.

A path is contained within another path if every point on it lies inside, and it does not cross the other path.

Constructors

Containment(contained)→Containment
contained
[]
Containment.fromPaths(paths)→Containment

Constructs a containment from an array of paths. Paths are organized into a number of top level path containments, and paths that are contained within those paths.

A path is contained within another path if every point on it lies inside, and it does not cross the other path.

paths

An array of non-overlapping paths

Properties

.containedPathContainment[]

Paths contained within this containment.

Methods

.maximumDepth()→number

Returns the maximum depth of this containment. Depth indicates how deeply nested the hierarchy is. If depth is zero, nothing is contained within this containment.

.allPaths()→Path[]

Returns all paths contained within this containment and its contained, recursively.