Back to FabImage Library website

You are here: Start » Function Reference » ShapeRegion » Shape Region Basics » AlignShapeRegion

AlignShapeRegion


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Aligns a shape region to a coordinate system.

Syntax

C++
C#
 
void fil::AlignShapeRegion
(
	const fil::ShapeRegion& inShapeRegion,
	const fil::CoordinateSystem2D& inShapeRegionAlignment,
	bool inInverse,
	ftl::Optional<int> inFrameWidth,
	ftl::Optional<int> inFrameHeight,
	fil::ShapeRegion& outAlignedShapeRegion
)

Parameters

Name Type Range Default Description
Input value inShapeRegion const ShapeRegion&
Input value inShapeRegionAlignment const CoordinateSystem2D& Coordinate system to align to
Input value inInverse bool Switches to the inverse transform
Input value inFrameWidth Optional<int> 0 - 65535 NIL Width of the created region's frame
Input value inFrameHeight Optional<int> 0 - 65535 NIL Height of the created region's frame
Output value 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.