You are here: Start » AVL.NET » Function Reference » Path » Polygon Relations » AVL.TestPolygonInPolygon
AVL.TestPolygonInPolygon
Tests whether a polygon lies inside another one.
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void TestPolygonInPolygon ( AvlNet.Path inSubPolygon, AvlNet.Path inPolygon, out bool outIsContained )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inSubPolygon | AvlNet.Path | Polygon the position of which will be tested. | ||
| inPolygon | AvlNet.Path | Polygon against which the position will be tested. | ||
 | 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
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Empty path on input (inSubPolygon) in TestPolygonInPolygon. |
| DomainError | Open path on input in TestPolygonInPolygon. |
