PocketParameterData: Difference between revisions
(Created page with "right|50px|link=Toolpaths Category:SDK This object is used to hold the settings for a pocketing toolpath and also the clearance tool section of a flat bo...") |
|||
(11 intermediate revisions by the same user not shown) | |||
Line 14: | Line 14: | ||
==Properties== | ==Properties== | ||
===.Allowance=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (double) Allowance to leave on pocket sides when calculating toolpath | |||
===.AllowanceFormula=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (string) Formula for allowance to leave on pocket sides when calculating toolpath | |||
===. | ===.CutDepth=== | ||
'''Interaction:''' Read and Write | |||
'''Returns:''' (double) Final cutting depth below start depth | |||
===.CutDepthFormula=== | ===.CutDepthFormula=== | ||
'''Interaction:''' Read and Write | |||
'''Returns:''' (string) Formula for cutting depth below start depth | |||
===.CutDirection=== | ===.CutDirection=== | ||
'' | '''Interaction:''' Read and Write | ||
'''Returns:''' (integer) Cutting direction for toolpath. Valid values are as follow: | |||
::ProfileParameterData.CLIMB_DIRECTION | |||
::ProfileParameterData.CONVENTIONAL_DIRECTION | |||
Note: Direction constants use ProfileParameterData. NOT PocketParameterData. | |||
===.DoRamping=== | ===.DoRamping=== | ||
''' | '''Interaction:''' Read and Write | ||
'''Returns:''' (bool) If true ramp entry to pockets (always zig-zag) | |||
===.DoRasterClearance=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (bool) If true doing raster area clearance, else offset | |||
'''Returns:''' (bool) If true we will do peck drilling | |||
===. | ===.Name=== | ||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' ( | '''Returns:''' (string) The name for the toolpath | ||
===.ProfilePassType=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (integer) Type of profile pass to perform . Valid values are as follows: | |||
::PocketParameterData.PROFILE_NONE | |||
::PocketParameterData.PROFILE_FIRST | |||
::PocketParameterData.PROFILE_LAST | |||
===.ProjectToolpath=== | |||
===. | |||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' ( | '''Returns:''' (bool) If true and used with Aspire, toolpath is projected onto model surface after calculation | ||
===.RampDistance=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (double) Distance to ramp over if doing ramping | |||
===.RasterAllowance=== | |||
===. | |||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' (double) | '''Returns:''' (double) Allowance to leave on pocket edge between raster | ||
===.RasterAngle=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (double) Angle in degrees to create raster toolpaths at | |||
===.StartDepth=== | |||
===. | |||
'''Interaction:''' Read and Write | '''Interaction:''' Read and Write | ||
'''Returns:''' ( | '''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 | |||
===.UseAreaClearTool=== | |||
'''Interaction:''' Read and Write | |||
'''Returns:''' (bool) If true use a larger tool for area clearance | |||
''' | |||
''' | '''Example Code''' | ||
<nowiki>-- Create object used to pass pocketing options - used for area clearance only | |||
local pocket_data = PocketParameterData() | |||
-- start depth for toolpath | |||
pocket_data.StartDepth = start_depth | |||
-- cut depth for toolpath this is depth below start depth | |||
pocket_data.CutDepth = flat_depth | |||
-- direction of cut for offet clearance - ProfileParameterData.CLIMB_DIRECTION | |||
-- or ProfileParameterData.CONVENTIONAL_DIRECTION - NOTE: enum from ProfileParameterData | |||
pocket_data.CutDirection = ProfileParameterData.CLIMB_DIRECTION | |||
-- if true use raster clearance strategy , else use offset area clearance | |||
pocket_data.DoRasterClearance = true | |||
-- angle for raster if using raster clearance | |||
pocket_data.RasterAngle = 0 | |||
-- type of profile pass to perform PocketParameterData.PROFILE_NONE , | |||
-- PocketParameterData.PROFILE_FIRST orPocketParameterData.PROFILE_LAST | |||
pocket_data.ProfilePassType = PocketParameterData.PROFILE_LAST </nowiki> | |||
[[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 17:29, 1 May 2024
This object is used to hold the settings for a pocketing toolpath and also the clearance tool section of a flat bottomed v carving toolpath.
Constructor
ProfileParameterData() - Constructor
Create a new object ready to have its parameters set
For Example:
local pocket_data = PocketParameterData()()
Properties
.Allowance
Interaction: Read and Write
Returns: (double) Allowance to leave on pocket sides when calculating toolpath
.AllowanceFormula
Interaction: Read and Write
Returns: (string) Formula for allowance to leave on pocket sides when calculating toolpath
.CutDepth
Interaction: Read and Write
Returns: (double) Final cutting depth below start depth
.CutDepthFormula
Interaction: Read and Write
Returns: (string) Formula for cutting depth below start depth
.CutDirection
Interaction: Read and Write
Returns: (integer) Cutting direction for toolpath. Valid values are as follow: ::ProfileParameterData.CLIMB_DIRECTION ::ProfileParameterData.CONVENTIONAL_DIRECTION
Note: Direction constants use ProfileParameterData. NOT PocketParameterData.
.DoRamping
Interaction: Read and Write
Returns: (bool) If true ramp entry to pockets (always zig-zag)
.DoRasterClearance
Interaction: Read and Write
Returns: (bool) If true doing raster area clearance, else offset Returns: (bool) If true we will do peck drilling
.Name
Interaction: Read and Write
Returns: (string) The name for the toolpath
.ProfilePassType
Interaction: Read and Write
Returns: (integer) Type of profile pass to perform . Valid values are as follows: ::PocketParameterData.PROFILE_NONE ::PocketParameterData.PROFILE_FIRST ::PocketParameterData.PROFILE_LAST
.ProjectToolpath
Interaction: Read and Write
Returns: (bool) If true and used with Aspire, toolpath is projected onto model surface after calculation
.RampDistance
Interaction: Read and Write
Returns: (double) Distance to ramp over if doing ramping
.RasterAllowance
Interaction: Read and Write
Returns: (double) Allowance to leave on pocket edge between raster
.RasterAngle
Interaction: Read and Write
Returns: (double) Angle in degrees to create raster toolpaths at
.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
.UseAreaClearTool
Interaction: Read and Write
Returns: (bool) If true use a larger tool for area clearance
Example Code
-- Create object used to pass pocketing options - used for area clearance only local pocket_data = PocketParameterData() -- start depth for toolpath pocket_data.StartDepth = start_depth -- cut depth for toolpath this is depth below start depth pocket_data.CutDepth = flat_depth -- direction of cut for offet clearance - ProfileParameterData.CLIMB_DIRECTION -- or ProfileParameterData.CONVENTIONAL_DIRECTION - NOTE: enum from ProfileParameterData pocket_data.CutDirection = ProfileParameterData.CLIMB_DIRECTION -- if true use raster clearance strategy , else use offset area clearance pocket_data.DoRasterClearance = true -- angle for raster if using raster clearance pocket_data.RasterAngle = 0 -- type of profile pass to perform PocketParameterData.PROFILE_NONE , -- PocketParameterData.PROFILE_FIRST orPocketParameterData.PROFILE_LAST pocket_data.ProfilePassType = PocketParameterData.PROFILE_LAST
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