You are here: Start » Region Basics » CreateSegmentRegion

CreateSegmentRegion

Creates a segment region.

Syntax

void fil::CreateSegmentRegion
(
	const fil::Segment2D& inSegment,
	ftl::Optional<const fil::CoordinateSystem2D&> inSegmentAlignment,
	int inWidth,
	int inFrameWidth,
	int inFrameHeight,
	bool inRound,
	fil::Region& outRegion,
	ftl::Optional<fil::Segment2D&> outAlignedSegment = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inSegment	const Segment2D&
inSegmentAlignment	Optional<const CoordinateSystem2D&>		NIL
inWidth	int	1 -		Segment width
inFrameWidth	int	0 -
inFrameHeight	int	0 -
inRound	bool			Make ends of segment round
outRegion	Region&			Output region
outAlignedSegment	Optional<Segment2D&>		NIL

Description

Filter creates region based on an input Segment2D. To specify line width use inWidth.

Filter creates segment region by creating rectangle located between inSegment points. To make ends round use inRound.

Examples


Example region with inRound=False	Example region with inRound=True