Namespace CAMAPI.ModelFormerLatheTypes

Structs

Interfaces

ICamApiCommonGroovingModelItem

Grooving model item (XML: TLatheGroovingModelItem). Used by TLatheODGrooving (default cycle Slotting), TLatheIDGrooving and TLatheFaceGrooving operations. Allowed cycle types: gcctProfile, gcctSlotting (default), gcctGrooving, gcctZigzag. Calling SetActiveCycle with an unsupported value fills ResultStatus with rsError.

ICamApiCommonShapeThreadingModelItem

Shape-threading model item (XML: TLatheShapeThreadingModelItem). Used together with a TLatheShapeThreadProfileCore item to drive non-cylindrical thread paths. Allowed cycle types: sctct92, sctctExpanded (default).

ICamApiCommonThreadingModelItem

Threading model item (XML: TLatheThreadingModelItem). Used by TLatheODThreading and TLatheIDThreading operations. Allowed cycle types: tcct76, tcct92, tcctExpanded (default).

ICamApiCommonTurningModelItem

Common turning model item (XML: TCommonTurningModelItem). Used by TLatheODTurning (default model item "Roughing"), TLatheIDTurning, TLatheODFinishing and similar operations. Allowed cycle types: lcctProfile, lcctOffsetLegacy, lcctOffsetRoughing, lcctRoughingAdvanced (default), lcctRoughing, lcctZigzag.

ICamApiLatheContourFacingModelItem

Facing model item (XML: TLatheContourFacingModelItem, "Facing" button in TLatheFaceMachining and other lathe-contouring operations). Allowed cycle types: lcctProfile, lcctOffsetLegacy, lcctOffsetRoughing — passing other values to SetActiveCycle fills ResultStatus with rsError.

ICamApiLatheCycleChipBreakingDwell

Chip-breaking Dwell sub-block of cycles that own a CycleParameters.ChipBreaking node (Roughing, RoughingAdvanced). Available via QueryInterface on the same object as the dedicated cycle interface — kept separate so that adding Dwell does not change the binary layout of TLatheChipBreaking.

ICamApiLatheCycleCommon

Common cycle properties shown on the cycle-named tab (e.g. "Offset Roughing 1"). Available via QueryInterface on the same object as the dedicated cycle interface.

ICamApiLatheCycleGroove

Groove cycle (XML: every TGrooveCycle descendant — TSGrooveCycle, TAdvancedLatheCycle75; TSGrooveCycle inherits TAdvancedLatheCycle75 unchanged). Covers the parent TGrooveCycle parameter set: machined side, the Toolpath block (Passes / RoughDirection / MaxScallop / RoughStep / RoughStock / FinishDirection), the cycle-level SafeDist, the narrower CheckWorkpiece, and the CompensOnCut / CompensOffCut blocks attached to the Leads tab. Available via QueryInterface on the ActiveCycle object of ICamApiCommonGroovingModelItem when ActiveCycleType is gcctSlotting or gcctGrooving. The TAdvancedLatheCycle75-only BackOff field is on the separate ICamApiLatheCycleGrooveBackOff. The hidden Toolpath sub-blocks (Multilayer / CannedCycle / SmartOverlap / ChipBreaking / Delay) are on the existing ICamApiLatheCycleZigzagToolpath — the XML nodes are identical because both Grooving and Zigzag derive from TAdvancedLatheCycle75. Note: ICamApiLatheCycleCommon.MachiningSide on a grooving item reads the same CycleParameters.Side node but interprets values incorrectly (the enums are different) — use Side on this interface instead.

ICamApiLatheCycleGrooveBackOff

BackOff sub-block of TAdvancedLatheCycle75 (XML: CycleParameters.Toolpath.BackOff — TGrooveBackOff). Available via QueryInterface on the same ActiveCycle object that exposes ICamApiLatheCycleGroove, but only when ActiveCycleType = gcctGrooving. The XML node also exists on TSGrooveCycle through inheritance from TAdvancedLatheCycle75, however the Slotting UI does not expose it; the API gates access by cycle type so that callers cannot accidentally write to a node Slotting users do not see.

ICamApiLatheCycleLeads

Leads tab — Approach + Engage + Retract. Available via QueryInterface on the same object as the dedicated cycle interface.

ICamApiLatheCycleOffsetLegacy

