LeadInOutData: Difference between revisions
Jump to navigation
Jump to search
(Created page with "right|50px|link=Toolpaths Category:SDK This object is used to hold parameters relating to lead in or out for toolpaths which support leads. ==Constructo...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 19: | Line 19: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) radius for circular leads | '''Returns:''' (double) radius for circular leads | ||
===.DoLeadIn=== | ===.DoLeadIn=== | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (bool) If true we do lead in else all other fields for lead ins are ignored | '''Returns:''' (bool) If true we do lead in else all other fields for lead ins are ignored | ||
| Line 33: | Line 31: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (bool) If true we do lead out else all other fields for lead outs are ignored | '''Returns:''' (bool) If true we do lead out else all other fields for lead outs are ignored | ||
| Line 40: | Line 38: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (integer) Type of lead to create. Valid values are: | '''Returns:''' (integer) Type of lead to create. Valid values are: | ||
LeadInOutData.LINEAR_LEAD | LeadInOutData.LINEAR_LEAD | ||
LeadInOutData.CIRCULAR_LEAD | LeadInOutData.CIRCULAR_LEAD | ||
| Line 49: | Line 49: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) Length for lead in or out | '''Returns:''' (double) Length for lead in or out | ||
| Line 56: | Line 56: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) Angle in degrees for linear leads from a perpendicular lead | '''Returns:''' (double) Angle in degrees for linear leads from a perpendicular lead | ||
| Line 63: | Line 63: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) If greater than 0.0 tool will continue past entry point by this distance at end of profile | '''Returns:''' (double) If greater than 0.0 tool will continue past entry point by this distance at end of profile | ||
'''For Example:''' | '''For Example:''' | ||
<nowiki> -- Create object used to control lead in or out | <nowiki> -- Create object used to control lead in or out | ||
local lead_in_out_data = LeadInOutData() | local lead_in_out_data = LeadInOutData() | ||
Latest revision as of 17:08, 1 May 2024
This object is used to hold parameters relating to lead in or out for toolpaths which support leads.
Constructor
LeadInData()
Create a new object ready to have its parameters set
For Example:
local lead_data = LeadInOutData()
Properties
.CircularLeadRadius
Interaction: Read and Write
Returns: (double) radius for circular leads
.DoLeadIn
Interaction: Read and Write
Returns: (bool) If true we do lead in else all other fields for lead ins are ignored
.DoLeadOut
Interaction: Read and Write
Returns: (bool) If true we do lead out else all other fields for lead outs are ignored
.LeadType
Interaction: Read and Write
Returns: (integer) Type of lead to create. Valid values are:
LeadInOutData.LINEAR_LEAD
LeadInOutData.CIRCULAR_LEAD
.LeadLength
Interaction: Read and Write
Returns: (double) Length for lead in or out
.LinearLeadAngle
Interaction: Read and Write
Returns: (double) Angle in degrees for linear leads from a perpendicular lead
.OvercutDistance
Interaction: Read and Write
Returns: (double) If greater than 0.0 tool will continue past entry point by this distance at end of profile
For Example:
-- Create object used to control lead in or out
local lead_in_out_data = LeadInOutData()
-- if true we create lead ins on profiles (not for profile on)
lead_in_out_data.DoLeadIn = false
-- if true we create lead outs on profiles (not for profile on)
lead_in_out_data.DoLeadOut = false
-- type of leads to create LeadInOutData.LINEAR_LEAD or LeadInOutData.CIRCULAR_LEAD
lead_in_out_data.LeadType = LeadInOutData.CIRCULAR_LEAD
-- length of lead to create
lead_in_out_data.LeadLength = 10.0 -- Angle for linear leads
lead_in_out_data.LinearLeadAngle = 45 -- Radius for circular arc leads
lead_in_out_data.CirularLeadRadius = 5.0 -- distance to 'overcut' (travel past start point) when profiling
lead_in_out_data.OvercutDistance = 0.0
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