You are here: Start » AVL.NET » Function Reference » Path » Path Metrics » AVL.PathToPathDistanceProfile

AVL.PathToPathDistanceProfile

Computes the profile of distances between two paths.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void PathToPathDistanceProfile
(
	AvlNet.Path inPath1,
	AvlNet.Path inPath2,
	AvlNet.PathDistanceMode inPathDistanceMode,
	float inResolution,
	AvlNet.Profile outDistanceProfile,
	NullableRef<List<float>> outDistances,
	NullableRef<List<AvlNet.Segment2D>> outConnectingSegments
)

Parameters

Name Type Range Default Description
inPath1AvlNet.PathFirst input path.
inPath2AvlNet.PathSecond input path.
inPathDistanceModeAvlNet.PathDistanceModeDistance measuring method.
inResolutionfloat<0.0f, INF>1.0fDefault value: 1.0f.
outDistanceProfileAvlNet.ProfileProfile of distances between second path and consecutive points of first path.
outDistancesAvlNet.NullableRef<System.Collections.Generic.List<float>>Distances between second path and consecutive points of first path. Can be null to skip this parameter calculation.
outConnectingSegmentsAvlNet.NullableRef<System.Collections.Generic.List<AvlNet.Segment2D>>Segments connecting second path and consecutive points of first path having minimal length. Can be null to skip this parameter calculation.

Description

The operation iterates over characteristic points of inPath1 and at each point computes the distance from this point to inPath2. The distance is computed as follows, depending on the value of inPathDistanceMode:

  • The distance to nearest characteristic point of inPath2, if inPathDistanceMode is set to PointToPoint.
  • The minimal distance to inPath2 segments adjacent to the nearest characteristic point of inPath2 (which is much more precise), if inPathDistanceMode is set to PointToSegment.

The operation computes outDistanceProfile profile of consecutive distances and, additionally, outConnectingSegments array of corresponding line segments.

Examples

Sample paths

The resulting outConnectingSegments drawn onto the input paths.

The resulting outDistanceProfile.

Errors

List of possible exceptions:

Error type Description
DomainError Second input path is empty and first input path is not empty in PathToPathDistanceProfile.

Function Overrides

See also