"Offset cycle" — legacy canned-cycle variant (XML: TLatheCycle73, ISO G73). Older parent of TAdvancedLatheCycle73, visible in TLatheFaceMachining / TLatheODTurning UI on non-robot machines. Same parameter set as ICamApiLatheCycleOffsetRoughing minus the CheckWorkpiece block, which only exists on the Advanced descendant.

ICamApiLatheCycleOffsetRoughing

"Offset Roughing" cycle (XML: TAdvancedLatheCycle73, UI default).

ICamApiLatheCycleOverrideFeeds

Override Feeds tab. Available via QueryInterface on the same object as the dedicated cycle interface. Each feed has a Measurement discriminator and paired GetIs*/SetIs* methods. Setting the Measurement property resets the associated value to its default. SetFeedIs* atomically switches the Measurement and stores the value.

ICamApiLatheCycleProfile

Lead/pitch sub-block of ThreadForm (XML: ThreadForm.Lead). Use LeadType to interpret which Value* slot is meaningful. Lead as linear distance (only when LeadType = ttltDistance) Lead as threads per unit length (only when LeadType = ttltTreadsPerUnit) Chamfer sub-block of ThreadForm (XML: ThreadForm.Chamfer). Use Mode to interpret which Value* slot is meaningful — lcmDistance → DistanceValue, lcmPercent → PercentValue, lcmAuto → neither. Angle is meaningful when Mode ≠ lcmAuto. Chamfer length (only when Mode = lcmDistance) Chamfer as % of lead (only when Mode = lcmPercent) Chamfer angle in degrees (meaningful when Mode ≠ lcmAuto) Thread form parameters of TLatheThreadCycle (XML: CycleParameters.ThreadForm). Contains the full set used by all three variants: G76 / G92 / Expanded. Use Lead.LeadType to interpret the lead slot. Number of thread starts Spindle start angle (degrees) Multi-pass sequencing block of TLatheThreadCycle (XML: CycleParameters.ThreadSequence). Use BaseDepth to interpret which cut-count slot is meaningful — ttbdFirstCut → FirstCutValue, ttbdCount → CountValue. AngleValue is meaningful only when SequenceType = ttseqModifiedFlank. Modified-flank angle offset (only when SequenceType = ttseqModifiedFlank) First-cut depth — basis for computing pass count (only when BaseDepth = ttbdFirstCut) Explicit rough-pass count (only when BaseDepth = ttbdCount) Minimum cut depth; cuts shallower than this are merged into the last pass Number of finish (spring) passes after the last rough pass Depth of each finish pass Thread form parameters of TLatheShapeThreadCycle (XML: CycleParameters.ThreadForm). Shape-thread cycles do not carry ThreadDepth / ThreadAngle / InclinationAngle in the XML schema — those fields are commented out and the groove shape is defined by the paired TLatheShapeThreadProfileCore model item instead. Two-axis stock for shape-thread roughing (XML: Roughing.Stock — RadialValue = "Bottom stock", AxialValue = "Side stock"). Distinct from TLatheStockAllowance which carries a third ProfileValue field. Multilayer depth block of shape-thread roughing (XML: Roughing.Multilayer). Use DepthType to interpret which value slot is meaningful — tsmtCount → CountValue, tsmtDepth → DepthValue. Visible only when LayerMachiningDirection ≠ tsmdOff. Layer count (only when DepthType = tsmtCount) Per-layer depth (only when DepthType = tsmtDepth) Rough-passes block of TLatheShapeThreadCycle (XML: CycleParameters.Roughing). Rough step — same Distance/Count discriminator as other lathe cycles Finish-passes block of TLatheShapeThreadCycle (XML: CycleParameters.Finishing). "Profile" cycle of a lathe-contouring item (XML: TLatheContouringProfile, UI combobox option "Profile"). Profile-only path with no roughing parameters.

ICamApiLatheCycleRoughing

"Roughing cycle" — legacy canned-cycle variant (XML: TLatheCycle71, ISO G71/G72). Visible in TLatheODTurning UI on non-robot machines. No CheckWorkpiece block.

ICamApiLatheCycleRoughingAdvanced

"Roughing" cycle, advanced variant (XML: TAdvancedLatheCycle71). Default cycle for TCommonTurningModelItem (TLatheODTurning button "RoughingAdvanced").

ICamApiLatheCycleShapeThread

Shape-threading cycle (XML: TLatheShapeThreadCycle92 and TExpandedLatheShapeThreadCycle). Available via QueryInterface on the ActiveCycle object of ICamApiCommonShapeThreadingModelItem for both sctct* cycle types. The same object also exposes ICamApiLatheCycleCommon and ICamApiLatheCycleLeads via QI. Shape-thread cycles have no ThreadSequence — the groove shape is defined by the paired TLatheShapeThreadProfileCore model item. At least one of Roughing.Enabled or Finishing.Enabled must be true; setting both to false is an XML error condition.

