ExternalToolpath: Difference between revisions

From SDK
Jump to navigation Jump to search
(Created page with "right|50px|link=Toolpaths Category:SDK This object is used to create a toolpath within the program with the user supplying ALL data for the toolpath incl...")
 
No edit summary
 
Line 27: Line 27:
'''Interaction:''' Read Only
'''Interaction:''' Read Only


'''Returns:''' (bool) true if an error occurred while creating the toolpath
'''Returns:''' (bool) true if an error occurred while creating the toolpath


[[File:Back.jpg|right|50px|link=Toolpaths]]
[[File:Back.jpg|right|50px|link=Toolpaths]]
==References==
==References==
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]

Latest revision as of 18:38, 1 May 2024

Back.jpg

This object is used to create a toolpath within the program with the user supplying ALL data for the toolpath including the 3D moves. WARNING This is an extremely powerful capability as you can control the complete movement of the tool. However, it is extremely important to realize how dangerous this can be, the program makes no checks on the data supplied via this method, so the user must make sure that the toolpath is doing what they expect. Scripts that use this capability should be rigorously tested with different jobs with both the Z origin on the material top and bottom, as well as all variations of origin position and in both mm and inches.

Note: Once the toolpath is created, use the AddExternalToolpath method of ToolpathManager to add it to the program.

Constructor

ExternalToolpath( string name, Tool tool, ToolpathPosData pos_data, ExternalToolpathOptions options, ContourGroup contours)

Create a new toolpath object

Name (string) Name for the toolpath
Tool (Tool) Tool to use for the toolpath
pos_data(ToolpathPosData) Settings for home position, safe z etc
options(ExternalToolpathOptions) Settings for external toolpath
contours (ContourGroup) the contours describing the actual toolpath

Properties

.Error

Interaction: Read Only

Returns: (bool) true if an error occurred while creating the toolpath
Back.jpg

References

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