Metrics
Path - DistanceMax
Computes the maximum distance from two paths.
IN
| Name | Type | Description |
|---|---|---|
| InPath1 | Path | First input path. |
| InPath2 | Path | Second input path. |
| InDistanceMode | Enum < PathDistanceMode > | Algorithm used to calculate distances between paths. |
| 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 |
Path - DistanceProfile_Line
Computes distances between all the path's points and the provided reference line.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | Input path. |
| InLine | Line2D | input reference 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 |
|---|---|---|
| OutProfile | Profile | The profile containing all computed distances. |
| Error | ErrorState | Gets the execution error message |
Path - DistanceProfile_Path
Computes distances between all points of two paths.
IN
| Name | Type | Description |
|---|---|---|
| InPath1 | Path | First input path. |
| InPath2 | Path | Second input path. |
| InDistanceMode | Enum < PathDistanceMode > | Algorithm used to calculate distances between paths. |
| 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 |
|---|---|---|
| OutProfile | Profile | The profile containing all computed distances. |
| Error | ErrorState | Gets the execution error message |
Path - DistanceProfile_Point
Computes distances between all the path's points and the provided reference point.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | Input path. |
| InPoint | Point2D | Input reference point. |
| InResolution | Float | Distance 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 |
|---|---|---|
| OutProfile | Profile | The profile containing all computed distances. |
| Error | ErrorState | Gets the execution error message |
Path - Distance_Line
Computes the minimum distance between a path and a line.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | Input path. |
| 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 |
Path - Distance_Path
Computes the smallest distance between two paths.
IN
| Name | Type | Description |
|---|---|---|
| InPath1 | Path | First input path. |
| InPath2 | Path | Second input path. |
| InDistanceMode | Enum < PathDistanceMode > | Algorithm used to calculate distances between paths. |
| 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 |
Path - Distance_Point
Measures the distance between a point and its projection on the provided path.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | Input path. |
| InPoint | Point2D | Input point. |
| InResolution | Float | Distance 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 computed distance. |
| Error | ErrorState | Gets the execution error message |