Back to FabImage Library website

You are here: Start » Function Reference » Geometry 2D » Geometry 2D Spatial Transforms » TrimLine

TrimLine


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a segment contained in a box from a line.

Syntax

C++
C#
 
void fil::TrimLine
(
	const fil::Line2D& inLine,
	const fil::Box& inBox,
	ftl::Conditional<fil::Segment2D>& outSegment
)

Parameters

Name Type Default Description
Input value inLine const Line2D&
Input value inBox const Box& Box defining a region the input line will be cropped to
Output value outSegment Conditional<Segment2D>&

Examples

TrimLine performed on line and box.

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite line on input in TrimLine.