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

CreateLineRegion

Creates a line region.

Header:	AVL.h

Syntax

void avl::CreateLineRegion
(
	const avl::Line2D& inLine,
	atl::Optional<const avl::CoordinateSystem2D&> inLineAlignment,
	int inWidth,
	int inFrameWidth,
	int inFrameHeight,
	avl::Region& outRegion,
	atl::Optional<avl::Line2D&> outAlignedLine = atl::NIL
)

void CreateLineRegion
(
	Line2D inLine,
	CoordinateSystem2D? inLineAlignment,
	int inWidth,
	int inFrameWidth,
	int inFrameHeight,
	out Region outRegion,
	out Line2D? outAlignedLine
)

Parameters

Name	Type	Range	Default	Description
inLine	const Line2D&
inLineAlignment	Optional<const CoordinateSystem2D&>		NIL
inWidth	int	1 -		Width of output region line
inFrameWidth	int	0 -
inFrameHeight	int	0 -
outRegion	Region&			Output region
outAlignedLine	Optional<Line2D&>		NIL

Description

Filter creates a region defined by an input Line2D with width of inWidth.

Examples

Filter CreateLineRegion is used to split region int two parts: