Back to FabImage Library website
You are here: Start » Function Reference » Path » Polygon Relations » TestPointArrayInPolygon

TestPointArrayInPolygon
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | FoundationBasic |
Tests which points lie inside a polygon.
Syntax
C++
C#
void fil::TestPointArrayInPolygon ( const ftl::Array<fil::Point2D>& inPoints, const fil::Path& inPolygon, ftl::Array<bool>& outIsContainedArray, ftl::Array<fil::Point2D>& outPoints, ftl::Optional<bool&> outAreAllContained = ftl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
![]() |
inPoints | const Array<Point2D>& | Points which will be tested | |
![]() |
inPolygon | const Path& | Polygon against which the points will be tested | |
![]() |
outIsContainedArray | Array<bool>& | ||
![]() |
outPoints | Array<Point2D>& | Points that are contained | |
![]() |
outAreAllContained | Optional<bool&> | NIL |
Optional Outputs
The computation of following outputs can be switched off by passing value ftl::NIL
to these parameters: outAreAllContained.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty polygon on input in TestPointArrayInPolygon. |
DomainError | Open path on input in TestPointArrayInPolygon. |