WikiSysop at 00:34, 2 May 2024

2024-05-02T00:34:08Z

← Older revision		Revision as of 18:34, 1 May 2024
Line 19:		Line 19:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (string) The name for the toolpath		'''Returns:''' (string) The name for the toolpath


Line 27:		Line 27:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Start depth for the toolpath below the material surface		'''Returns:''' (double) Start depth for the toolpath below the material surface


Line 35:		Line 35:
	'''Interaction:''' Read and Write		'''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


Line 43:		Line 43:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Final cutting depth below the start depth		'''Returns:''' (double) Final cutting depth below the start depth


Line 51:		Line 51:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (string) Formula for final cutting depth below start depth		'''Returns:''' (string) Formula for final cutting depth below start depth


Line 59:		Line 59:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) allowance to leave for a finishing toolpath to clear		'''Returns:''' (double) allowance to leave for a finishing toolpath to clear


Line 67:		Line 67:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (bool) If true do Z level roughing		'''Returns:''' (bool) If true do Z level roughing


Line 75:		Line 75:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (integer) type of Z level roughing to perform.		'''Returns:''' (integer) type of Z level roughing to perform. Valid values are:
	~~::'''''~~Valid values are:~~'''''~~		RoughingParameterData.RASTER_X
	~~::''~~RoughingParameterData.RASTER_X ''		RoughingParameterData.RASTER_Y
	~~::''~~RoughingParameterData.RASTER_Y''		RoughingParameterData.OFFSET
	~~::''~~RoughingParameterData.OFFSET''


Line 87:		Line 86:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (integer) type of roughing pass to perform.		'''Returns:''' (integer) type of roughing pass to perform. Valid values are:
	~~::'''''~~Valid values are:~~'''''~~		RoughingParameterData.LAST
	~~::''~~RoughingParameterData.LAST''		RoughingParameterData.FIRST
	~~::''~~RoughingParameterData.FIRST''		RoughingParameterData.NONE
	~~::''~~RoughingParameterData.NONE''


Line 99:		Line 97:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) The angle to raster at		'''Returns:''' (double) The angle to raster at


Line 107:		Line 105:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Allowance to leave on when roughing		'''Returns:''' (double) Allowance to leave on when roughing

WikiSysop: Created page with "link=Toolpaths Category:SDK This object is used to hold settings for a 3D roughing toolpath. ==Constructor== ===RoughingParameterData()===..."

2021-08-04T04:10:42Z

Created page with "right|50px|link=Toolpaths Category:SDK This object is used to hold settings for a 3D roughing toolpath. ==Constructor== ===RoughingParameterData()===..."

New page

[[File:Back.jpg|right|50px|link=Toolpaths]]
[[Category:SDK]]
This object is used to hold settings for a 3D roughing toolpath.

==Constructor==

===RoughingParameterData()===
Create a new object ready to have its parameters set

==Properties==

===.Name===
'''Interaction:''' Read and Write

'''Returns:''' (string) The name for the toolpath

===.StartDepth===
'''Interaction:''' Read and Write

'''Returns:''' (double) Start depth for the toolpath below the material surface

===.StartDepthFormula===
'''Interaction:''' Read and Write

'''Returns:''' (string) Formula for start depth for toolpath below material surface

===.CutDepth===
'''Interaction:''' Read and Write

'''Returns:''' (double) Final cutting depth below the start depth

===.CutDepthFormula===
'''Interaction:''' Read and Write

'''Returns:''' (string) Formula for final cutting depth below start depth

===.Allowance===
'''Interaction:''' Read and Write

'''Returns:''' (double) allowance to leave for a finishing toolpath to clear

===.DoZLevelRoughing===
'''Interaction:''' Read and Write

'''Returns:''' (bool) If true do Z level roughing

===.ZLevelStrategy===
'''Interaction:''' Read and Write

'''Returns:''' (integer) type of Z level roughing to perform.
::'''''Valid values are:'''''
::''RoughingParameterData.RASTER_X ''
::''RoughingParameterData.RASTER_Y''
::''RoughingParameterData.OFFSET''

===.ZLevelProfile===
'''Interaction:''' Read and Write

'''Returns:''' (integer) type of roughing pass to perform.
::'''''Valid values are:'''''
::''RoughingParameterData.LAST''
::''RoughingParameterData.FIRST''
::''RoughingParameterData.NONE''

===.RasterAngle===
'''Interaction:''' Read and Write

'''Returns:''' (double) The angle to raster at

===.MachiningAllowance===
'''Interaction:''' Read and Write

'''Returns:''' (double) Allowance to leave on when roughing

[[File:Back.jpg|right|50px|link=Toolpaths]]
==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]

RoughingParameterData – Aspire Only - Revision history

WikiSysop at 00:34, 2 May 2024

WikiSysop: Created page with "link=Toolpaths Category:SDK This object is used to hold settings for a 3D roughing toolpath. ==Constructor== ===RoughingParameterData()===..."