Back to Aurora Vision Library website

You are here: Start » Function Reference » Path » Polygon Relations » TestPointArrayInPolygon

TestPointArrayInPolygon


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Tests which points lie inside a polygon.

Syntax

C++
C#
 
void avl::TestPointArrayInPolygon
(
	const atl::Array<avl::Point2D>& inPoints,
	const avl::Path& inPolygon,
	atl::Array<bool>& outIsContainedArray,
	atl::Array<avl::Point2D>& outPoints,
	atl::Optional<bool&> outAreAllContained = atl::NIL
)

Parameters

Name Type Default Description
Input value inPoints const Array<Point2D>& Points which will be tested
Input value inPolygon const Path& Polygon against which the points will be tested
Output value outIsContainedArray Array<bool>&
Output value outPoints Array<Point2D>& Points that are contained
Output value outAreAllContained Optional<bool&> NIL

Optional Outputs

The computation of following outputs can be switched off by passing value atl::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.