Click or drag to resize

Woodwork.Automation Namespace

 
Interfaces
 InterfaceDescription
Public interfaceAggregate Represents an aggregate in the woodwork automation system. An aggregate is a logical grouping of coordinated manufacturing operations, such as multi-drill units, that perform integrated actions on workpieces. Aggregates enable efficient management of complex operations requiring synchronized execution and shared configuration parameters throughout the manufacturing workflow.
Public interfaceArc Represents an arc geometry element in the woodwork automation system. An arc is a curved segment in three-dimensional space defined by start and end points, a center location, radius, and curvature characteristics. Arcs are fundamental building blocks used in manufacturing geometry definitions for creating smooth curves in contours, cutting paths, and tool trajectories essential to woodwork CNC machining operations.
Public interfaceArcLead Represents an arc-based lead geometry in the woodwork automation system. An arc lead is a curved transition path that guides the tool safely into or out of a cutting operation. Arc leads provide smooth, tangential tool entry and exit points with specific radius and angle characteristics, improving cut quality and reducing tool stress during CNC machining operations.
Public interfaceClamping Represents a clamping system in the woodwork automation system. A clamping system secures workpieces on the CNC machine during manufacturing operations. It maintains the type of material being clamped (part or workpiece), clamping corner location, and the collection of sides and operations associated with the clamped configuration, enabling safe and precise positioning throughout the manufacturing workflow.
Public interfaceContour Represents a contour in the woodwork automation system. A contour is a continuous path composed of geometric elements that define the boundary or trajectory for manufacturing operations like cutting and milling. Contours can be open or closed and serve as the primary means of specifying detailed cutting paths and geometric features in the woodwork automation workflow.
Public interfaceContourGeometry Represents contour geometry in the woodwork automation system. Contour geometry defines the shape and dimensional parameters for manufacturing features, supporting either rectangular or circular contour types as specified by ContourGeometryTypeEnum. It maintains the geometric elements, dimensions, corner rounding, and rotation orientation necessary to describe and position manufacturing features precisely during the machining process.
Public interfaceCoordinateSystem Represents a coordinate system in the woodwork automation system. A coordinate system establishes a spatial reference frame defined by an origin point and three orthogonal axes (X, Y, Z). It provides the foundation for positioning, orientation, and geometric calculations essential to manufacturing operations. Coordinate systems enable flexible transformation and alignment of manufacturing elements to different reference frames through rotation and translation operations throughout the workflow.
Public interfaceCover Represents a cover in the woodwork automation system. A cover is a material layer applied to workpiece surfaces to provide finishing, protection, or aesthetic qualities. Covers are defined by their material type (paint, edge band, veneer, vacuum film, or multilayer), thickness, and the geometric boundaries specifying where the cover is applied on the workpiece.
Public interfaceCutCalibrationOperation Represents a cutting calibration operation in the woodwork automation system. The cut calibration operation is a sawing operation intended to bring the raw material to the required size.
Public interfaceCutCalibrationTrajectory Represents a cutting calibration trajectory in the woodwork automation system. A cut calibration trajectory defines the complete movement sequence for a calibration cutting operation.
Public interfaceCutOperation Represents a cutting operation in the woodwork automation system. A cut operation performs a separation process that cuts through the workpiece material completely, typically along the edge or outline using a saw blade. Cutting operations are essential for sizing and shaping workpieces with support for main cuts and optional scoring cuts to achieve clean edges and precise final dimensions in the woodwork manufacturing workflow.
Public interfaceCutPath Represents a cutting path in the woodwork automation system. A cut path is a complete cutting operation definition including lead-in, main cut, and lead-out segments. Cut paths manage the offset direction and lead behaviors necessary for smooth, safe cutting transitions, ensuring proper tool entry and exit from the workpiece material while maintaining cut quality and precision in CNC machining operations.
Public interfaceCutPaths Represents a collection of cutting paths in the woodwork automation system. Cut paths collection organizes coordinated cutting operations including main cut and optional scoring cut sequences. Together, these paths define the complete cutting strategy for a manufacturing process, enabling complex multi-step cutting strategies to be managed as a unified operation while maintaining clean edges and precise dimensions throughout the woodwork CNC machining workflow.
Public interfaceCuttingParameters Represents cutting parameters in the woodwork automation system. Cutting parameters define the operational characteristics and motion speeds for cutting operations, including spindle rotation speed and various tool feedrates for different phases of the cutting sequence. These parameters optimize tool performance, material removal efficiency, and edge quality throughout the woodwork CNC cutting workflow.
Public interfaceCutTrajectory Represents a cutting trajectory in the woodwork automation system. A cut trajectory defines the complete movement sequence for a cutting operation, including tool engagement, cutting path execution, and tool disengagement with specific depth, width, and allowance parameters. Cut trajectories manage main cuts and optional scoring cuts to ensure clean, precise cuts through the workpiece material in CNC cutting operations.
Public interfaceDrillHeadSequence Represents a drilling tools sequence in the woodwork automation system. A drill head sequence is an organized collection of drilling tools that are executed in a specific order to perform coordinated multi-hole drilling operations. The sequence maintains information about each tool's position, properties, and execution parameters, enabling efficient tool changes and coordinated drilling throughout the manufacturing process.
Public interfaceDrillHeadTool Represents a drilling tool within a drill head sequence in the woodwork automation system. A drill head tool defines an individual tool configuration with specific positioning, direction constraints, and compensation parameters used during coordinated multi-hole drilling operations. Each tool maintains its own code, setup commands, and geometric properties that define its behavior within the larger multi-drill aggregate manufacturing process.
Public interfaceDrillOperation Represents a drilling operation in the woodwork automation system. A drill operation performs a hole-making process at specific coordinates with defined depth and tool parameters. Drilling operations create holes of precise diameter and depth in workpieces, supporting both through holes (complete penetration) and blind holes (partial penetration) with optional cover detection for material margins.
Public interfaceDrillTrajectory Represents a drilling trajectory in the woodwork automation system. A drill trajectory defines the complete movement sequence for a drilling operation, including approach, penetration, and retraction movements with specific depth parameters and cover detection. Drill trajectories ensure precise hole placement and proper depth control while accounting for material margins (top and bottom covers) to maintain dimensional accuracy in CNC drilling operations.
Public interfaceFormat Represents a format specification in the woodwork automation system. A format defines how numeric values are converted to formatted text strings for output to NC (numerical control) files. Format specifications control decimal precision, sign and zero display, value scaling and offsetting, and text decoration (prefix/suffix), enabling precise control over the appearance and structure of machine-readable output in manufacturing workflows.
Public interfaceGeometry Represents the base contract for all geometric elements in the woodwork automation system. Geometry serves as the fundamental abstraction for all shape and spatial elements, including points, segments, and arcs used in manufacturing geometry definitions. All geometric entities must implement this interface to participate in contours, tool paths, and other geometry-based manufacturing operations throughout the workflow.
Public interfaceGrooveOperation Represents a groove operation in the woodwork automation system. A groove operation creates narrow channels or grooves in the workpiece surface using a saw blade or grooving tool. Groove operations enable precise decorative and functional surface features with configurable tool overlap and multiple trajectory passes for achieving exact groove geometry and surface quality in woodwork manufacturing processes.
Public interfaceGroovePath Represents a groove path in the woodwork automation system. A groove path defines the complete sequence of movements required to create groove features, including lead-in, cutting, optional cleaning pass, and lead-out segments. Groove paths organize tool approach, grooving execution, and tool exit with configurable offset direction and cleaning pass support for achieving precise groove geometry and surface quality in CNC grooving operations.
Public interfaceGrooveTrajectory Represents a groove trajectory in the woodwork automation system. A groove trajectory defines the complete movement sequence for a grooving operation, including tool engagement, groove cutting execution, and tool disengagement with specific depth and width parameters. Groove trajectories manage the grooving path geometry and optional cleaning pass support to ensure precise groove creation with clean surfaces and consistent geometry in CNC grooving operations.
Public interfaceIncrementalVariable Represents an incremental variable in the woodwork automation system. An incremental variable is an auto-incrementing output control that automatically advances by a step value on each format call, useful for generating sequential numbering (line numbers, operation counts, etc.) in NC output files. Incremental variables maintain state between calls and can be forced to output on demand, enabling precise sequencing control with automatic increment progression throughout NC file generation.
Public interfaceJob Represents a manufacturing job in the woodwork automation system. A job is the top-level parent container for all CAM data organizing complete manufacturing tasks that may include multiple operations, multiple parts, or complex production sequences.
Public interfaceLead Represents the base contract for lead geometry in the woodwork automation system. A lead is a transition path that guides the tool safely into or out of a cutting operation. Leads support multiple types for different tool engagement strategies, providing smooth transitions that reduce tool shock, improve cut quality, and enable precise tool control during CNC machining operations throughout the manufacturing workflow.
Public interfaceMachine Represents a CNC machine in the woodwork automation system. A machine defines the physical manufacturing equipment with specific capabilities, dimensions, and operational parameters. Machines establish equipment constraints including clearance heights, safe plane heights, and correction settings, plus available aggregates (specialized manufacturing units) that govern all manufacturing operations in the woodwork automation workflow.
Public interfaceMacroOperation Represents a macro operation in the woodwork automation system. A macro operation is a predefined sequence of manufacturing steps that can be invoked as a single operation. Macro operations encapsulate complex procedures into reusable units with evaluated code output that reflects the computed macro results. Macro operations enable reusable manufacturing procedures and streamline complex process definitions in the woodwork automation workflow.
Public interfaceMainContour Represents a main contour in the woodwork automation system. A main contour defines the primary cutting path for milling operations, including the main geometric boundary with optional orbital landing approach and lead-in/lead-out transitions. Main contours manage tool offset strategy (hardware or software compensation) and offset side positioning to ensure precise cutting geometry and smooth tool transitions in CNC milling operations.
Public interfaceMillCalibrationOperation Represents a milling calibration operation in the woodwork automation system. The cut calibration operation is a milling operation intended to bring the raw material to the required size.
Public interfaceMillCalibrationTrajectory Represents a milling calibration trajectory in the woodwork automation system. A mill calibration trajectory defines the complete movement sequence for a calibration cutting operation.
Public interfaceMillOperation Represents a milling operation in the woodwork automation system. A mill operation performs cutting using rotary cutting tools to remove material along a defined path, creating complex shapes, contours, and surface features. Milling operations support multiple strategies (standard, projected, chipping, group main, edge, rest) and can be projected onto surfaces for complex geometry. Mill operations enable high-precision feature creation essential to woodwork manufacturing with support for variable depth passes and advanced cutting strategies.
Public interfaceMillTrajectory Represents a milling trajectory in the woodwork automation system. A mill trajectory defines the complete path for a milling operation, including cutting path, tool approach, and tool retraction sequences with specific depth, stepover, and allowance parameters. Mill trajectories support optional orbital landing approach, corner recess, and main contour management to ensure precise tool movements and consistent geometry during CNC milling operations.
Public interfaceModalVariable Represents a modal variable in the woodwork automation system. A modal variable is a stateful output control that outputs a value only when it changes from the previous state, reducing redundant code in NC files by suppressing repeated identical values. Modal variables maintain state between calls and can be forced to output on demand, enabling efficient modal group management (G-codes, M-codes, feed rates) in CNC programming where values persist until explicitly changed.
Public interfaceMultiDrillAggregate Represents a multi-drill aggregate in the woodwork automation system. A multi-drill aggregate is a specialized aggregate representing a multi-drill unit of the CNC machine that coordinates multiple drilling sequences arranged in a two-dimensional grid pattern. It maintains the dimensional constraints of the drill grid and manages multiple drill head sequences that execute in a coordinated manner to perform high-speed, multi-hole drilling operations across the workpiece.
Public interfaceNestingOperation Represents a nesting operation in the woodwork automation system. A nesting operation performs cutting using rotary cutting tools to remove material along a defined path, creating complex shapes, contours, and surface features.
Public interfaceNestingOptions Represents output options in the woodwork automation system. Output options define parameters controlling how manufacturing data is exported, formatted, and presented to external systems. Options include output file path, file overwrite behavior, directory organization by material, and nesting operation context. Output options enable customization of system behavior for different operational and integration requirements throughout the manufacturing workflow.
Public interfaceNestTrajectory Represents the nesting-milling operation trajectory in the woodwork automation system. A nesting trajectory defines the complete path for a milling operation, including cutting path, tool approach, and tool retraction sequences with specific depth, stepover, and allowance parameters.
Public interfaceOperatingToolData Represents the operating tool data object that defines the spatial orientation and positioning of a cutting tool during manufacturing operations in the woodwork automation system. The operating tool data encapsulates the tool's three-dimensional vector representation and two rotational angle parameters that collectively establish the tool's precise alignment relative to the workpiece. This includes the tool inclination (tilt angle from vertical) and the rotational position about the vertical axis (rotation angle in the XY plane). These parameters are essential for controlling tool geometry, ensuring proper cut direction, managing tool engagement angles, and optimizing material removal during milling, nesting, and other precision woodworking operations.
Public interfaceOperation Represents a generic manufacturing operation in the woodwork automation system. An operation encapsulates a single, discrete manufacturing task performed on a workpiece during CNC machining. Each operation defines the complete set of parameters required to execute a specific cutting, drilling, milling, or nesting task, including the target spindle with its mounted tool, the workpiece side being machined, the sequence order of execution relative to other operations, and the motion parameters governing tool engagement and movement. Operations serve as the fundamental building blocks of manufacturing workflows, aggregating spindle selection, spatial positioning information, cutting parameters (speeds and feedrates), and tool orientation data into a cohesive execution unit that drives CNC machinery behavior throughout the woodwork manufacturing process.
Public interfaceOrbitalLanding Represents orbital landing geometry in the woodwork automation system. Orbital landing defines a spiral approach path that gradually engages a tool into the workpiece material with controlled depth progression. Orbital landing reduces tool shock and improves surface finish by using a rotating spiral motion for smooth, incremental tool engagement before main cutting operations commence.
Public interfaceOutlineEdge Represents outline edge in the woodwork automation system. Outline edge is applied to workpiece outline side edges.
Public interfaceOutputOptions Represents output options in the woodwork automation system. Output options define parameters controlling how manufacturing data is exported, formatted, and presented to external systems. Options include output file path, file overwrite behavior, directory organization by material, and nesting operation context. Output options enable customization of system behavior for different operational and integration requirements throughout the manufacturing workflow.
Public interfacePart Represents a part or workpiece object in the woodwork automation manufacturing system. A part is a physical material item that undergoes processing through CNC machining operations. Parts are characterized by their dimensional properties (length, width, thickness), material specifications (name and code for tracking and sourcing), and allowance parameters that define material margins for safe machining. The part object aggregates dimensional constraints in both X and Y axes, calibration specifications for precision alignment, material grain direction information for optimized tool path planning, and a collection of surface covers (paint, edge banding, veneer, or other finishes) that define protective or aesthetic finishing layers applied to specific workpiece faces and areas. The part serves as the primary manufacturing entity throughout the workflow, carrying all essential dimensional, material, and finishing information required for complete CNC fabrication.
Public interfacePockOperation Represents a pocketing operation in the woodwork automation manufacturing system. A pocketing operation is a specialized milling task that removes material from a defined region or cavity within a workpiece. Pocketing operations combine multiple cutting trajectories to progressively remove material in layers, optimizing tool engagement and material removal efficiency through step-over patterns and multi-pass strategies. Each pocketing operation inherits all base operation properties (spindle selection, workpiece side, cutting parameters, and tool orientation) while adding pocketing-specific capabilities such as island detection for feature preservation, finish contour refinement, and middle removal phase management. The operation type enumeration specifies whether the pocketing is a standard operation, a projected/grouped main operation, or an additional supplementary operation that refines or completes partial pocketing geometry. Pocketing trajectories collectively define the complete cutting sequence including roughing passes, island avoidance, and final finishing to achieve precise cavity geometry and surface quality in woodwork manufacturing workflows.
Public interfacePockTrajectory Represents a pocketing trajectory in the woodwork automation manufacturing system. A pocketing trajectory defines a complete cutting sequence phase for material removal from a cavity or pocket region within a workpiece. Pocketing trajectories encompass depth management (actual cutting depth, full depth with breakthrough, and intermediate safe/clearance points), tool engagement parameters (step-over distance for cutting passes and overlap for seamless path transitions), and material allowances for finishing operations. Each trajectory aggregates multiple contour types: primary contours that define the pocket boundary geometry, middle removal contours for intermediate material clearance, and finish contours for refined surface quality. The trajectory supports island detection to preserve internal features, optional step-over on finish contours for quality control, and primary contours with down-edge offset for undercut management. Pocketing trajectories work in sequence to progressively remove material while maintaining optimal tool engagement, reducing tool stress, and achieving precise cavity geometry and superior surface finish in woodwork manufacturing.
Public interfacePrimaryContour Represents a primary contour in the woodwork automation manufacturing system. A primary contour defines the geometric boundary and tool path specification for a single manufacturing feature or pocket region. The contour includes offset positioning specification that determines tool path location relative to the feature boundary (left, right, or center offset), island classification to distinguish feature geometry from preserved internal features, and association with a main contour object that provides detailed path composition of segments and arcs. Primary contours serve as the fundamental building blocks for pocket definition, allowing precise control over feature geometry, tool engagement strategy, and complex feature manufacturing in woodwork CNC operations.
Public interfacePrimarySawPath Represents a primary saw path object in the woodwork automation manufacturing system. A primary saw path defines the cutting boundary and tool engagement geometry for saw blade operations on a workpiece. The primary saw path specifies the exact contour that the saw blade must follow to achieve precise material removal, feature definition, and edge processing.
Public interfaceRampLead Represents a ramping lead geometry in the woodwork automation system. A ramp lead is a gradual depth transition path that guides the tool incrementally into the workpiece material. Ramp leads reduce tool shock and improve surface finish by gradually engaging the tool at the proper depth, providing controlled engagement mechanics that enhance safety and precision in CNC machining operations.
Public interfaceReferenceCoordinateSystem Represents a reference coordinate system object in the woodwork automation manufacturing system. A reference coordinate system manages coordinate system transformations through matrix operations that map between global (world) coordinates and custom workpiece-relative coordinates. It supports alignment to predefined clamping positions and workpiece sides by name, custom alignment through explicit X and Y axis vectors, and flexible origin repositioning through vector shifts or explicit point definitions. The reference system maintains an internal transformation matrix that encapsulates the complete spatial mapping, enabling seamless coordinate conversions essential for multi-sided machining workflows, complex feature alignment, and precise tool positioning relative to dynamically changing workpiece orientations throughout the CNC manufacturing process.
Public interfaceReferenceVariable Represents a reference variable in the woodwork automation system. A reference variable is a conditional output control that outputs a value only when it differs from a reference value beyond a specified tolerance threshold. Reference variables optimize NC file size by suppressing output for values within acceptable tolerance of a reference, enabling efficient handling of precision limits (e.g., arc center points, interpolation tolerances). Variables can be enabled/disabled and forced to output on demand for flexible output control.
Public interfaceSegment Represents a line segment geometry element in the woodwork automation system. A segment is a straight line connecting two points in three-dimensional space, forming the basic linear component of contours and cutting paths. Segments are fundamental building blocks used in manufacturing geometry definitions for straight cuts, movements, and linear interpolation operations essential to woodwork CNC machining.
Public interfaceSide Represents a workpiece side or machining surface in the woodwork automation system. A side defines a specific face of the workpiece with its own coordinate system, operations, and manufacturing characteristics. Sides organize manufacturing operations by machining surface and enable multi-sided manufacturing strategies where different operations are performed on different faces of the workpiece in coordinated sequences with optional name and number remapping for flexible manufacturing workflow adaptation.
Public interfaceSideExtendedData Represents extended geometric data for inclined (non-orthogonal) machining planes in the woodwork automation system. Side extended data provides detailed corner point definitions and spatial parameters necessary for precise calculations on inclined surfaces. It includes the four corner points (P1, P2, P3, P4) that define the plane boundaries, elevation and angle parameters that describe plane orientation, and a shift vector for origin positioning adjustments.
Public interfaceSimpleVariable Represents a simple variable in the woodwork automation system. A simple variable is a basic output control that formats numeric values for NC file output with optional enable/disable state management. Simple variables apply formatting rules (decimal precision, sign display, zero padding, prefix/suffix decoration) to produce consistently formatted text strings, enabling straightforward value output without state tracking or conditional logic.
Public interfaceSizeByClamping Represents size and allowance values calculated based on the clamping configuration in the woodwork automation system. Size by clamping defines workpiece or manufacturing area dimensions dynamically determined by clamping system positioning. It includes primary dimensions (length, width, thickness) and directional allowance margins (min/max X and Y) that account for material constraints imposed by the specific clamping setup, enabling accurate modeling of available material for operations.
Public interfaceSpacial Represents spatial operations in the woodwork automation system. Spacial provides factory methods for creating geometric and coordinate system objects essential to manufacturing workflows. It enables creation of fundamental spatial elements including Point (3D locations), Vector (directions and magnitudes), and CoordinateSystem (spatial reference frames) that establish the geometric foundation for all positioning, orientation, and transformation operations throughout the manufacturing workflow.
Public interfaceSpindle Represents a spindle in the woodwork automation system. A spindle is the rotating element of a CNC machine that drives cutting tools during manufacturing operations. Spindles define the tool currently mounted, tool identification method, and rotational characteristics necessary for coordinating tool selection and performance parameters throughout the machining workflow.
Public interfaceTangentLead Represents a tangent-based lead geometry in the woodwork automation system. A tangent lead is a linear transition path that connects smoothly to the main cutting path with continuous tangential orientation. Tangent leads ensure smooth, mathematically continuous transitions without abrupt direction changes, maintaining optimal tool control and cut quality during CNC machining operations by providing predictable entry and exit paths.
Public interfaceTool Represents a cutting tool in the woodwork automation system. A tool defines a physical cutting implement with specific dimensions and operational characteristics. Tools specify cutting capabilities including diameter, working length, and rotation direction that constrain and govern all milling, drilling, and cutting operations in manufacturing processes throughout the woodwork automation workflow.
Public interfaceTrajectory Represents the base contract for all tool trajectories in the woodwork automation system. A trajectory defines the complete path and sequence of movements that a tool follows during a manufacturing operation. Trajectories specify depth progression, lead-in/lead-out behavior, and other kinematic parameters essential for precise CNC execution. All specialized trajectory types (drill, mill, pocket, cut, groove, nesting, calibration) inherit from this interface to maintain consistent trajectory management throughout the manufacturing workflow.
Public interfaceUtility Represents utility functions in the woodwork automation system. Utility provides helper functionality for creating and managing formatted output variables and file operations. It enables creation of format specifications, simple/modal/incremental/reference variables for NC file generation, and file management operations including writing output files and accessing postprocessor information. Utilities enable standardized code formatting and consistent output handling throughout the manufacturing workflow.
Enumerations
 EnumerationDescription
Public enumerationAdditionalMillingTypeEnum Enum for milling operation type
Public enumerationAdditionalPocketingTypeEnum Enum for pocketing operation type
Public enumerationAggregateTypeEnum Enum for aggregate type
Public enumerationClampingBodyTypeEnum Clamping body type enum
Public enumerationClampingCornerEnum Clamping Corner Enum
Public enumerationContourGeometryTypeEnum Contour geometry type enum
Public enumerationCoverTypeEnum Material type enumerator
Public enumerationGeometryTypeEnum Geometry Type Enum
Public enumerationLeadTypeEnum Lead type enumerator
Public enumerationOffsetSideEnum Trajectory offset direction enum
Public enumerationOperationTypeEnum Enum for operation type
Public enumerationPartHoldTypeEnum Specifies the method used to hold part in place during nesting operation to prevent piece from falling.
Public enumerationToolDirectionEnum Specify tool sequence direction enum.
Public enumerationToolRotationDirectionEnum Tool rotation direction enum
Public enumerationToolSpecifyingEnum Tool specifying enum.
Public enumerationTrajectoryOffsetTypeEnum Trajectory offset type enum
Public enumerationTrajectoryTypeEnum Trajectory Type Enum