SpatialTransforms
Path - Align
Moves the path to a new coordinate system.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InAlignment | UCS2D | Input coordinate system. |
| InInverse | Bool | If true, the inverse transformation is performed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The aligned path. |
| Error | ErrorState | Gets the execution error message |
Path - AlignPaths
Aligns each path of the provided array.
IN
| Name | Type | Description |
|---|---|---|
| IoPaths | PathArray | Array with paths that must be aligned. The array will be modified in-place. |
| InAlignment | UCS2D | Input coordinate system. |
| InInverse | Bool | If true, the inverse transformation is performed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIoPaths | PathArray | The modified Core.Data.Types.PathArray |
| Error | ErrorState | Gets the execution error message |
Path - CropPaths_Box
Crops each path of the provided array.
IN
| Name | Type | Description |
|---|---|---|
| IoPaths | PathArray | Array with paths that must be cropped. The array will be modified in-place. |
| InBox | Box | Input rectangle box used to crop each path. |
| InTrimPathMethod | Enum < TrimPathMethod > | Method used to crop each path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIoPaths | PathArray | The modified Core.Data.Types.PathArray |
| Error | ErrorState | Gets the execution error message |
Path - CropPaths_Rectangle
Crops each path of the provided array using the provided rectangle.
IN
| Name | Type | Description |
|---|---|---|
| IoPaths | PathArray | Array with paths that must be cropped. The array will be modified in-place. |
| InRectangle | Rectangle2D | Input rectangle used to crop each path. |
| InTrimPathMethod | Enum < TrimPathMethod > | Method used to crop each path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIoPaths | PathArray | The modified Core.Data.Types.PathArray |
| Error | ErrorState | Gets the execution error message |
Path - Crop_Box
Crops the path to the provided rectangle box.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InBox | Box | Input rectangle box. |
| InTrimPathMethod | Enum < TrimPathMethod > | Method used to crop path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The resulting path. |
| Error | ErrorState | Gets the execution error message |
Path - Crop_Rectangle
Crops the path to the provided rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InRectangle | Rectangle2D | Input rectangle. |
| InTrimPathMethod | Enum < TrimPathMethod > | Method used to crop path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The resulting path. |
| Error | ErrorState | Gets the execution error message |
Path - Inflate
Enlarges the path with a given margin. Note: Path's points must be in clockwise order.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InMargin | Float | Inflation margin. |
| InMaxPointDisplacement | Float | Maximum distance covered by each point. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | A conditional containing the inflated path. The conditional is Null if at least one point travels a distance grated than inMaxPointDisplacement. |
| Error | ErrorState | Gets the execution error message |
Path - ProjectsOn
Project each point on the provided line.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InLine | Line2D | Line on which the path will be projected. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The path projection. |
| Error | ErrorState | Gets the execution error message |
Path - Rescale
Rescales all the path's points distance with respect to a reference point.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InScale | Float | Input scale factor. |
| InInverse | Bool | If true, the scale factor is inverted. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The rescaled path. |
| Error | ErrorState | Gets the execution error message |
Path - RescalePaths
Rescales each path of the provided array.
IN
| Name | Type | Description |
|---|---|---|
| IoPaths | PathArray | Array with paths that must be rescaled. The array will be modified in-place. |
| InScale | Float | Input scale factor. |
| InInverse | Bool | If true, the scale factor is inverted. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIoPaths | PathArray | The modified Core.Data.Types.PathArray |
| Error | ErrorState | Gets the execution error message |
Path - Reverse
Reverses path's points ordered.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The modified Core.Data.Types.Path |
| Error | ErrorState | Gets the execution error message |
Path - Rotate
Rotates the entire path clockwise around a center point.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InAngle | Float | Rotation angle. |
| InInverse | Bool | If true, the rotation is performed counter-clockwise. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The rotated path. |
| Error | ErrorState | Gets the execution error message |
Path - RotatePaths
Rotates each path of the provided array.
IN
| Name | Type | Description |
|---|---|---|
| IoPaths | PathArray | Array with paths that must be rotated. The array will be modified in-place. |
| InAngle | Float | Rotation angle. |
| InInverse | Bool | If true, the paths will be rotated counter-clockwise. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIoPaths | PathArray | The modified Core.Data.Types.PathArray |
| Error | ErrorState | Gets the execution error message |
Path - Shift
Shifts the points of the path by a given distance in a specified direction.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InDistance | Float | The distance by which the points of the path should be shifted. Range 〔0, +inf〕. |
| InDirection | Enum < ShiftDirection > | The direction in which the points should be shifted. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | A new Path object with shifted points. |
| Error | ErrorState | Gets the execution error message |
Path - Translate
Translates each point of the path using the provided vector.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InDelta | Vector2D | Translation vector. |
| InTranslateAlignment | Enum < TranslateAlignment > | Coordinate system used for translation. |
| InInverse | Bool | If true, the vector with the opposite direction is used. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The translated path. |
| Error | ErrorState | Gets the execution error message |
Path - TranslatePaths
Translates each path of the provided array.
IN
| Name | Type | Description |
|---|---|---|
| IoPaths | PathArray | Array with paths that must be translated. The array will be modified in-place. |
| InDelta | Vector2D | Translation vector. |
| InTranslateAlignment | Enum < TranslateAlignment > | Coordinate system used for translation. |
| InInverse | Bool | If true, the vector with the opposite direction is used. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIoPaths | PathArray | The modified Core.Data.Types.PathArray |
| Error | ErrorState | Gets the execution error message |
Path - Transpose
Flips x and y coordinates of each path's point.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The modified Core.Data.Types.Path |
| Error | ErrorState | Gets the execution error message |