FlutingParameterData - Revision history

WikiSysop: /* .FluteType */

2024-05-02T00:32:10Z

.FluteType

← Older revision		Revision as of 18:32, 1 May 2024
Line 33:		Line 33:

	'''Returns:''' (integer) Type of flute to create. Valid values are:		'''Returns:''' (integer) Type of flute to create. Valid values are:
	::FlutingParameterData.FULL_LENGTH''		FlutingParameterData.FULL_LENGTH''
	::FlutingParameterData.RAMP_START''		FlutingParameterData.RAMP_START''
	::FlutingParameterData.RAMP_START_END''		FlutingParameterData.RAMP_START_END''

	===.Name===		===.Name===

WikiSysop: /* .FluteType */

2024-05-02T00:31:45Z

.FluteType

← Older revision		Revision as of 18:31, 1 May 2024
Line 33:		Line 33:

	'''Returns:''' (integer) Type of flute to create. Valid values are:		'''Returns:''' (integer) Type of flute to create. Valid values are:
	::''FlutingParameterData.FULL_LENGTH''		::FlutingParameterData.FULL_LENGTH''
	::''FlutingParameterData.RAMP_START''		::FlutingParameterData.RAMP_START''
	::''FlutingParameterData.RAMP_START_END''		::FlutingParameterData.RAMP_START_END''




	===.Name===		===.Name===

WikiSysop at 00:30, 2 May 2024

2024-05-02T00:30:52Z

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

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


	===.CutDepthFormula===		===.CutDepthFormula===
	'''Interaction:''' '''Interaction:''' Read and Write		'''Interaction:''' '''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 32:		Line 32:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (integer) Type of flute to create.		'''Returns:''' (integer) Type of flute to create. Valid values are:
	~~::''~~Valid values are:''		::''FlutingParameterData.FULL_LENGTH''
	~~:::~~::''FlutingParameterData.FULL_LENGTH''		::''FlutingParameterData.RAMP_START''
	~~:::~~::''FlutingParameterData.RAMP_START''		::''FlutingParameterData.RAMP_START_END''
	~~:::~~::''FlutingParameterData.RAMP_START_END''


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

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


Line 52:		Line 51:
	'''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 60:		Line 59:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Length of ramp. This is only used if .UseRampRatio is false.		'''Returns:''' (double) Length of ramp. This is only used if .UseRampRatio is false.


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

	'''Returns:''' (double) Length of ramp as ratio of flute length (range 0 to 1.0). For ramp at start end ratio is of half length. This is only used if .UseRampRatio is true.		'''Returns:''' (double) Length of ramp as ratio of flute length (range 0 to 1.0). For ramp at start end ratio is of half length. This is only used if .UseRampRatio is true.


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

	'''Returns:''' (integer) Type of ramping to perform. Valid values are: FlutingParameterData.RAMP_LINEAR		'''Returns:''' (integer) Type of ramping to perform. Valid values are:
	FlutingParameterData.RAMP_SMOOTH		FlutingParameterData.RAMP_LINEAR
			FlutingParameterData.RAMP_SMOOTH


Line 85:		Line 85:
	'''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 93:		Line 93:
	'''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 101:		Line 101:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (bool) If true, use .RampRatio field for controling ramp length, else absolute value from .RampLength		'''Returns:''' (bool) If true, use .RampRatio field for controling ramp length, else absolute value from .RampLength


Line 109:		Line 109:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (bool) If true use selection order of vectors as machining order		'''Returns:''' (bool) If true use selection order of vectors as machining order

WikiSysop: Created page with "link=Toolpaths Category:SDK This object is used to hold the settings for a fluting toolpath. ==Constructor== ===FlutingParameterData()===..."

2021-08-04T04:09:58Z

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

New page

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

==Constructor==

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

'''For Example:'''
<nowiki>local fluting_data = FlutingParameterData() </nowiki>

==Properties==

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

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

===.CutDepthFormula===
'''Interaction:''' '''Interaction:''' Read and Write
'''Returns:''' (string) Formula for final cutting depth below start depth

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

'''Returns:''' (integer) Type of flute to create.
::''Valid values are:''
:::::''FlutingParameterData.FULL_LENGTH''
:::::''FlutingParameterData.RAMP_START''
:::::''FlutingParameterData.RAMP_START_END''

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

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

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

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

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

'''Returns:''' (double) Length of ramp. This is only used if .UseRampRatio is false.

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

'''Returns:''' (double) Length of ramp as ratio of flute length (range 0 to 1.0). For ramp at start end ratio is of half length. This is only used if .UseRampRatio is true.

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

'''Returns:''' (integer) Type of ramping to perform. Valid values are: FlutingParameterData.RAMP_LINEAR
FlutingParameterData.RAMP_SMOOTH

===.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

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

'''Returns:''' (bool) If true, use .RampRatio field for controling ramp length, else absolute value from .RampLength

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

'''Returns:''' (bool) If true use selection order of vectors as machining order

[[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]