Classification
Path - ExtractClosedPaths
Selects closed paths from an input array.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathArray | Closed paths. |
| Error | ErrorState | Gets the execution error message |
Path - ExtractExternalPaths
Selects paths that do not obstruct the external visibility of other objects, given a reference point.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InCenterPoint | Point2D | Point used to determine visibility. |
| InTolerance | Float | Fraction of the path allowed to obstruct other paths. Range: 〔0, 1〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathArray | External paths. |
| Error | ErrorState | Gets the execution error message |
Path - ExtractInternalPaths
Selects paths that are visible from a reference point.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InCenterPoint | Point2D | Point used to determine visibility. |
| InTolerance | Float | Fraction of the path allowed to be obstructed by other paths. Range: 〔0, 1〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathArray | Internal paths. |
| Error | ErrorState | Gets the execution error message |
Path - ExtractOpenPaths
Selects open paths from an input array.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathArray | Open paths. |
| Error | ErrorState | Gets the execution error message |
Path - ExtractPaths
Filters an array of paths based on the provided feature.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InPathFeature | Enum < PathFeature > | Feature used to filter paths. |
| InPathFilter | Enum < PathFilter > | Type of filter considered in the algorithm. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathArray | an array containing the accepted paths. |
| Error | ErrorState | Gets the execution error message |
Path - FindMaxPath
Returns the path with the maximum value of the requested feature.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InPathFeature | Enum < PathFeature > | Feature used to compare the paths. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The path with the maximum value of the requested feature. |
| Error | ErrorState | Gets the execution error message |
Path - FindMinPath
Returns the path with the minimum value of the requested feature.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InPathFeature | Enum < PathFeature > | Feature used to compare the paths. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The path with the minimum value of the requested feature. |
| Error | ErrorState | Gets the execution error message |
Path - MakePathConditional
Computes a path feature, checks whether its value is in range and creates an optional path on this basis.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | Input path. |
| InFeature | Enum < PathFeature > | Path feature value to be computed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutConditionalPath | PathNull | The path if the condition is met or nothing otherwise. |
| Error | ErrorState | Gets the execution error message |
Path - SortPaths
Returns the input path array sorted based on the requested feature.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InPathFeature | Enum < PathFeature > | Feature used to sort the paths. |
| InPathFilter | Enum < PathFilter > | Type of filter considered in the sorting algorithm. |
| InSortingOrder | Enum < SortingOrder > | Sorting order. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathArray | The input path array sorted based on the requested feature. |
| Error | ErrorState | Gets the execution error message |