ToolpathStats: 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 hold information about a calculated toolpath. This object is returned by the Toolpath:Stat...")
 
No edit summary
 
Line 10: Line 10:
'''Interaction:''' Read Only
'''Interaction:''' Read Only


'''Returns:''' (bool) true if the statistics in this object are valid. If toolpath has not yet been calculated this would return false
'''Returns:''' (bool) true if the statistics in this object are valid. If toolpath has not yet been calculated this would return false




Line 18: Line 18:
'''Interaction:''' Read Only
'''Interaction:''' Read Only


'''Returns:''' (double) total length of feed rate moves in the toolpath in either mm or inches depending on units of job.
'''Returns:''' (double) total length of feed rate moves in the toolpath in either mm or inches depending on units of job.




Line 26: Line 26:
'''Interaction:''' Read Only
'''Interaction:''' Read Only


'''Returns:''' (double) total length of plunge moves in the toolpath in either mm or inches depending on units of job.
'''Returns:''' (double) total length of plunge moves in the toolpath in either mm or inches depending on units of job.




Line 33: Line 33:
===.RetractLength===
===.RetractLength===
'''Interaction:''' Read Only
'''Interaction:''' Read Only
 
'''Returns:''' (double) total length of retract moves in the toolpath in either mm or inches depending on units of job.
'''Returns:''' (double) total length of retract moves in the toolpath in either mm or inches depending on units of job.




Line 42: Line 42:
'''Interaction:''' Read Only
'''Interaction:''' Read Only


'''Returns:''' (double) total length of rapid moves in the toolpath in either mm or inches depending on units of job.
'''Returns:''' (double) total length of rapid moves in the toolpath in either mm or inches depending on units of job.




Line 50: Line 50:
'''Interaction:''' Read Only
'''Interaction:''' Read Only


'''Returns:''' (double) the z value of the deepest move in the toolpath in either mm or inches depending on units of job.
'''Returns:''' (double) the z value of the deepest move in the toolpath in either mm or inches depending on units of job.





Latest revision as of 17:41, 1 May 2024

Back.jpg

This object is used to hold information about a calculated toolpath. This object is returned by the Toolpath:Statistics() method

Properties

.IsValid

Interaction: Read Only

Returns: (bool) true if the statistics in this object are valid. If toolpath has not yet been calculated this would return false



.FeedLength

Interaction: Read Only

Returns: (double) total length of feed rate moves in the toolpath in either mm or inches depending on units of job.



.PlungeLength

Interaction: Read Only

Returns: (double) total length of plunge moves in the toolpath in either mm or inches depending on units of job.



.RetractLength

Interaction: Read Only

Returns: (double) total length of retract moves in the toolpath in either mm or inches depending on units of job.



.RapidLength

Interaction: Read Only

Returns: (double) total length of rapid moves in the toolpath in either mm or inches depending on units of job.



.MinimumZ

Interaction: Read Only

Returns: (double) the z value of the deepest move in the toolpath in either mm or inches depending on units of job.



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