Metrics

Functions
static float	oevislib_net.Path.Distance (Path inPath, Point2D inPoint, float inResolution, Optional< Segment2D > outConnectingSegment)
	Measures the distance between a point and its projection on the provided path.
static Profile	oevislib_net.Path.DistanceProfile (Path inPath, Point2D inPoint, float inResolution, Optional< Array< Segment2D > > outConnectingSegments)
	Computes distances between all the path's points and the provided reference point.
static float	oevislib_net.Path.Distance (Path inPath, Line2D inLine, float inResolution, Optional< Segment2D > outConnectingSegment)
	Computes the minimum distance between a path and a line.
static Profile	oevislib_net.Path.DistanceProfile (Path inPath, Line2D inLine, float inResolution, Optional< Array< Segment2D > > outConnectingSegments)
	Computes distances between all the path's points and the provided reference line.
static float	oevislib_net.Path.Distance (Path inPath1, Path inPath2, PathDistanceMode inDistanceMode, float inResolution, Optional< Segment2D > outConnectingSegment)
	Computes the smallest distance between two paths.
static Profile	oevislib_net.Path.DistanceProfile (Path inPath1, Path inPath2, PathDistanceMode inDistanceMode, float inResolution, Optional< Array< Segment2D > > outConnectingSegments)
	Computes distances between all points of two paths.
static float	oevislib_net.Path.DistanceMax (Path inPath1, Path inPath2, PathDistanceMode inDistanceMode, float inResolution, Optional< Segment2D > outConnectingSegment)
	Computes the maximum distance from two paths.

Detailed Description

Function Documentation

Distance() [1/3]

float oevislib_net.Path.Distance ( Path inPath, Line2D inLine, float inResolution, Optional< Segment2D > outConnectingSegment )

inlinestatic

Computes the minimum distance between a path and a line.

Parameters

inPath	Input path.
inLine	Input line.
inResolution	Measure resolution. Range: [0, +inf).
outConnectingSegment	Shortest segment connecting the path to the line.

Returns

The measured distance.

Distance() [2/3]

float oevislib_net.Path.Distance ( Path inPath, Point2D inPoint, float inResolution, Optional< Segment2D > outConnectingSegment )

inlinestatic

Measures the distance between a point and its projection on the provided path.

Parameters

inPath	Input path.
inPoint	Input point.
inResolution	Distance resolution. Range: [0, +inf).
outConnectingSegment	Segment connecting the point and its projection on the path.

Returns

The computed distance.

Distance() [3/3]

float oevislib_net.Path.Distance ( Path inPath1, Path inPath2, PathDistanceMode inDistanceMode, float inResolution, Optional< Segment2D > outConnectingSegment )

inlinestatic

Computes the smallest distance between two paths.

Parameters

inPath1	First input path.
inPath2	Second input path.
inDistanceMode	Algorithm used to calculate distances between paths.
inResolution	Measure resolution. Range: [0, +inf).
outConnectingSegment	Shortest segment connecting both paths.

Returns

The measured distance.

DistanceMax()

float oevislib_net.Path.DistanceMax ( Path inPath1, Path inPath2, PathDistanceMode inDistanceMode, float inResolution, Optional< Segment2D > outConnectingSegment )

inlinestatic

Computes the maximum distance from two paths.

Parameters

inPath1	First input path.
inPath2	Second input path.
inDistanceMode	Algorithm used to calculate distances between paths.
inResolution	Measure resolution. Range: [0, +inf).
outConnectingSegment	Longest segment connecting both paths.

Returns

The measured distance.

DistanceProfile() [1/3]

Profile oevislib_net.Path.DistanceProfile ( Path inPath, Line2D inLine, float inResolution, Optional< Array< Segment2D > > outConnectingSegments )

inlinestatic

Computes distances between all the path's points and the provided reference line.

Parameters

inPath	Input path.
inLine	input reference line.
inResolution	Measure resolution. Range: [0, +inf).
outConnectingSegments	Array of the segments connecting each path's point to its projection on the reference line.

Returns

The profile containing all computed distances.

DistanceProfile() [2/3]

Profile oevislib_net.Path.DistanceProfile ( Path inPath, Point2D inPoint, float inResolution, Optional< Array< Segment2D > > outConnectingSegments )

inlinestatic

Computes distances between all the path's points and the provided reference point.

Parameters

inPath	Input path.
inPoint	Input reference point.
inResolution	Distance resolution. Range: [0, +inf).
outConnectingSegments	Array of the segments connecting the reference point to each path's point.

Returns

The profile containing all computed distances.

DistanceProfile() [3/3]

Profile oevislib_net.Path.DistanceProfile ( Path inPath1, Path inPath2, PathDistanceMode inDistanceMode, float inResolution, Optional< Array< Segment2D > > outConnectingSegments )

inlinestatic

Computes distances between all points of two paths.

Parameters

inPath1	First input path.
inPath2	Second input path.
inDistanceMode	Algorithm used to calculate distances between paths.
inResolution	Measure resolution. Range: [0, +inf).
outConnectingSegments	Array of the segments connecting each paths' points.

Returns

The profile containing all computed distances.