DrillParameterData: Difference between revisions
Jump to navigation
Jump to search
(Created page with "right|50px|link=Toolpaths Category:SDK This object is used to hold the settings for a drilling toolpath. ==Constructor== ===DrillParameterData()=== Cr...") |
No edit summary |
||
| Line 20: | Line 20: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) Final cutting depth below start depth | '''Returns:''' (double) Final cutting depth below start depth | ||
| Line 26: | Line 26: | ||
===.CutDepthFormula=== | ===.CutDepthFormula=== | ||
'''Interaction:''' | '''Interaction:''' Read and Write | ||
'''Returns:''' (string) Formula for cut depth below start depth | |||
'''Returns:''' (string) Formula for cut depth below start depth | |||
| Line 35: | Line 36: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (bool) if true we will do peck drilling | '''Returns:''' (bool) if true we will do peck drilling | ||
| Line 43: | Line 44: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (string) The name for the toolpath | '''Returns:''' (string) The name for the toolpath | ||
| Line 51: | Line 52: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) distance above surface to retract to when peck drilling | '''Returns:''' (double) distance above surface to retract to when peck drilling | ||
| Line 59: | Line 60: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (bool) If true and used with Aspire, toolpath is projected onto model surface after calculation | '''Returns:''' (bool) If true and used with Aspire, toolpath is projected onto model surface after calculation | ||
| Line 67: | Line 68: | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) Start depth for toolpath below material surface | '''Returns:''' (double) Start depth for toolpath below material surface | ||
| Line 73: | Line 74: | ||
===.StartDepthFormula=== | ===.StartDepthFormula=== | ||
'''Interaction:''' Read and Write | |||
'''Returns:''' (string) Formula for start depth for toolpath below material surface | |||
'''Returns:''' (string) Formula for start depth for toolpath below material surface | |||
'''For Example:''' | '''For Example:''' | ||
Latest revision as of 18:26, 1 May 2024
This object is used to hold the settings for a drilling toolpath.
Constructor
DrillParameterData()
Create a new object ready to have its parameters set
For Example:
local drill_data = DrillParameterData()
Properties
.CutDepth
Interaction: Read and Write
Returns: (double) Final cutting depth below start depth
.CutDepthFormula
Interaction: Read and Write
Returns: (string) Formula for cut depth below start depth
.DoPeckDrill
Interaction: Read and Write
Returns: (bool) if true we will do peck drilling
.Name
Interaction: Read and Write
Returns: (string) The name for the toolpath
.PeckRetractGap
Interaction: Read and Write
Returns: (double) distance above surface to retract to when peck drilling
.ProjectToolpath
Interaction: Read and Write
Returns: (bool) If true and used with Aspire, toolpath is projected onto model surface after calculation
.StartDepth
Interaction: Read and Write
Returns: (double) Start depth for toolpath below material surface
.StartDepthFormula
Interaction: Read and Write
Returns: (string) Formula for start depth for toolpath below material surface
For Example:
-- Create object used to pass drilling options
local drill_data = DrillParameterData() -- start depth for toolpath
drill_data.StartDepth = start_depth -- cut depth for toolpath this is depth below start depth
drill_data.CutDepth = cut_depth -- if true perform peck drilling
drill_data.DoPeckDrill = retract_gap > 0.0 -- distance to retract above surface when peck drilling
drill_data.PeckRetractGap = retract_gap -- if true in Aspire, project toolpath onto composite model
drill_data.ProjectToolpath = false
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