Basics
Path - Append_Array
Appends an array of points to the end of the path.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InPoints | Point2DArray | Array of points to add. Overload name: append_Array |
| 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 - Append_Point
Appends a point to the end of the path.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InPoint | Point2D | Point to add. |
| 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 - CreatePath_CreateFromClosed
Creates an empty Path, specifying if it's closed or not.
IN
| Name | Type | Description |
|---|---|---|
| InClosed | Bool | true if the path is closed, false otherwise. |
| 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 instance. |
| Error | ErrorState | Gets the execution error message |
Path - CreatePath_CreateFromPoints
Creates a new Path from an array of points.
IN
| Name | Type | Description |
|---|---|---|
| InPoints | Point2DArray | Array of points. |
| InClosed | Bool | true if the path is closed. |
| 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 instance. |
| Error | ErrorState | Gets the execution error message |
Path - CreatePath_CreateFromSegment
Creates a new Path from a Segment2D (using its two points).
IN
| Name | Type | Description |
|---|---|---|
| InSegment | Segment2D | Segment. |
| 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 instance. |
| Error | ErrorState | Gets the execution error message |
Path - CreatePath_CreateFromSize
Creates a new Path with the provided size.
IN
| Name | Type | Description |
|---|---|---|
| InSize | Int | Length of the path. Range: 〔0, +inf）. |
| InClosed | Bool | Whether the path is closed or not. |
| 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 instance. |
| Error | ErrorState | Gets the execution error message |
Path - Deserialize
De-serialize a Path buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Path - ExtractSubpath
Extracts a new path starting from the provided point.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InStart | Int | Index of the new path starting point. Range: 〔0, +inf）. |
| InPointCount | Int | Number of points that will be extracted. Range: 〔1, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The extracted sub-path. |
| Error | ErrorState | Gets the execution error message |
Path - FromArc
Creates an open path starting from the provided arc object.
IN
| Name | Type | Description |
|---|---|---|
| InArc | Arc2D | Input arc. |
| InPointCount | Int | Number of path points. Range: 〔2, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Path object. |
| Error | ErrorState | Gets the execution error message |
Path - FromCircle
Creates a closed path from the provided circle object.
IN
| Name | Type | Description |
|---|---|---|
| InCircle | Circle2D | Input circle. |
| InPointCount | Int | Number of path points. Range: 〔2, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Path object. |
| Error | ErrorState | Gets the execution error message |
Path - FromEllipse
Creates a closed path from the provided ellipse object.
IN
| Name | Type | Description |
|---|---|---|
| InEllipse | Ellipse2D | Input ellipse. |
| InPointCount | Int | Number of path points. Range: 〔2, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Path object. |
| Error | ErrorState | Gets the execution error message |
Path - FromRectangle
Creates a closed path using the four vertices of the provided rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InRectangle | Rectangle2D | Input rectangle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Path object. |
| Error | ErrorState | Gets the execution error message |
Path - FromSegment
Creates an open path using the provided segment object.
IN
| Name | Type | Description |
|---|---|---|
| InSegment | Segment2D | Input segment. |
| InPointCount | Int | Number of path points. Range: 〔2, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Path object. |
| Error | ErrorState | Gets the execution error message |
Path - GetData
Returns the pointer to the first point of the path.
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 |
|---|---|---|
| OutPoint2D | Point2DArray | Pointer to the first point. |
| Error | ErrorState | Gets the execution error message |
Path - GetPoint
Returns a specific point from the Path.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InIndex | Int | Point index. Range: 〔0, +inf）. |
| InInverse | Bool | true if points order must be reversed when considering the index. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2D | Point2D | Point. |
| Error | ErrorState | Gets the execution error message |
Path - GetPointAtDistance
Returns a point at a certain distance from the path starting point.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InDistance | Float | Distance from the path starting point. Range: 〔0, +inf）. |
| InInverse | Bool | If true, the distance is measured from the endpoint instead. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2D | Point2D | Point. |
| Error | ErrorState | Gets the execution error message |
Path - GetPoint_Interpolated
Returns the linear interpolation of two consecutive path points.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InIndex | Float | Point index （floating-point）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2D | Point2D | Point. |
| Error | ErrorState | Gets the execution error message |
Path - GetSegment
Returns the segment starting with the point at the provided index and ending with the following point on the path.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InIndex | Int | Input index. Range: 〔0, +inf）. |
| InInverse | Bool | If true, the index is counted from the path endpoint. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2D | Segment. |
| Error | ErrorState | Gets the execution error message |
Path - GetSize
Returns the number of points contained in the path.
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 |
|---|---|---|
| OutInt | Int | The computed size. |
| Error | ErrorState | Gets the execution error message |
Path - IsClosed
Returns if the path is closed.
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 |
|---|---|---|
| OutBool | Bool | true if the path is closed, false otherwise. |
| Error | ErrorState | Gets the execution error message |
Path - IsEmpty
Checks if the path is empty.
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 |
|---|---|---|
| OutBool | Bool | true if the path does not contain points, false otherwise. |
| Error | ErrorState | Gets the execution error message |
Path - IsPolygon
Checks if the path can be considered a polygon.
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 |
|---|---|---|
| OutBool | Bool | true if the path is closed and does not have self-intersections, false otherwise. |
| Error | ErrorState | Gets the execution error message |
Path - Remove
Removes a point from the path.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InIndex | Int | Point index. Range: 〔0, +inf）. |
| InInverse | Bool | true if points order must be reversed when considering the index. |
| 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 - Serialize
Serialize the Path object using flatbuffers.
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 |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
Path - SetClosed
Sets the path as open or closed based on the input.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InClosed | Bool | true if the path has to be closed, false otherwise. |
| 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 - SetPoint
Changes the value of the point at the provided index.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InPoint | Point2D | Input point. |
| InIndex | Int | Input index. Range: 〔0, +inf）. |
| InInverse | Bool | Whether to consider index starting from the back of the 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 |