ICamApiLatheCycleThread

Threading cycle (XML: all three TLatheThreadCycle descendants — TLatheThreadCycle76, TLatheThreadCycle92, TExpandedLatheThreadCycle). Available via QueryInterface on the ActiveCycle object of ICamApiCommonThreadingModelItem for all tcct* cycle types. The same object also exposes ICamApiLatheCycleCommon and ICamApiLatheCycleLeads via QI. ThreadSequence is present in the XML for all three variants. On G92 (tcct92, single pass) the sequencing parameters have no effect on tool motion but are still readable/writable.

ICamApiLatheCycleZigzag

"Zigzag" cycle (XML: TZigzagLatheCycle, derived from TAdvancedLatheCycle75). Specific subset — Multilayer/CannedCycle/SmartOverlap/ChipBreaking/Delay are hidden in Zigzag UI and are not exposed.

ICamApiLatheCycleZigzagToolpath

Hidden Zigzag toolpath sub-blocks (XML: CycleParameters.Toolpath.* on TAdvancedLatheCycle75 / TZigzagLatheCycle). The Zigzag UI hides these fields with Visible="false" but the underlying XML nodes still exist; the API exposes them through this extension interface so callers can drive them programmatically. Available via QueryInterface on the same object as ICamApiLatheCycleZigzag, and also as ICamApiLatheCycleGroove on grooving items — the underlying XML node set is identical for every TAdvancedLatheCycle75 descendant.

ICamApiModelFormerWithLatheContouringItems

Model former mixin for adding lathe-contouring items.

Enums

TLatheApproachFeed

TLatheApproachMode

TLatheChamferMode

TLatheChipBreakingDwellMode

TLatheCompensationType

TLatheContourCycleType

TLatheEngageRetractType

TLatheFeedRelativeMeasurement

TLatheFinishDirection

TLatheGrooveBackOffType

TLatheGrooveCycleType

TLatheGrooveFinishDirection

TLatheGrooveRoughDirection

TLatheGrooveSide

TLatheGrooveStepType

TLatheLengthCorrector

TLatheMachiningSide

TLatheRoughDirection

TLatheRoughStepValueType

TLatheShapeFinishDirection

TLatheShapeMultilayerDepthType

TLatheShapeMultilayerDirection

TLatheShapeRoughDirection

TLatheShapeThreadCycleType

TLatheThreadBaseDepth

TLatheThreadCycleType

TLatheThreadDepthMode

TLatheThreadLeadType

TLatheThreadSequenceType

TLatheWidthCompensationType

TLatheZigzagCannedCycle

TLatheZigzagChipBreakingCondition

TLatheZigzagChipBreakingRepetition

TLatheZigzagChipBreakingReturn

TLatheZigzagDelayDuration

TLatheZigzagMultilayerDepthType

TLatheZigzagMultilayerReturnType

TLatheZigzagPasses

TLatheZigzagSmartOverlap

enumTLatheApproachFeed

Approach feedrate kind (Leads → Approach.Feed)

enumTLatheApproachMode

Approach mode (Leads → Approach.Mode)

enumTLatheChamferMode

Chamfer end-of-thread mode (ThreadForm.Chamfer.Mode). Hidden for LongHand / G32-G33 format, visible for CannedCycle and SingleBlockCycle formats.

enumTLatheChipBreakingDwellMode

Chip-breaking Dwell mode (XML: TDwellParam.DwellMode).

enumTLatheCompensationType

Cutter radius compensation kind (Offset Roughing only)

enumTLatheContourCycleType

Active cycle of a lathe-contouring model item. Not all containers accept every value — Facing accepts only lcctProfile, lcctOffsetLegacy and lcctOffsetRoughing.

enumTLatheEngageRetractType

Engage / Retract shape (Leads tab)

enumTLatheFeedRelativeMeasurement

Override-feed measurement (Override Feeds tab → Measurement field of TFeedCanBeRapid)

enumTLatheFinishDirection

Zigzag finish-pass direction (TZigzagLatheCycle Toolpath.FinishDirection)

enumTLatheGrooveBackOffType

Back-off type — discriminator for DistanceValue / PercentValue (XML: TGrooveBackOff.BackOffType on Toolpath.BackOff — TAdvancedLatheCycle75 only).

