Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Basics » CreatePathRegion

CreatePathRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a region along the given path.

Syntax

C++
C#
 
void fil::CreatePathRegion
(
	const fil::Path& inPath,
	ftl::Optional<const fil::CoordinateSystem2D&> inPathAlignment,
	float inWidth,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion,
	ftl::Optional<fil::Path&> outAlignedPath = ftl::NIL
)

Parameters

Name Type Range Default Description
Input value
 inPath const Path& Input path
Input value
 inPathAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the path to the position of the inspected object
Input value
 inWidth float 1.0 - 1.0f Width of line used to draw path
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
 outAlignedPath Optional<Path&> NIL The input path transformed to the absolute coordinate system

Optional Outputs

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

Read more about Optional Outputs.