Toolpath

The Toolpath object represents a toolpath within the program. Toolpaths are never created directly, they are created using the CreateXXX methods of ToolpathManager.

Properties

.ActiveSheetIndex

Interaction: Read Only

Returns: (integer) Active sheet index when toolpath was calculated. Older toolpaths will return 0 for this value until recalculated, use HasActiveSheetIndex to check for this case.  

.FirstPoint

Interaction: Read Only

Returns: (Point3D) Position of first point in toolpath - start of first plunge move  

.GroupId

Interaction: Read Only

Returns: (UUID) returns group id of toolpath, if this toolpath is part of a group (e.g from flat bottomed vcarving). All toolpaths in a group will have the same group id  

.HasActiveSheetIndex

Interaction: Read Only

Returns: (bool) true if this toolpath has a record of active sheet index when it was calculated  

.Id

Interaction: Read Only

Returns: (UUID) returns id of toolpath, all toolpaths have a unique id  

.InMM

Interaction: Read Only

Returns: (bool) flag indicating if toolpath is in mm or inches  

.LastPoint

Interaction: Read Only

Returns: (Point3D) Position of last point in toolpath - end of last retract move  

.Name

Interaction: Read Write

Returns: (string) name of toolpath - call ToolpathManager:ToolpathModified() after changing  

.Notes

Interaction: Read Write

Returns: (string) notes for toolpath - call ToolpathManager:ToolpathModified() after changing  

.PositionData

Interaction: Read Only

Returns: (ToolpathPosData) Position data (home pos, safe z etc) for toolpath  

.Tool

Interaction: Read Only

Returns: (Tool) returns a Tool object which references the tool in the toolpath and can be used to update 

the tool data.

See Tool:UpdateToolParameters()for more details.

Also call ToolpathManager:ToolpathModified() after changing tool values.

.SideId

Interaction: Read Only

Returns: (UUID) The side id on which this toolpath belongs  

To compare this to another UUID, use

 luaUUID(toolpath.SideId).IsEqual( my_other_id)  

Methods

:DeleteActiveSheetIndex()

Delete the record of the active sheet index for this toolpath.

:MachiningTime()

Return estimated machining time for toolpath. This estimate will use the Rapid Feed rate and Scale Factor set within the program on the ‘Toolpaths Summary’ page.

:ReplaceTool( Tool tool)

Replace the existing tool with the passed tool.

tool - Tool - tool which will replace the current tool in the tool-path

:Statistics()

Return a ToolpathStats object with information about tool-path such as total length of feed rate moves etc.

:Transform(Matrix2D xform)

Transform the toolpath using passed xform. Only translation and rotation are supported

xform - Matrix2D -transformation matrix to apply to toolpath

References

Please Note: The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at Vertric Developer Information