CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Namespace CAMAPI.ModelFormerTypes

    Interfaces

    ICamApiAreaModelItem

    Area model item interface

    ICamApiBaseSurface

    Base surface configuration for engraving / curve-on-surface operations. Wraps the Delphi IBaseSurfaceEditor. The object is a singleton owned by the model former — every call to ICamApiModelFormerWithBaseSurface.BaseSurface returns the same underlying editor. Setting a property mutates the former state immediately; no Apply/Commit is needed.

    ICamApiBossProbingCycle

    Boss probing cycle geometry. XML type: TBossProbingCycle.

    ICamApiBoxLinkPrimitiveModelItem

    ICamApiBoxPrimitiveModelItem

    ICamApiBridgeParams

    Configuration bag for bridge (tab) generation. Obtain via ICamApiModelFormerWithBridges.CreateBridgeParams, fill the desired fields, then pass to GenerateBridges. All fields map to entries in TCurveOpBridgeCreator's XML schema. Defaults on a fresh instance mirror the default values from CurveOpBridgeCreator.xml (Scope=ClosedAndUnclosed, SelectedOnly=false, ReplaceExistingBridges=true, TabSize=Default, TabHeight=Default, Strategy=Count/DesiredBridgeCount=1/AvoidCorners=true).

    ICamApiCalibratePartProbeProbingAction

    Calibrate Part Probe action. XML type: TCalibratePartProbeCycleAction. Calibrates the part-measurement probe against a reference surface.

    ICamApiCalibrateToolProbeProbingAction

    Calibrate Tool Probe action. XML type: TCalibrateToolProbeCycleAction. Calibrates the tool-length probe against a reference tool.

    ICamApiCastingPrimitiveModelItem

    Casting (stock-offset) workpiece primitive item. Wraps TStockLinkItem — the part model geometry with a uniform stock offset.

    ICamApiCheckBrokenToolProbingAction

    Check Broken Tool action. XML type: TCheckBrokenToolCycleAction. Inherits TSetToolOffsetCycleAction — same ToolNumber/Corrector fields. Compares the measured value against the stored offset to detect tool breakage.

    ICamApiCoordinateItem

    ICamApiCurve2DModelItem

    ICamApiCurve2DModelItemWithBridges

    Mixin on ICamApiCurve2DModelItem giving typed access to the list of bridges (tabs) placed on this curve. Obtain via QueryInterface from a curve item returned by AddCurves2DSelected / GetItem on a curve2D former. Implemented by TCurveOpAddInfo.

    ICamApiCurve5DModelItem

    ICamApiCurveBridgeModelItem

    Single bridge (tab) on a 2D curve model item. Obtained from ICamApiCurve2DModelItemWithBridges.GetBridge / AddBridge. The bridge lives inside the parent curve item; if the parent curve removes or replaces its bridges (DeleteBridge, ClearBridges, or re-run of GenerateBridges), previously returned wrappers become invalid — re-acquire via GetBridge.

    ICamApiCurveModelItem

    ICamApiCurvesArrayModelItem

    ICamApiCustomProbingAction

    A single custom property inside a cycle. XML type: TProbingCycleCustomProp. Used both as a standalone action (Phase 7) and as a member of a group (Phase 6).

    ICamApiCustomPropGroupProbingAction

    Custom property group action. XML type: TProbingCycleCustomPropGroup. Container that holds multiple ICamApiCustomProbingAction items.

    ICamApiCylinderPrimitiveModelItem

    ICamApiDoubleWallExternalCornerCycle

    Double wall external corner probing cycle. XML type: TDoubleWallExternalCornerCycle.

    ICamApiDoubleWallInternalCornerCycle

    Double wall internal corner probing cycle. XML type: TDoubleWallInternalCornerCycle.

    ICamApiDriveFaceModelItem

    Model item representing a drive face (added via ICamApiModelFormerWithDriveFaces.AddDriveFacesSelected)

    ICamApiEmptyWorkpieceModelItem

    ICamApiExternalRectangleProbingCycle

    External rectangle probing cycle geometry. XML type: TExternalRectangleCycle.

    ICamApiFaceModelItem

    ICamApiFacesArrayModelItem

    ICamApiFeedPointList

    ICamApiFixtureComponentItem

    Fixture component item: chuck, vise, or clamp root (TFxComponentItem). Holds base visual properties plus component-type classification.

    ICamApiFixtureConnectorItem

    Fixture connector item: root node that links to a machine workpiece holder (TFxMachineConnectorItem). Holds base visual properties plus connector index.

    ICamApiFixtureNodeItem

    Fixture node item: a single axis/node in the fixture tree (TFxAxisItem). Holds base visual properties plus axis kinematics.

    ICamApiFrameOutputProbingCycle

    Frame output probing cycle. XML type: TFrameOutputProbingCycle. TargetFrame and ParentFrame are 4x4 homogeneous matrices (position + XYZ Euler rotation in degrees). FrameOutputFormat: 0=Matrix, 1=Quaternion, 2=EulerXYZ, ...

    ICamApiGeom25DModelItem

    Model item representing 2.5D geometry (added via ICamApiModelFormerWithGeom25D.AddSelected25D)

    ICamApiGeomModelBoxPrimitiveModelItem

    ICamApiGeometryNodeBasedModelItem

    ICamApiGrooveProbingCycle

    Groove probing cycle geometry. XML type: TGrooveProbingCycle.

    ICamApiGrooveProbingProtectedCycle

    Groove probing protected cycle geometry. XML type: TGrooveProbingCycleProtected.

    ICamApiHoleCylinderPrimitiveModelItem

    ICamApiHoleModelItem

    ICamApiHoleProbingCycle

    Hole probing cycle geometry. XML type: THoleProbingCycle.

    ICamApiHoleProbingProtectedCycle

    Hole probing protected cycle geometry. XML type: THoleProbingProtectedCycle.

    ICamApiHoleSpecList

    Accumulates hole specifications for AddHolesBatch. Carries common settings (LCS, Top/Bottom levels) applied to every hole, plus pattern-specific Add* methods that generate multiple holes at once.

    ICamApiInternalRectangleProbingCycle

    Internal rectangle probing cycle geometry. XML type: TInternalRectangleCycle.

    ICamApiInternalRectangleProbingProtectedCycle

    Internal rectangle probing protected cycle geometry. XML type: TInternalRectangleProtectedCycle.

    ICamApiJobZoneModelItem

    ICamApiLevelModelItem

    ICamApiLineModelItem

    ICamApiLinkModelItem

    ICamApiListModelItem

    ICamApiMeshesArrayModelItem

    ICamApiModelFormer

    Model former for technology operation

    ICamApiModelFormerMakeSupportedItems

    Callback method, to be called to fill supported items

    ICamApiModelFormerSupportedItems

    List of supported items for model former

    ICamApiModelFormerWithAreas

    Interface for model former with areas

    ICamApiModelFormerWithBaseSurface

    Model former mixin for operations that support a base surface (engraving, 2D contouring, drive-face machining). Provides access to the singleton base surface configuration via the BaseSurface property. Implemented by TCurveOpModelFormer and TEngraveModelFormer.

    ICamApiModelFormerWithBoxPrimitives

    ICamApiModelFormerWithBridges

    Model former mixin for contour-based operations (TSTCurveOp descendants) that support adding bridges (tabs) as sub-items on curve model items. Mirrors the "Add tabs" UI dialog (CurveBridgeCreateForm). Implemented by TCurveOpModelFormer.

    ICamApiModelFormerWithCastingPrimitive

    Model former that can add a casting primitive workpiece.

    ICamApiModelFormerWithChamferFaces

    Model former that supports adding chamfer faces from the current geometry selection (used by the Chamfering operation — "Add Face" button)

    ICamApiModelFormerWithCurve2D

    ICamApiModelFormerWithCurve5D

    ICamApiModelFormerWithCylinderPrimitives

    ICamApiModelFormerWithDriveFaces

    Model former that supports adding drive faces from the current geometry selection

    ICamApiModelFormerWithFaces

    ICamApiModelFormerWithFixtures

    Model former mixin for mftFixtures (TFixturesFormer). Provides factory methods to add common fixture component types. Each method creates the standard component sub-tree and returns its root connector item.

    ICamApiModelFormerWithGeom25D

    Model former that supports adding 2.5D geometry from the current geometry selection

    ICamApiModelFormerWithHoles

    ICamApiModelFormerWithJobMode

    Model former mixin for the swarf operation (TSwarfOpModelFormer). Exposes the "Drive mode" toggle between bottom-edge and two-curves machining. Obtained via QueryInterface; other operations do not expose it.

    ICamApiModelFormerWithLevels

    ICamApiModelFormerWithPnPItems

    Model former mixin for TSTPointPickAndPlaceOp (TPnPPointJobModelFormer). Provides access to all Pick and Place items: Start, Pick, Place, End, and intermediate Move points.

    ICamApiModelFormerWithPocket

    Model former that supports adding pocket features from the current geometry selection

    ICamApiModelFormerWithPointWeldingItems

    Model former mixin for TSTPointWeldingOp (TPointWeldingJobModelFormer). Provides ordered Move + Weld point management and the template properties applied to auto-created clearance/engage/retract sub-points on every new weld point. Template semantics: the ClearanceXxx / EngageXxx / RetractXxx / FixVX properties are read at weld-point creation time (AddWeldItemBefore / AddWeldItemAfter). Mutating them later does not retroactively update already-created weld points.

    ICamApiModelFormerWithPolygonalPrism

    Model former that supports adding a polygonal prism workpiece primitive.

    ICamApiModelFormerWithPrism

    Model former that supports adding a prism (extrude) item from the selected 2D contour geometry. Used by the workpiece-setup toolbar "Extrude" button.

    ICamApiModelFormerWithProbingItems

    Interface for model former of probing operations. Allows programmatic manipulation of job assignment items (movements, cycles, groups).

    ICamApiModelFormerWithProjectCurves

    Model former that supports adding project curves from the current geometry selection

    ICamApiModelFormerWithReferenceToPrevious

    ICamApiModelFormerWithSharpEdge

    Model former that supports adding sharp edges from the current geometry selection (used by the Chamfering operation — "Add Sharp Edge" button)

    ICamApiModelFormerWithSolid

    Model former that supports adding a sewn solid assembled from the current geometry selection. Used by the workpiece-setup toolbar "Faces" button (quick-add path) — surfaces of the selection are sewn into one solid with the given tolerance.

    ICamApiModelFormerWithTurnGeometry

    Model former that supports adding turn geometry from the current geometry selection

    ICamApiModelFormerWithTurnMachineModel

    Model former interface for TTurnMachineModelFormer — exposes SetItemMode (controls the default zone mode applied to newly added items)

    ICamApiModelFormerWithTurnWorkpiece

    Model former that supports adding a turn workpiece primitive.

    ICamApiModelFormerWithZones

    ICamApiModelItem

    ICamApiModelItemReference

    ICamApiNcActionProbingCycle

    NC action probing item. XML type: TNCActionProbingItem. OutputMode: 0 = EXTCYCLE, 1 = INSERT.

    ICamApiPnPClearanceItem

    Clearance point — auto-created child of Pick and Place items

    ICamApiPnPEndItem

    End point of a Pick and Place operation

    ICamApiPnPMoveItem

    Intermediate move point of a Pick and Place operation

    ICamApiPnPPickItem

    Pick point of a Pick and Place operation

    ICamApiPnPPlaceItem

    Place point of a Pick and Place operation

    ICamApiPnPStartItem

    Start point of a Pick and Place operation (read-only)

    ICamApiPocketModelItem

    Model item representing a pocket (added via ICamApiModelFormerWithPocket.AddPocketSelected)

    ICamApiPointModelItem

    ICamApiPointWeldingMoveItem

    Intermediate move point of a Point Welding operation (TMovePoint on TPointWeldingJobModelFormer).

    ICamApiPointWeldingWeldItem

    Weld point of a Point Welding operation (TWeldPoint on TPointWeldingJobModelFormer). Same surface as the move point; distinguished only by the interface type (QueryInterface). Auto-created clearance / engage / retract sub-points are not exposed — configure their defaults via the ClearanceXxx / EngageXxx / RetractXxx properties on ICamApiModelFormerWithPointWeldingItems before adding a new weld point.

    ICamApiPolygonalPrismModelItem

    Polygonal prism workpiece primitive item. XML type: TSimplePolygonalPrism. A prism with a regular polygon cross-section (e.g. hexagonal bar stock).

    ICamApiPrismModelItem

    Model item representing an extrude (prism) built from selected 2D contour geometry (added via ICamApiModelFormerWithPrism.AddPrismSelected on a workpiece former).

    ICamApiProbingAction

    Base interface for any probing cycle action (element of the CycleActions array). Use QueryInterface / AsInstanceOf to narrow to a specific typed action interface.

    ICamApiProbingCycle

    Typed access to common probing cycle properties. Available only on items whose XML type inherits from TProbingCycle. Use QueryInterface / AsInstanceOf to obtain this interface from ICamApiProbingModelItem.

    ICamApiProbingModelItem

    Probing job assignment item (cycle, movement, group, etc.) Provides access to the item's XML properties for reading and writing parameters.

    ICamApiProbingModelItemIterator

    Cursor-style iterator over the probing job assignment tree. Supports depth-first traversal via MoveToChild / MoveToSibling / MoveToParent. Use Reset() to return to the first root-level item.

    ICamApiProbingTemplate

    A single probing cycle template stored in a library.

    ICamApiProbingTemplateLibrary

    A probing template library (.scpbl file).

    ICamApiProjectCurveModelItem

    Model item representing a project curve (added via ICamApiModelFormerWithProjectCurves.AddProjectCurvesSelected)

    ICamApiRestrictedZoneModelItem

    ICamApiSetToolOffsetProbingAction

    Set Tool Offset action. XML type: TSetToolOffsetCycleAction. Writes the measured offset into the tool compensation register after probing.

    ICamApiSetWcsProbingAction

    Set WCS action. XML type: TSetWCSCycleAction. Activates a work coordinate system (WCS) offset after probing.

    ICamApiSimpleBoxPrimitiveModelItem

    ICamApiSimpleCylinderPrimitiveModelItem

    ICamApiSolidModelItem

    Model item representing a sewn solid built from selected faces (added via ICamApiModelFormerWithSolid.AddSolidSelected on a workpiece former). Exposes all 4 editable properties of TSolidItem so the caller does not need to QI to ICamApiFaceModelItem just to read/write Stock — Stock here delegates to the inherited TFacesItem.Stock, both interfaces stay valid on the same instance.

    ICamApiSurfaceProbingCycle

    Typed access to surface probing cycle geometry. Available only on items whose XML type inherits from TSingleSurfProbingCycle.

    ICamApiThreePointsWebProbingCycle

    Three-points web probing cycle geometry. XML type: TThreePointsWebProbingCycle.

    ICamApiTripleWallExternalCornerCycle

    Triple wall external corner probing cycle. XML type: TTripleWallExternalCornerCycle.

    ICamApiTripleWallInternalCornerCycle

    Triple wall internal corner probing cycle. XML type: TTripleWallInternalCornerCycle.

    ICamApiTurnGeometryModelItem

    Model item representing turn geometry (added via ICamApiModelFormerWithTurnGeometry.AddTurnSelected)

    ICamApiTurnMachineModelItem

    Model item representing turn machine geometry (added via ICamApiModelFormerWithTurnGeometry.AddTurnSelected on a TTurnMachineModelFormer / TSCLatheExtOpConnector)

    ICamApiTurnWorkpieceModelItem

    Turn workpiece primitive item. XML type: TTurnLinkItem. A solid of revolution computed from the part geometry envelope.

    ICamApiWebProbingCycle

    Web probing cycle geometry. XML type: TWebProbingCycle.

    ICamApiWeldSeamModelItem

    Weld seam model item (item type "WeldSeam" on TWeldingOp5D / TWeldingOp6D formers, added via ICamApiModelFormer.AddSupportedItemsSelected("WeldSeam", ...)). Implemented by TWeldSeamModelItem. TWeldSeamModelItem extends TProjectCurvesItem, so the same instance also exposes ICamApiCurve5DModelItem (Stock, AlternateDirection, AlternateFrontSide, curve geometry, tool vectors, feed points) and ICamApiProjectCurveModelItem (ProjectMethod, Is5dCurve) via QueryInterface on the same ICamApiModelItem. This interface adds per-item Multipass override access: when MultipassOverrideEnabled=true the item uses its own passes list; otherwise the operation-wide Multipass configuration applies.

    ICamApiWriteToReportProbingAction

    Write To Report action. XML type: TWriteToReportCycleAction. Stores the measured value into a report with a component/feature index. ComponentNumber and FeatureNumber use explicit (fixed) mode when set via this API.

    Enums

    TBridgeDimMode

    TBridgeHeightMode

    TBridgePlacement

    TBridgeScope

    TCylinderAxisType

    TFixtureAddType

    TFixtureAxisType

    TFixtureCollisionDetectionMode

    TFixtureComponentType

    THoleBottomLevelMode

    THoleDrillTipCompensation

    THolePatternParallelogramStepMode

    THoleTopLevelMode

    TModelCurveType

    TModelCurveTypeSetFlag

    TModelFaceType

    TModelFaceTypeSetFlag

    TModelFormer25DAddMode

    TModelFormerAreaMode

    TModelFormerBaseSurfacePrimitiveType

    TModelFormerBaseSurfaceProjectMethod

    TModelFormerCurveDistribution

    TModelFormerDefinitionMethod

    TModelFormerFeedRateChangeType

    TModelFormerFeedType

    TModelFormerGeom25DProfileMode

    TModelFormerInterpolationMode

    TModelFormerJobMode

    TModelFormerLevelType

    TModelFormerParallelStepMethod

    TModelFormerPnPAxesMode

    TModelFormerPnPClearanceType

    TModelFormerPnPMotionType

    TModelFormerPnPRelativeType

    TModelFormerPointWeldingMotionType

    TModelFormerPointWeldingPositionType

    TModelFormerProjectMethod

    TModelFormerRefToPrevType

    TModelFormerTurnMachineItemMode

    TModelFormerType

    TModelFormerZoneContactMode

    TModelItemRole

    TModelItemType

    TProbingCustomPropType

    TProbingFeed

    TProbingTransition

    TProbingWcsOffsetMode

    TSimpleBoxPrimitiveCreationMethod

    enumTCylinderAxisType

    enumTFixtureAddType

    Type of fixture item to add — maps to the corresponding factory method on ICamApiModelFormerWithFixtures.

    enumTFixtureAxisType

    Axis motion type of a fixture node item.

    enumTFixtureCollisionDetectionMode

    Collision detection mode for a fixture item.

    enumTFixtureComponentType

    Component type of a fixture item (chuck, vise, or clamp).

    enumTHoleBottomLevelMode

    enumTHoleDrillTipCompensation

    enumTHolePatternParallelogramStepMode

    Step distribution mode for the Parallelogram hole pattern

    enumTHoleTopLevelMode

    enumTModelFormerDefinitionMethod

    Type of primitive

    enumTModelFormerFeedRateChangeType

    Type of changing feed rate at the feed point

    enumTModelFormerFeedType

    Feed type

    enumTModelFormerInterpolationMode

    Interpolation mode for model former with curve 5D

    enumTModelFormerJobMode

    Drive mode of a swarf job assignment (UI "Drive mode"). Persists as the operation's JobMode XML field.

    enumTModelFormerLevelType

    enumTModelFormerPnPAxesMode

    Axes mode for Pick and Place clearance items

    enumTModelFormerPnPClearanceType

    Clearance position type for Pick and Place clearance items

    enumTModelFormerPnPMotionType

    Motion type for Pick and Place points

    enumTModelFormerPnPRelativeType

    Relative point type for Pick and Place move items

    enumTModelFormerPointWeldingMotionType

    Motion command type for Point Welding items (how the robot traverses between points). Mirrors Delphi TMotionCommandType.

    enumTModelFormerPointWeldingPositionType

    Position type for Point Welding items (move, weld, and the template defaults on the former). Mirrors Delphi TPositionType.

    enumTModelFormerRefToPrevType

    Type of reference to previous operation

    enumTModelFormerZoneContactMode

    enumTProbingCustomPropType

    Value type of a custom probing property (TProbingCycleCustomProp). Matches the PropType integer stored in XML (ptDouble=0, ptInteger=1, ptBoolean=2, ptString=3).

    enumTProbingFeed

    Feed type for probing transition

    enumTProbingTransition

    Transition type between probing items

    enumTProbingWcsOffsetMode

    WCS offset mode for TSetWCSCycleAction. Controls how the CS number (G-code offset register) is determined.

    enumTSimpleBoxPrimitiveCreationMethod

    tagTBridgeDimMode

    Dimension mode for bridge size (and common percentage-value fields like linear/area density, merge-tabs value) — value is interpreted either as an absolute distance or as a percentage of the tool nominal diameter.

    tagTBridgeHeightMode

    Dimension mode for bridge height — distance/percent like TBridgeDimMode plus FullHeight (bridge spans the entire tab gap).

    tagTBridgePlacement

    Bridge placement strategy. Each variant has its own set of parameters — use the matching SetStrategyIsXxx/GetStrategyIsXxx method on ICamApiBridgeParams.

    tagTBridgeScope

    Contour scope filter for bridge (tab) generation — selects which curves participate based on closed/open state.

    tagTModelCurveType

    tagTModelCurveTypeFlag

    tagTModelFaceType

    tagTModelFaceTypeFlag

    tagTModelFormer25DAddMode

    Add mode for 2.5D geometry model former

    tagTModelFormerAreaMode

    Area addition modes for model former

    tagTModelFormerBaseSurfacePrimitiveType

    Primitive type of a base surface (TEngraveModelEditorItem.PrimitiveType).

    tagTModelFormerBaseSurfaceProjectMethod

    Method used to project curves onto the base surface (TEngraveModelEditorItem.CurvesProjectMethod).

    tagTModelFormerCurveDistribution

    Start point distribution for drive face model item

    tagTModelFormerGeom25DProfileMode

    Profile mode for 2.5D geometry model item

    tagTModelFormerParallelStepMethod

    Step calculation method for drive face model item

    tagTModelFormerProjectMethod

    Projection method for project curve model item

    tagTModelFormerTurnMachineItemMode

    Item mode for TTurnMachineModelFormer — controls how the working zone is defined

    tagTModelFormerType

    tagTModelItemRole

    Job-assignment role of a model item — the semantic kind used to decide which ICamApiModelFormerWith* / Add...Selected method produced it. Unlike ItemType (coarse geometric shape) or ItemGUID (per-class type GUID), Role is the flat classification a rebind/replace workflow needs. For amirLevel use ICamApiLevelModelItem.LevelType to distinguish Top/Bottom.

    tagTModelItemType

    In this article