CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Enum enumTMacroCommandType

    Command type for a single recorded macro step. Values match TCommandType in MacroManager (stable, append-only).

    Namespace: CAMAPI.Macros
    Assembly: CAMAPI.Macros.dll
    Syntax
    public enum enumTMacroCommandType

    Fields

    Name Description
    mctAddCurves2DWithParams
    mctAddFixture
    mctAddFixtureExtrude

    Extrude the selected 2D contour into a prism and add it to the fixtures tree ("Extrude" on the Fixtures tab). Carries Top/Bottom/Stock/ThroughHoles/AxisIndex; replayed via ICamApiModelFormerWithPrism.AddPrismSelected on the fixtures former. Ordinal must stay aligned with TCommandType.ctAddFixtureExtrude.

    mctAddFixtureFaces

    Add the currently selected geometry faces to the fixtures tree ("Add faces" on the Fixtures tab). Payload-less: faces come from separately-recorded select steps; replayed via ICamApiModelFormerWithFixtures.AddFacesSelected. Ordinal must stay aligned with TCommandType.ctAddFixtureFaces.

    mctAddFixtureTurn

    Add a turn (solid of revolution) from the selected generatrix curves to the fixtures tree ("Turn" on the Fixtures tab). Payload-less: curves come from separately-recorded select steps; replayed via ICamApiModelFormerWithTurnGeometry.AddTurnSelected on the fixtures former. Ordinal must stay aligned with TCommandType.ctAddFixtureTurn.

    mctAddFixtureWithCaption
    mctAddGeom25DWithParams
    mctAddHolesWithParams
    mctAddReferenceToPart
    mctAddSupportedItem
    mctAddWorkpiecePrism
    mctAskCamAgent

    Send a free-text instruction to the paired CAM Agent during playback. Two editable params: the instruction text and an "interrupt on error" flag. Ordinal must stay aligned with TCommandType.ctAskCamAgent in MacroManager.

    mctCalculateOperation

    Calculate the toolpath of an operation (the Calculate and Link buttons of the technology tree). Carries the with-links flag; the target operation is the command's own OperationGuid / OperationIndex, replayed via ICamApiTechnologist.CalculateToolpath after the operation is made current. Ordinal must stay aligned with TCommandType.ctCalculateOperation.

    mctCopyOperation

    Copy an operation with its sub-tree in the technology tree (Ctrl+C / Ctrl+V and the duplicate action). Carries the source and the target operation, each as a GUID plus its ordinal in the tree the copy was made from; replayed via ICamApiTechnologist.CopyOperation. Ordinal must stay aligned with TCommandType.ctCopyOperation.

    mctCreateNewHole
    mctCreateOperation
    mctDeleteFixture

    Delete a fixture item selected in the Fixtures tree ("Delete" button / context menu). Carries the item Caption; replayed via ICamApiModelFormerWithFixtures.DeleteItemByCaption. Ordinal must stay aligned with TCommandType.ctDeleteFixture.

    mctDeleteOperationUserParam

    Delete a user-defined operation parameter by its (computed) name. Replayed via ICamApiTechOperation.GetUserParameters().Delete(Name) — no-op if no such parameter.

    mctEditHoleProps
    mctGenerateNCProgram

    Generate NC program (postprocessing). Universal: post type is detected by PostprocessorPath extension (.dll = dotnet, else sppx). OutputFolder + NcFileName apply to sppx; SettingsXml carries the dotnet post settings inline (the dotnet output folder lives inside that XML, so OutputFolder/NcFileName are ignored for dotnet posts).

    mctImportGeomFile

    Import a geometry file from disk the way the Import button of the geometry panel does — both its faces, the open dialog and the recent-files dropdown. Carries the source folder and file name separately (so a step can swap either), plus the path of the tree folder the file went into; replayed via ICAMAPIGeometryImporter.ImportFile. Ordinal must stay aligned with TCommandType.ctImportGeomFile.

    mctJobAssignment
    mctLoadNCProgramFile

    Load an NC program file (G-code, APT, ...) into a G-code based operation the way the Open button of its Job assignment tab does — the dialog and a file dropped into the editor alike. Carries the source folder and file name separately, so a step can swap either; replayed via ICamApiTechOperation.LoadNCProgramFile on the command's operation. Ordinal must stay aligned with TCommandType.ctLoadNCProgramFile.

    mctPnPAddMoveItemAfterPick
    mctPnPAddMoveItemBeforePlace
    mctPnPClearMovePointItems
    mctPnPDeleteMoveItem
    mctRecognizeFeature

    Add hole(s) from a recognized FeatureFinder feature; addressed by base entity RefIDs. Re-recognizes on replay.

    mctRecognizeFeatureByType

    Recognize a feature by type (caft-first authoring). Same data + replay as mctRecognizeFeature; the row picks the feature type first, then the instance.

    mctRenameOperation

    Rename an operation in the technology tree (in-place edit of the row caption, the properties dialog and the technology summary table). Carries the new name; the target operation is the command's own OperationGuid / OperationIndex, replayed via ICamApiTechOperation.Name. Ordinal must stay aligned with TCommandType.ctRenameOperation.

    mctReserved_17
    mctSaveProject

    Save the project the way the Save button and Ctrl+S do. Carries nothing: replay saves whatever project is open, through ICamApiApplicationMainForm.SaveProject. Ordinal must stay aligned with TCommandType.ctSaveProject.

    mctSelectMachine
    mctSelectModelItem
    mctSetAreaItemProperties
    mctSetCurve2DItemProperties
    mctSetCurve5DItemProperties
    mctSetDriveFaceItemProperties
    mctSetFaceItemStock
    mctSetFixtureItemCaption
    mctSetFixtureItemColor
    mctSetFixtureItemPlacement

    Set a fixture item's setup placement (position + orientation) edited in its properties form. Carries the item Caption plus the 4 matrix axis-vectors (vX/vY/vZ/vT); replayed by setting SetupLCS on the resolved connector/component/node. Ordinal must stay aligned with TCommandType.ctSetFixtureItemPlacement.

    mctSetFixtureItemProperties

    Composite edit of a fixture item from its properties form: carries whichever of Caption/Color/Stock/SetupLCS/ClampID actually changed (each gated by a Has-flag), replayed by applying only the changed fields. Ordinal must stay aligned with TCommandType.ctSetFixtureItemProperties.

    mctSetFixtureItemStock
    mctSetFixtureNodeProperties

    Composite edit of a fixture NODE (fiSimple/axis under a component) from its properties form: carries whichever of Caption/Color/Stock/SetupLCS/Visible actually changed (each gated by a Has-flag), replayed by applying only the changed fields on the resolved node. Unlike mctSetFixtureItemProperties it never carries ClampID or ConnectorIndex — those are component/connector concepts. Ordinal must stay aligned with TCommandType.ctSetFixtureNodeProperties.

    mctSetGeom25DItemProperties
    mctSetJobZoneProperties
    mctSetLatheItemActiveCycle

    Switch the active cycle on a lathe contouring model item. ItemCaption identifies the item; CycleType is the enum value name as string (e.g. "lcctProfile", "gcctSlotting", "tcctExpanded", "sctct92").

    mctSetMachineAxisLimits
    mctSetMachineAxisValue
    mctSetMachineFlipEnabled
    mctSetMachineParam

    Set a property of the MACHINE itself — the kit selectors of the Equipment/Machine setup tab (turret block, rotary table, tailstock) and anything else living in the machine's own XML. Carries the XML property path and its new value. Unlike mctSetOperationParam, whose path is resolved against the operation, this one is replayed via ICamApiMachine.XMLProp + ICamApiProject.LoadMachineFromXmlProp, which is what rebuilds the machine after a structural change. Ordinal must stay aligned with TCommandType.ctSetMachineParam.

    mctSetMachineRobot6thAxisControl
    mctSetMachineRobotRailMoveEnabled
    mctSetMachineRobotTableMoveEnabled
    mctSetOperationParam
    mctSetOperationUserParam

    Set a user-defined operation parameter (name/value/comment triple stored in the operation's MCD header/tail template). Identity is Name; Add upserts by Name on replay. Captured via ICamApiTechOperation.GetUserParameters; replayed via the same list's Add.

    mctSetPnPEndItemProperties
    mctSetPnPItemFlip
    mctSetPnPMoveItemProperties
    mctSetPnPPickItemProperties
    mctSetPnPPlaceItemProperties
    mctSetPocketItemProperties
    mctSetProjectCurveItemProperties
    mctSetRestrictedZoneProperties
    mctSetWorkpieceCS
    mctSetWorkpieceConnector
    mctSetWorkpieceItemProperties

    Edit properties of an existing workpiece primitive item (box/cyl/tube/casting), found by ItemCaption — sets RW props in place. ItemClassName selects the field subset.

    mctSetWorkpiecePrimitive
    mctSetWorkpieceSetup
    mctSolidItem
    In this article