Back to Aurora Vision Library website
You are here: Start » Function Reference » Path » Path Metrics » PathToPathMaximumDistance
PathToPathMaximumDistance
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationPro |
Computes the distance between the farthest point of the input path from the other path.
Syntax
C++
C#
void avl::PathToPathMaximumDistance ( const avl::Path& inPath1, const avl::Path& inPath2, avl::PathDistanceMode::Type inPathDistanceMode, float inResolution, float& outDistance, atl::Optional<avl::Segment2D&> outConnectingSegment = atl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inPath1 | const Path& | First input path | |||
inPath2 | const Path& | Second input path | |||
inPathDistanceMode | PathDistanceMode::Type | Distance measuring method | |||
inResolution | float | 0.0 - | 1.0f | ||
outDistance | float& | Distance between farthest point of the input path the other input path | |||
outConnectingSegment | Optional<Segment2D&> | NIL | Segment connecting input paths having such distance |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outConnectingSegment.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | One or both input paths are empty in PathToPathMaximumDistance. |