enumTLatheGrooveCycleType

Active cycle of a grooving model item (TLatheGroovingModelItem). A different enum from TLatheContourCycleType — Grooving has its own set of allowed cycles (TSGrooveCycle / TAdvancedLatheCycle75 plus the shared Profile and Zigzag).

enumTLatheGrooveFinishDirection

Groove finish-pass direction (XML: Toolpath.FinishDirection). Distinct from the Zigzag FinishDirection enum — Groove cycles accept ToCenter (default), Forward and Backward.

enumTLatheGrooveRoughDirection

Groove rough-passes direction (XML: Toolpath.RoughDirection).

enumTLatheGrooveSide

Groove machined side (XML: TGrooveCycle CycleParameters.Side). Tool-tip position discriminator — distinct from the Lathe MachiningSide (lmsLeft/lmsRight). Calls to ICamApiLatheCycleCommon.MachiningSide on a grooving item read this same XML node but interpret values incorrectly; use ICamApiLatheCycleGroove.Side instead.

enumTLatheGrooveStepType

Step value type — discriminator for DistanceValue / PercentValue (XML: LatheGrooveStepType on Toolpath.RoughStep, Toolpath.MaxScallop and on AdjustSize within RoughStep.AdjustStep).

enumTLatheLengthCorrector

Length corrector slot (Compensation block)

enumTLatheMachiningSide

Cutting side relative to the profile (Common tab → Side)

enumTLatheRoughDirection

Roughing cycle pass direction (Direction field on TLatheCycle71 / TAdvancedLatheCycle71)

enumTLatheRoughStepValueType

Rough step value type (TLatheRoughStep.ValueType)

enumTLatheShapeFinishDirection

Finish-pass machining direction for shape-thread finishing (TLatheShapeThreadCycle Finishing.Direction — TThreadMachiningDirection)

enumTLatheShapeMultilayerDepthType

Depth-type discriminator for shape-thread roughing multilayer (Roughing.Multilayer.DepthType — CountValue vs DepthValue)

enumTLatheShapeMultilayerDirection

Layer machining direction for shape-thread roughing multilayer (Roughing.Multilayer.LayerMachiningDirection)

enumTLatheShapeRoughDirection

Rough-pass machining direction for shape-thread roughing (TLatheShapeThreadCycle Roughing.Direction — TGrooveMachiningDirection)

enumTLatheShapeThreadCycleType

Active cycle of a shape-threading model item (TLatheShapeThreadingModelItem). Used together with a shape-thread-profile model item to drive non-cylindrical thread paths.

enumTLatheThreadBaseDepth

Cut-count discriminator for ThreadSequence (ThreadSequence.BaseDepth). Determines which value slot in TLatheThreadSequence is meaningful.

enumTLatheThreadCycleType

Active cycle of a threading model item (TLatheThreadingModelItem). Used by TLatheODThreading / TLatheIDThreading operations.

enumTLatheThreadDepthMode

How cut depths are determined (ThreadSequence.DepthMode)

enumTLatheThreadLeadType

Triple stock allowance — radial / axial / profile (XML: TTripleStock) Engage or retract lead parameters (XML: TSimpleLatheEngageRetract) Approach segment of Leads tab Offset Roughing → Start point increments Offset Roughing → Check workpiece sub-block Roughing → Check workpiece (TAdvancedLatheCycle71 — only Enabled+IgnoreGaps, unlike TAdvancedLatheCycle73 which has the full TLatheCheckWorkpiece block) Rough-step value (TLatheCycle71 / TAdvancedLatheCycle71 → CycleParameters.RoughStep). Use ValueType to interpret which Value* slot is meaningful. Chip-breaking sub-block (TLatheCycle71 / TAdvancedLatheCycle71 → CycleParameters.ChipBreaking). Dwell parameters are accessible via the separate ICamApiLatheCycleChipBreakingDwell interface (QueryInterface on the same ActiveCycle object), so the layout of this record stays stable for binary compatibility. Check-workpiece block of the Groove cycle (XML: CycleParameters.CheckWorkpiece — narrower than the Lathe variants, only Enabled and StartEntryAmount are present). Engage- or retract-side feed/compensation block of the Groove cycle (XML: CompensOnCut / CompensOffCut — same shape). Both blocks are visible only when Passes is not RoughOnly. Lead/pitch type discriminator (ThreadForm.Lead.LeadType). Use to interpret which Value* slot in TLatheThreadLead is meaningful.