PocketParameterData - Revision history

WikiSysop: /* .ProfilePassType */

2024-05-02T00:29:16Z

.ProfilePassType

← Older revision		Revision as of 18:29, 1 May 2024
Line 63:		Line 63:

	'''Returns:''' (integer) Type of profile pass to perform . Valid values are as follows:		'''Returns:''' (integer) Type of profile pass to perform . Valid values are as follows:
			::PocketParameterData.PROFILE_NONE
	::PocketParameterData.PROFILE_NONE		::PocketParameterData.PROFILE_FIRST
			::PocketParameterData.PROFILE_LAST
	::PocketParameterData.PROFILE_FIRST

	::PocketParameterData.PROFILE_LAST

	===.ProjectToolpath===		===.ProjectToolpath===

WikiSysop: /* .DoRasterClearance */

2024-05-02T00:29:00Z

.DoRasterClearance

← Older revision		Revision as of 18:29, 1 May 2024
Line 52:		Line 52:

	'''Returns:''' (bool) If true doing raster area clearance, else offset		'''Returns:''' (bool) If true doing raster area clearance, else offset

	'''Returns:''' (bool) If true we will do peck drilling		'''Returns:''' (bool) If true we will do peck drilling

WikiSysop: /* .CutDirection */

2024-05-02T00:28:48Z

.CutDirection

← Older revision		Revision as of 18:28, 1 May 2024
Line 38:		Line 38:

	'''Returns:''' (integer) Cutting direction for toolpath. Valid values are as follow:		'''Returns:''' (integer) Cutting direction for toolpath. Valid values are as follow:
			::ProfileParameterData.CLIMB_DIRECTION
	::ProfileParameterData.CLIMB_DIRECTION		::ProfileParameterData.CONVENTIONAL_DIRECTION

	::ProfileParameterData.CONVENTIONAL_DIRECTION

	Note: Direction constants use ProfileParameterData. NOT PocketParameterData.		Note: Direction constants use ProfileParameterData. NOT PocketParameterData.

WikiSysop at 00:25, 2 May 2024

2024-05-02T00:25:29Z

← Older revision		Revision as of 18:25, 1 May 2024
Line 15:		Line 15:

	===.Allowance===		===.Allowance===
	''~~R/W -~~ double ~~- allowance~~ to leave on pocket sides when calculating toolpath		'''Interaction:''' Read and Write

			'''Returns:''' (double) Allowance to leave on pocket sides when calculating toolpath

	===.AllowanceFormula===		===.AllowanceFormula===
	''~~R/W -~~ string -Formula for allowance to leave on pocket sides when calculating toolpath		'''Interaction:''' Read and Write

			'''Returns:''' (string) Formula for allowance to leave on pocket sides when calculating toolpath

	===.CutDepth===		===.CutDepth===
	''~~R/W -~~ double -Final cutting depth below start depth		'''Interaction:''' Read and Write

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

	===.CutDepthFormula===		===.CutDepthFormula===
	''~~R/W -~~ string -Formula for cutting depth below start depth		'''Interaction:''' Read and Write

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

	===.CutDirection===		===.CutDirection===
	~~R/W -~~ integer - Cutting direction for toolpath. Valid values are ~~...~~		'''Interaction:''' Read and Write

			'''Returns:''' (integer) Cutting direction for toolpath. Valid values are as follow:

	::ProfileParameterData.CLIMB_DIRECTION		::ProfileParameterData.CLIMB_DIRECTION

	::ProfileParameterData.CONVENTIONAL_DIRECTION		::ProfileParameterData.CONVENTIONAL_DIRECTION

	Note: Direction constants use ProfileParameterData. NOT PocketParameterData.		Note: Direction constants use ProfileParameterData. NOT PocketParameterData.

	===.DoRamping===		===.DoRamping===
	'''~~R/W -~~ bool - If true ramp entry to pockets (always zig-zag)		'''Interaction:''' Read and Write

			'''Returns:''' (bool) If true ramp entry to pockets (always zig-zag)

	===.DoRasterClearance===		===.DoRasterClearance===
	'''~~R/W - bool - if true doing raster area clearance, else offset~~		'''Interaction:''' Read and Write

	'''Returns:''' (bool) if true we will do peck drilling		'''Returns:''' (bool) If true doing raster area clearance, else offset

			'''Returns:''' (bool) If true we will do peck drilling

	===.Name===		===.Name===
	~~R/W -~~ string - The name for the toolpath		'''Interaction:''' Read and Write

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

	===.ProfilePassType===		===.ProfilePassType===
	~~R/W -~~ integer ~~- type~~ of profile pass to perform . Valid values are ~~...~~		'''Interaction:''' Read and Write

			'''Returns:''' (integer) Type of profile pass to perform . Valid values are as follows:

	::PocketParameterData.PROFILE_NONE		::PocketParameterData.PROFILE_NONE

	::PocketParameterData.PROFILE_FIRST		::PocketParameterData.PROFILE_FIRST

	::PocketParameterData.PROFILE_LAST		::PocketParameterData.PROFILE_LAST

	===.ProjectToolpath===		===.ProjectToolpath===
	~~R/W -~~ bool - If true and used with Aspire, toolpath is projected onto model surface after calculation		'''Interaction:''' Read and Write

			'''Returns:''' (bool) If true and used with Aspire, toolpath is projected onto model surface after calculation

	===.RampDistance===		===.RampDistance===
	~~R/W -~~ double ~~- distance~~ to ramp over if doing ramping		'''Interaction:''' Read and Write

			'''Returns:''' (double) Distance to ramp over if doing ramping

	===.RasterAllowance===		===.RasterAllowance===
	~~R/W -~~ double ~~- allowance~~ to leave on pocket edge between ~~rasters~~		'''Interaction:''' Read and Write

			'''Returns:''' (double) Allowance to leave on pocket edge between raster

	===.RasterAngle===		===.RasterAngle===
	~~R/W -~~ double - Angle in degrees to create raster toolpaths at		'''Interaction:''' Read and Write

			'''Returns:''' (double) Angle in degrees to create raster toolpaths at

	===.StartDepth===		===.StartDepth===
	~~R/W -~~ double - Start depth for toolpath below material surface		'''Interaction:''' Read and Write

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

	===.StartDepthFormula===		===.StartDepthFormula===
	~~R/W -~~ string -Formula for start depth for toolpath below material surface		'''Interaction:''' Read and Write

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

	===.UseAreaClearTool===		===.UseAreaClearTool===
	~~R/W -~~ bool - If true use a larger tool for area clearance		'''Interaction:''' Read and Write

			'''Returns:''' (bool) If true use a larger tool for area clearance

	'''Example Code'''		'''Example Code'''

