Back to FabImage Library website

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

CreateShapeRegionRegion


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Creates a region corresponding to the given shape region.

Syntax

C++
C#
 
void fil::CreateShapeRegionRegion
(
	const fil::ShapeRegion& inShapeRegion,
	ftl::Optional<const fil::CoordinateSystem2D&> inShapeRegionAlignment,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion,
	ftl::Optional<fil::ShapeRegion&> outAlignedShapeRegion = ftl::NIL
)

Parameters

Name Type Range Default Description
Input value
 inShapeRegion const ShapeRegion&
Input value
 inShapeRegionAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the shape region to the position of the inspected object
Input value
 inFrameWidth int 0 - 65535 Width of the created region's frame
Input value
 inFrameHeight int 0 - 65535 Height of the created region's frame
Output value
 outRegion Region& Output region
Output value
 outAlignedShapeRegion Optional<ShapeRegion&> NIL Transformed input shape region

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outAlignedShapeRegion.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Invalid ShapeRegion in CreateShapeRegionRegion.