Back to Aurora Vision Library website

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

TrimLineToRectangle


Header: AVL.h
Namespace: avl
Module: FoundationLite

Creates a segment contained in a rectangle from a line.

Syntax

C++
C#
 
void avl::TrimLineToRectangle
(
	const avl::Line2D& inLine,
	const avl::Rectangle2D& inRectangle,
	atl::Conditional<avl::Segment2D>& outSegment
)

Parameters

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

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite line on input in TrimLineToRectangle.