ProfileParameterData

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

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

.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: Interaction: Read and Write

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

.DoFlatBottom

Interaction: Read and Write

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.

.UseAreaClearTool

Interaction: Read and Write

Returns: (bool) If true, the area clearance tool will be used to clear the flat areas of the toolpath

For Example:

    -- 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
    vcarve_data.FlatDepth = flat_depth

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

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