Back to FabImage Library website
You are here: Start » Function Reference » Path » Path Combinators » PathLineIntersections

PathLineIntersections
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | FoundationPro |
Computes the common points of a path and a line.
Syntax
C++
C#
void fil::PathLineIntersections ( const fil::Path& inPath, const fil::Line2D& inLine, ftl::Array<fil::Point2D>& outIntersectionPoints, ftl::Optional<ftl::Array<int>&> outSegmentIndices = ftl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
![]() |
inPath | const Path& | Input path | |
![]() |
inLine | const Line2D& | Input line | |
![]() |
outIntersectionPoints | Array<Point2D>& | Intersections between the path and the line | |
![]() |
outSegmentIndices | Optional<Array<int>&> | NIL | Indices of the segments of the path which generate found intersection points |
Optional Outputs
The computation of following outputs can be switched off by passing value ftl::NIL
to these parameters: outSegmentIndices.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Indefinite line on input in PathLineIntersections. |