DistanceMetrics
DistanceMetrics - Distance_Circles
Returns the minimum distance between two circles.
IN
| Name | Type | Description |
|---|---|---|
| InCircle1 | Circle2D | First circle. |
| InCircle2 | Circle2D | Second circle. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_Points
Returns the distance between two points.
IN
| Name | Type | Description |
|---|---|---|
| InPoint1 | Point2D | First point. |
| InPoint2 | Point2D | Second point. |
| InResolution | Float | Input resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_PointToArc
Returns the minimum distance between a point and an arc.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Input point. |
| InArc | Arc2D | Input arc. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_PointToCircle
Returns the minimum distance between a point and a circle.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Reference point. |
| InCircle | Circle2D | Input circle. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_PointToLine
Returns the absolute value of the distance between a point and its projection on the provided line.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Reference point. |
| InLine | Line2D | Input line. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_PointToRectangle
Returns the minimum distance between a point and a rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Input point. |
| InRectangle | Rectangle2D | Input rectangle. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| InIsFilled | Bool | If true, the rectangle is considered filled. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_PointToSegment
Returns the distance between a point and a segment.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Reference point. |
| InSegment | Segment2D | Input segment. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - Distance_Segments
Returns the minimum distance between two segments.
IN
| Name | Type | Description |
|---|---|---|
| InSegment1 | Segment2D | First segment. |
| InSegment2 | Segment2D | Second segment. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - OrientedDistance
Returns the (signed) distance between a point and an oriented line.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Reference point. |
| InLineSection | Segment2D | Segment representing a line with direction. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - PointsDistances
Calculates the distances between all the consecutive points of the provided array.
IN
| Name | Type | Description |
|---|---|---|
| InPoints | Point2DArray | Input points. |
| InCyclic | Bool | If true, the array is considered cyclic. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | FloatArray | Array with all the measured distances. |
| Error | ErrorState | Gets the execution error message |
DistanceMetrics - SignedDistance
Returns the (signed) value of the distance between a point and its projection on the provided line.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Reference point. |
| InLine | Line2D | Input line. |
| InResolution | Float | Measure resolution. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The measured distance. |
| Error | ErrorState | Gets the execution error message |