Start » Filter Reference » Path » Polygon Relations » TestPolygonInPolygon

TestPolygonInPolygon


Module: FoundationBasic

Tests whether a polygon lies inside another one.

Name Type Description
Input value
inSubPolygon Path Polygon the position of which will be tested
Input value
inPolygon Path Polygon against which the position will be tested
Output value
outIsContained Bool True if whole polygon lies inside the other one, false otherwise

Description

The operation tests if inSubPolygon lies (in its entirety) inside inPolygon.

Due to inaccuracy of floating point representation a point lying extremely close to a path may considered to be on either of the sides of the path or exactly on the path itself.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty path on input (inSubPolygon) in TestPolygonInPolygon.
DomainError Open path on input in TestPolygonInPolygon.

Complexity Level

This filter is available on Basic Complexity Level.

See Also