You are here: Start » AVL.NET » AVL.RegionToRegionDistance
Computes minimal distance between one of the points of the first region with one of the points of the second region.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void RegionToRegionDistance ( AvlNet.Region inRegion1, AvlNet.Region inRegion2, float inResolution, out float outDistance, out AvlNet.Segment2D outConnectingSegment )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inRegion1 | AvlNet.Region | First input region. | |||
inRegion2 | AvlNet.Region | Second input region. | |||
inResolution | float | <0.0f, INF> | 1.0f | Number of real-world units per one pixel. Default value: 1.0f. | |
outDistance | float | ||||
outConnectingSegment | AvlNet.Segment2D |
Description
Operation computes length of the shortest segment that connects center of one of inRegion1's point which center of one of inRegion2's point.
Examples
Remarks
- inRegion1 and inRegion2 must not be empty, otherwise an error with appropriate description occurs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | One of input regions in RegionToRegionDistance is empty. |