oevislib_net  0.14.3.0
Loading...
Searching...
No Matches
Distance Metrics

Functions

static float oevislib_net.Geometry.DistanceMetrics.Distance (Point2D inPoint1, Point2D inPoint2, float inResolution=1.0f)
 Returns the distance between two points.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Point2D inPoint, Line2D inLine, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the absolute value of the distance between a point and its projection on the provided line.
static float oevislib_net.Geometry.DistanceMetrics.SignedDistance (Point2D inPoint, Line2D inLine, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the (signed) value of the distance between a point and its projection on the provided line.
static float oevislib_net.Geometry.DistanceMetrics.OrientedDistance (Point2D inPoint, Segment2D inLineSection, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the (signed) distance between a point and an oriented line.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Point2D inPoint, Segment2D inSegment, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the distance between a point and a segment.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Segment2D inSegment1, Segment2D inSegment2, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the minimum distance between two segments.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Circle2D inCircle1, Circle2D inCircle2, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the minimum distance between two circles.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Point2D inPoint, Circle2D inCircle, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the minimum distance between a point and a circle.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Point2D inPoint, Arc2D inArc, float inResolution=1.0f, Optional< Segment2D > outConnectingSegment=null)
 Returns the minimum distance between a point and an arc.
static Array< float > oevislib_net.Geometry.DistanceMetrics.PointsDistances (Array< Point2D > inPoints, bool inCyclic=false, float inResolution=1.0f)
 Calculates the distances between all the consecutive points of the provided array.
static float oevislib_net.Geometry.DistanceMetrics.Distance (Point2D inPoint, Rectangle2D inRectangle, float inResolution=1.0f, bool inIsFilled=true, Optional< Segment2D > outConnectingSegment=null)
 Returns the minimum distance between a point and a rectangle.

Detailed Description

Function Documentation

◆ Distance() [1/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Circle2D inCircle1,
Circle2D inCircle2,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the minimum distance between two circles.

Parameters
inCircle1First circle.
inCircle2Second circle.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentSegment with minimum length that connects the two provided objects.
Returns
The measured distance.

◆ Distance() [2/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Point2D inPoint,
Arc2D inArc,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the minimum distance between a point and an arc.

Parameters
inPointInput point.
inArcInput arc.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentShortest segment connecting the point to the arc.
Returns
The measured distance.

◆ Distance() [3/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Point2D inPoint,
Circle2D inCircle,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the minimum distance between a point and a circle.

Parameters
inPointReference point.
inCircleInput circle.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentSegment with minimum length connecting the point to the circle.
Returns
The measured distance.

◆ Distance() [4/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Point2D inPoint,
Line2D inLine,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the absolute value of the distance between a point and its projection on the provided line.

Parameters
inPointReference point.
inLineInput line.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentSegment connecting the reference point with its projection on the line.
Returns
The measured distance.

◆ Distance() [5/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Point2D inPoint,
Rectangle2D inRectangle,
float inResolution = 1::0f,
bool inIsFilled = true,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the minimum distance between a point and a rectangle.

Parameters
inPointInput point.
inRectangleInput rectangle.
inResolutionMeasure resolution. Range: [0, +inf).
inIsFilledIf true, the rectangle is considered filled.
outConnectingSegmentShortest segment connecting the point to the rectangle.
Returns
The measured distance.

◆ Distance() [6/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Point2D inPoint,
Segment2D inSegment,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the distance between a point and a segment.

Parameters
inPointReference point.
inSegmentInput segment.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentSegment connecting the reference point with its projection on the segment.
Returns
The measured distance.

◆ Distance() [7/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Point2D inPoint1,
Point2D inPoint2,
float inResolution = 1::0f )
inlinestatic

Returns the distance between two points.

Parameters
inPoint1First point.
inPoint2Second point.
inResolutionInput resolution. Range: [0, +inf).
Returns
The measured distance.

◆ Distance() [8/8]

float oevislib_net.Geometry.DistanceMetrics.Distance ( Segment2D inSegment1,
Segment2D inSegment2,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the minimum distance between two segments.

Parameters
inSegment1First segment.
inSegment2Second segment.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentShorter segment connecting the two provided objects.
Returns
The measured distance.

◆ OrientedDistance()

float oevislib_net.Geometry.DistanceMetrics.OrientedDistance ( Point2D inPoint,
Segment2D inLineSection,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the (signed) distance between a point and an oriented line.

Parameters
inPointReference point.
inLineSectionSegment representing a line with direction.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentSegment connecting the reference point with its projection on the segment.
Returns
The measured distance.

◆ PointsDistances()

Array< float > oevislib_net.Geometry.DistanceMetrics.PointsDistances ( Array< Point2D > inPoints,
bool inCyclic = false,
float inResolution = 1::0f )
inlinestatic

Calculates the distances between all the consecutive points of the provided array.

Parameters
inPointsInput points.
inCyclicIf true, the array is considered cyclic.
inResolutionMeasure resolution. Range: [0, +inf).
Returns
Array with all the measured distances.

◆ SignedDistance()

float oevislib_net.Geometry.DistanceMetrics.SignedDistance ( Point2D inPoint,
Line2D inLine,
float inResolution = 1::0f,
Optional< Segment2D > outConnectingSegment = null )
inlinestatic

Returns the (signed) value of the distance between a point and its projection on the provided line.

Parameters
inPointReference point.
inLineInput line.
inResolutionMeasure resolution. Range: [0, +inf).
outConnectingSegmentSegment connecting the reference point with its projection on the line.
Returns
The measured distance.