Back to Aurora Vision Library website
You are here: Start » Function Reference » Region » Region Spatial Transforms » TrimRegionToPolygon
![](../../img/icon/CropRegion.png)
TrimRegionToPolygon
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationPro |
Removes region elements lying beyond the specified polygon.
Syntax
C++
C#
void avl::TrimRegionToPolygon ( const avl::Region& inRegion, const avl::Path& inPolygon, avl::Region& outRegion )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
![]() |
inRegion | const Region& | Input region | |
![]() |
inPolygon | const Path& | ||
![]() |
outRegion | Region& | Output region |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Path is not closed in TrimRegionToPolygon. |