Back to Aurora Vision Library website
You are here: Start » Function Reference » ShapeRegion » Shape Region Basics » AlignShapeRegion
AlignShapeRegion
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Aligns a shape region to a coordinate system.
Syntax
C++
C#
void avl::AlignShapeRegion ( const avl::ShapeRegion& inShapeRegion, const avl::CoordinateSystem2D& inShapeRegionAlignment, bool inInverse, atl::Optional<int> inFrameWidth, atl::Optional<int> inFrameHeight, avl::ShapeRegion& outAlignedShapeRegion )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inShapeRegion | const ShapeRegion& | ||||
inShapeRegionAlignment | const CoordinateSystem2D& | Coordinate system to align to | |||
inInverse | bool | Switches to the inverse transform | |||
inFrameWidth | Optional<int> | 0 - 65535 | NIL | Width of the created region's frame | |
inFrameHeight | Optional<int> | 0 - 65535 | NIL | Height of the created region's frame | |
outAlignedShapeRegion | ShapeRegion& |
In-place Processing
This function supports in-place data processing - you can pass the same reference to inShapeRegion and outAlignedShapeRegion
Read more about In-place Computation.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Invalid ShapeRegion in AlignShapeRegion. |