WikiSysop at 04:08, 4 August 2021

2021-08-04T04:08:51Z

@@ Line 70: / Line 70: @@
 R/W - bool - If true use a larger tool for area clearance
---Example Code--
+'''Example Code'''
-  <nowiki> -- Create object used to pass pocketing options - used for area clearance only
+  <nowiki>-- Create object used to pass pocketing options - used for area clearance only
 local pocket_data = PocketParameterData()
 -- start depth for toolpath
@@ Line 92: / Line 92: @@
 [[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]

WikiSysop at 04:07, 4 August 2021

2021-08-04T04:07:29Z

@@ Line 28: / Line 28: @@
 ===.CutDirection===
 R/W - integer - Cutting direction for toolpath. Valid values are ...
 ::ProfileParameterData.CLIMB_DIRECTION
 ::ProfileParameterData.CONVENTIONAL_DIRECTION
 Note: Direction constants use ProfileParameterData. NOT PocketParameterData.
@@ Line 52: / Line 49: @@
 ::PocketParameterData.PROFILE_LAST
-'''Returns:''' (string) The name for the toolpath
+===.StartDepth===

WikiSysop at 04:03, 4 August 2021

2021-08-04T04:03:54Z

← Older revision		Revision as of 22:03, 3 August 2021
Line 37:		Line 37:
	===.DoRamping===		===.DoRamping===
	'''R/W - bool - If true ramp entry to pockets (always zig-zag)		'''R/W - bool - If true ramp entry to pockets (always zig-zag)




	===.DoRasterClearance===		===.DoRasterClearance===
Line 46:		Line 43:
	'''Returns:''' (bool) if true we will do peck drilling		'''Returns:''' (bool) if true we will do peck drilling

			===.Name===
			R/W - string - The name for the toolpath

			===.ProfilePassType===
			R/W - integer - type of profile pass to perform . Valid values are ...
			::PocketParameterData.PROFILE_NONE
			::PocketParameterData.PROFILE_FIRST
			::PocketParameterData.PROFILE_LAST


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

	'''Returns:''' (string) The name for the toolpath		'''Returns:''' (string) The name for the toolpath
Line 61:		Line 62:

	'''Returns:''' (double) distance above surface to retract to when peck drilling		'''Returns:''' (double) distance above surface to retract to when peck drilling




	===.ProjectToolpath===		===.ProjectToolpath===
Line 69:		Line 67:

	'''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

WikiSysop: /* .CutDirection */

2021-08-04T04:02:04Z

.CutDirection

← Older revision		Revision as of 22:02, 3 August 2021
Line 27:		Line 27:

	===.CutDirection===		===.CutDirection===
	'R/W - integer - Cutting direction for toolpath. Valid values are ...		R/W - integer - Cutting direction for toolpath. Valid values are ...

	::'ProfileParameterData.CLIMB_DIRECTION		::ProfileParameterData.CLIMB_DIRECTION

	::'ProfileParameterData.CONVENTIONAL_DIRECTION		::ProfileParameterData.CONVENTIONAL_DIRECTION

	'Note: Direction constants use ProfileParameterData. NOT PocketParameterData.		Note: Direction constants use ProfileParameterData. NOT PocketParameterData.

	===.DoRamping===		===.DoRamping===

WikiSysop: /* .CutDirection */

2021-08-04T04:01:45Z

.CutDirection

← Older revision		Revision as of 22:01, 3 August 2021
Line 27:		Line 27:

	===.CutDirection===		===.CutDirection===
	''R/W - integer - Cutting direction for toolpath. Valid values are ...		'R/W - integer - Cutting direction for toolpath. Valid values are ...

	''ProfileParameterData.CLIMB_DIRECTION		::'ProfileParameterData.CLIMB_DIRECTION

	''ProfileParameterData.CONVENTIONAL_DIRECTION		::'ProfileParameterData.CONVENTIONAL_DIRECTION

	''Note: Direction constants use ProfileParameterData. NOT PocketParameterData.		'Note: Direction constants use ProfileParameterData. NOT PocketParameterData.

	===.DoRamping===		===.DoRamping===

WikiSysop: /* .CutDirection */

2021-08-04T04:01:21Z

.CutDirection

← Older revision		Revision as of 22:01, 3 August 2021
Line 29:		Line 29:
	''R/W - integer - Cutting direction for toolpath. Valid values are ...		''R/W - integer - Cutting direction for toolpath. Valid values are ...

	'''ProfileParameterData.CLIMB_DIRECTION		''ProfileParameterData.CLIMB_DIRECTION

	'''ProfileParameterData.CONVENTIONAL_DIRECTION		''ProfileParameterData.CONVENTIONAL_DIRECTION

	''Note: Direction constants use ProfileParameterData. NOT PocketParameterData.		''Note: Direction constants use ProfileParameterData. NOT PocketParameterData.