Back to Aurora Vision Studio website
You are here: Start » Filter Reference » Path » Polygon Relations » TestPointInPolygon
Basic| Module: | FoundationLite |
|---|
Tests whether a point lies inside a polygon.
| Name | Type | Description | |
|---|---|---|---|
 |
inPoint | Point2D | Point the position of which will be tested |
|
inPolygon | Path | Polygon against which the position will be tested |
 |
outIsContained | Bool | True if point lies inside the polygon, false otherwise |
Description
The operation tests if inPoint lies 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.
Examples
 |
 |
TestPointInPolygon run on the sample data produces the outIsContained = true |
TestPointInPolygon run on the sample data produces the outIsContained = false |
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 polygon on input in TestPointInPolygon. |
| DomainError | Open path on input in TestPointInPolygon. |
Complexity Level
This filter is available on Basic Complexity Level.
See Also
- TestPolygonInPolygon – Tests whether a polygon lies inside another one.
