RampingData

This object is used to hold parameters relating to ramping for toolpaths which support ramping.

Constructor

RampingData()

Create a new object ready to have its parameters set

For Example:

local ramping_data = RampingData() 

Properties

.DoRamping

Interaction: Read and Write

Returns: (bool) If true ramping is performed. If false, all other fields are ignored and tool plunges straight down.

.RampAngle

Interaction: Read and Write

Returns: (double) angle (in degrees) to ramp at if constrained by angle

.RampConstraint

Interaction: Read and Write

Returns: (integer) How the ramp is constrained, either by angle or distance.

Valid values are:

RampingData.CONSTRAIN_DISTANCE

RampingData.CONSTRAIN_ANGLE

.RampDistance

Interaction: Read and Write

Returns: (double) distance to ramp over if constrained by distance

.RampMaxAngleDist

Interaction: Read and Write

Returns: (double) max distance to ramp over if constrained by angle

.RampOnLeadIn

Interaction: Read and Write

Returns: (bool) If true ramps are created on the lead in moves

.RampType

Interaction: Read and Write

Returns: (integer) Type of ramping to perform.

Valid values are:

RampingData.RAMP_LINEAR

RampingData.RAMP_ZIG_ZAG

RampingData.RAMP_SPIRAL

For Example:

    -- Create object used to control ramping
    local ramping_data = RampingData() -- if true we do ramping into toolpath    ramping_data.DoRamping = false
     -- type of ramping to perform RampingData.RAMP_LINEAR , RampingData.RAMP_ZIG_ZAG
     -- or RampingData.RAMP_SPIRAL
    ramping_data.RampType = RampingData.RAMP_ZIG_ZAG
     -- how ramp is contrained or either by angle or distance RampingData.CONSTRAIN_DISTANCE
     -- or RampingData.CONSTRAIN_ANGLE
    ramping_data.RampConstraint = RampingData.CONSTRAIN_ANGLE
     -- if we are constraining ramp by distance, distance to ramp over
    ramping_data.RampDistance = 100.0
     -- if we are contraining ramp by angle, angle to ramp in at (in degrees)
    ramping_data.RampAngle = 25.0
     -- if we are contraining ramp by angle, max distance to travel before
     -- 'zig zaging' if zig zaging
    ramping_data.RampMaxAngleDist = 15
     -- if true we restrict our ramping to lead in section of toolpath
    ramping_data.RampOnLeadIn = 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