ToolpathPosData: Difference between revisions
No edit summary |
|||
| Line 16: | Line 16: | ||
'''Interaction:''' Read Only | '''Interaction:''' Read Only | ||
'''Returns:''' (double) X value for the home position (where tool starts from) | '''Returns:''' (double) X value for the home position (where tool starts from) | ||
| Line 22: | Line 22: | ||
'''Interaction:''' Read Only | '''Interaction:''' Read Only | ||
'''Returns:''' (double) Y value for the home position (where tool starts from) | '''Returns:''' (double) Y value for the home position (where tool starts from) | ||
| Line 28: | Line 28: | ||
'''Interaction:''' Read Only | '''Interaction:''' Read Only | ||
'''Returns:''' (double) Z value for the home position (where tool starts from) | '''Returns:''' (double) Z value for the home position (where tool starts from) | ||
| Line 34: | Line 34: | ||
===.InMM=== | ===.InMM=== | ||
'''Interaction:''' Read Only | '''Interaction:''' Read Only | ||
'''Returns:''' (bool) True if program working in mm, else inches | '''Returns:''' (bool) True if program working in mm, else inches | ||
| Line 42: | Line 42: | ||
'''Interaction:''' Read Only | '''Interaction:''' Read Only | ||
'''Returns:''' (double) Absolute Z value for the safe z moves (rapid moves) | '''Returns:''' (double) Absolute Z value for the safe z moves (rapid moves) | ||
| Line 48: | Line 48: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) Get or Set the SafeZ gap (distance above surface of material for rapid moves) | '''Returns:''' (double) Get or Set the SafeZ gap (distance above surface of material for rapid moves) | ||
| Line 54: | Line 54: | ||
===.StartZGap=== | ===.StartZGap=== | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) Get or Set the StartZ gap (distance above surface of material when plunges change from rapid to plunge federate.) | '''Returns:''' (double) Get or Set the StartZ gap (distance above surface of material when plunges change from rapid to plunge federate.) | ||
Latest revision as of 17:16, 1 May 2024
This object is used to pass data to the various toolpath creation function in the ToolpathManager object to specify the home position and safe z etc.
Constructor
ToolpathPosData()
Creates a new ToolpathPosData object with default values.
Properties
.HomeX
Interaction: Read Only
Returns: (double) X value for the home position (where tool starts from)
.HomeY
Interaction: Read Only
Returns: (double) Y value for the home position (where tool starts from)
.HomeZ
Interaction: Read Only
Returns: (double) Z value for the home position (where tool starts from)
.InMM
Interaction: Read Only
Returns: (bool) True if program working in mm, else inches
.SafeZ
Interaction: Read Only
Returns: (double) Absolute Z value for the safe z moves (rapid moves)
.SafeZGap
Interaction: Read and Write
Returns: (double) Get or Set the SafeZ gap (distance above surface of material for rapid moves)
.StartZGap
Interaction: Read and Write
Returns: (double) Get or Set the StartZ gap (distance above surface of material when plunges change from rapid to plunge federate.)
Methods
:EnsureHomeZIsSafe()
As Home position is specified as an absolute value, it is possible to set it programmatically to an invalid value within the block. This method will ensure that it is always at least SafeZ
above the material surface.
:SetHomePosition( double x, double y, double z)
Set the position from which the tool path starts and usually returns to.
- x(double) X value for tool home position
- y(double) Y value for tool home position
- z(double) Z value for tool home position
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