ProfileParameterData: Difference between revisions

From SDK
Jump to navigation Jump to search
No edit summary
No edit summary
Line 87: Line 87:


'''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
===.FlatDepth===
'''Interaction:''' Read and Write
'''Returns:''' (double) If DoFlatBottom is true the toolpath will not cut any deeper than this depth below StartDepth.
===.FlatDepthFormula===
'''Interaction:''' Read and Write
'''Returns:''' (string) Formula for flat depth (see .FlatDepth for when used )




Line 116: Line 102:


'''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 124: Line 108:


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




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


'''Returns:''' (string) Formula for start depth for toolpath below material surface
'''Returns:''' (string) Optional formula for start depth for toolpath below material surface. The formula is the same as can be entered in the Start Depth field on the normal toolpath page and has access to the same variables (e.g “z * 0.5” to set start depth to half the material thickness).






'''For Example:'''
    <nowiki>
-- Create object used to pass profile options
local profile_data = ProfileParameterData()
-- start depth for toolpath
profile_data.StartDepth = start_depth


===.DoFlatBottom===
-- cut depth for toolpath this is depth below start depth
'''Interaction:''' Read and Write
profile_data.CutDepth = cut_depth


'''Returns:''' (bool) If true the toolpath depth will be limited to the value specified in .FlatDepth and the bottom of the carving will be flat.
-- direction of cut - ProfileParameterData.CLIMB_DIRECTION or
-- ProfileParameterData.CONVENTIONAL_DIRECTION
profile_data.CutDirection = ProfileParameterData.CLIMB_DIRECTION


-- side we machine on - ProfileParameterData.PROFILE_OUTSIDE,
-- ProfileParameterData.PROFILE_INSIDE or ProfileParameterData.PROFILE_ON
profile_data.ProfileSide = ProfileParameterData.PROFILE_OUTSIDE


-- Allowance to leave on when machining
profile_data.Allowance = 0.0


-- true to preserve start point positions, false to reorder start points to
-- minimise toolpath length
profile_data.KeepStartPoints = false


===.UseAreaClearTool===
-- true if want to create 'square' external corners on toolpath
'''Interaction:''' Read and Write
profile_data.CreateSquareCorners = false


'''Returns:''' (bool) If true, the area clearance tool will be used to clear the flat areas of the toolpath
-- true to perform corner sharpening on internal corners (only with v-bits)
 
profile_data.CornerSharpen = false
'''For Example:'''
    <nowiki> -- Create  object used to pass vcarving options
    local vcarve_data = VCarveParameterData()
    -- start depth for toolpath
    vcarve_data.StartDepth = start_depth


    -- flag indicating if we are creating a flat bottomed toolpath
    vcarve_data.DoFlatBottom = flat_depth > 0.0


    -- cut depth for toolpath this is depth below start depth
-- if true in Aspire, project toolpath onto composite model
    vcarve_data.FlatDepth = flat_depth
profile_data.ProjectToolpath = false


    -- if true in Aspire, project toolpath onto composite model
</nowiki>
    vcarve_data.ProjectToolpath = false </nowiki>




Revision as of 15:57, 1 May 2024

Back.jpg

This object is used to hold the settings for a vcarving toolpath.


Constructor

VCarveParameterData()

Create a new object ready to have its parameters set

For Example: 

local vcarve_data = VCarveParameterData()


Properties

.Allowance

Interaction: Read and Write

Returns: (double) Allowance to leave on profile when calculating toolpath


.AllowanceFormula

Interaction: Read and Write

Returns: (string) Formula for allowance to leave on profile when calculating toolpath


.CutDepth

Interaction: Read and Write

Returns: (double) Final cutting depth below start depth


.CornerSharpen

Interaction: Read and Write

Returns: (bool) True if want to create 3D ‘corner sharpening’ moves for internal corners


.CreateSquareCorners

Interaction: Read and Write

Returns: (bool) true if want to create ‘square’ external corners


.CutDepthFormula

Interaction: Read and Write

Returns: (string) Optional formula for final cutting depth below start depth. The formula is the same as can be entered in the CutDepth field on the normal toolpath page and has access to the same variables (e.g “z * 0.5” to set cut depth to half the material thickness).


.CutDirection

Interaction: Read and Write

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


.KeepStartPoints

Interaction: Read and Write

Returns: (bool) If true, start points of vectors are maintained, else start points are optimised


.Name

Interaction: Read and Write

Returns: (string) The name for the toolpath


.ProfileSide

Interaction: Read and Write

Returns: (integer) Side of the vector to cut on. Valid values are ... ProfileParameterData.PROFILE_OUTSIDE ProfileParameterData.PROFILE_INSIDE ProfileParameterData.PROFILE_ON


.ProjectToolpath

Interaction: Read and Write

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


.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


.StartDepth

Interaction: Read and Write

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


.StartDepthFormula

Interaction: Read and Write

Returns: (string) Optional formula for start depth for toolpath below material surface. The formula is the same as can be entered in the Start Depth field on the normal toolpath page and has access to the same variables (e.g “z * 0.5” to set start depth to half the material thickness).


For Example: 

   
-- Create object used to pass profile options
 local profile_data = ProfileParameterData()
 -- start depth for toolpath
 profile_data.StartDepth = start_depth

 -- cut depth for toolpath this is depth below start depth
 profile_data.CutDepth = cut_depth

 -- direction of cut - ProfileParameterData.CLIMB_DIRECTION or
 -- ProfileParameterData.CONVENTIONAL_DIRECTION
 profile_data.CutDirection = ProfileParameterData.CLIMB_DIRECTION

 -- side we machine on - ProfileParameterData.PROFILE_OUTSIDE,
 -- ProfileParameterData.PROFILE_INSIDE or ProfileParameterData.PROFILE_ON
 profile_data.ProfileSide = ProfileParameterData.PROFILE_OUTSIDE

 -- Allowance to leave on when machining
 profile_data.Allowance = 0.0

 -- true to preserve start point positions, false to reorder start points to
 -- minimise toolpath length
 profile_data.KeepStartPoints = false

 -- true if want to create 'square' external corners on toolpath
 profile_data.CreateSquareCorners = false

 -- true to perform corner sharpening on internal corners (only with v-bits)
 profile_data.CornerSharpen = false


 -- if true in Aspire, project toolpath onto composite model
 profile_data.ProjectToolpath = false


Back.jpg

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

Retrieved from "https://jimandi.com/SDK/index.php?title=ProfileParameterData&oldid=817"