FlutingParameterData: Difference between revisions
No edit summary |
|||
(One intermediate revision by the same user not shown) | |||
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.RAMP_START'' | |||
FlutingParameterData.RAMP_START_END'' | |||
===.Name=== | ===.Name=== |
Latest revision as of 17:32, 1 May 2024
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:
local fluting_data = FlutingParameterData()
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
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