geometry.pocket — Cut a pocket by sweeping a face profile into a geometry feature.
feature = geometry.pocket(target, profile, depth, direction) returns a geometry.Feature for target with the linear sweep of profile by depth meters along direction removed.
Syntax
feature = geometry.pocket(target, profile, depth, direction)Inputs
target- Type
Any- Required
- Yes
- Default
- —
- Description
- geometry.Feature to cut.
profile- Type
Any- Required
- Yes
- Default
- —
- Description
- geometry.Feature whose result is a face or sheet.
depth- Type
NumericScalar- Required
- Yes
- Default
- —
- Description
- Positive sweep length in meters.
direction- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Finite nonzero three-element sweep direction.
Returns
feature- Type
Any- Description
- geometry.Feature for target with the swept profile removed.
Errors
RunMat:geometry:pocket:InvalidInput- When
- The wrong number of arguments is passed. target or profile is not a geometry.Feature, depth is not a real numeric scalar, direction is not a finite three-element real vector, or the operand graphs define one feature identity differently. A value violates the feature-graph contract.
- Message
geometry.pocket: invalid input
Behavior
The profile is swept like geometry.extrude to form a cutting tool, which is subtracted from target. The profile must realize as a face or sheet so that the sweep is a solid; at realization the tool must also overlap the target volume.
The feature graphs of target and profile are merged; features they share are kept once. Two graphs that define the same feature identity differently are rejected.
The call records construction intent only. It appends one operation to an immutable, content-addressed feature graph and returns a new geometry.Feature; it does not run a CAD kernel, tessellate, or touch the filesystem. The graph is realized as exact B-rep topology when a .fea geometry declaration that imports the generating function is materialized for meshing or analysis.
All lengths are meters and all angles are radians; there is no unit option. Scalars accept double, single, or an exactly representable integer-class scalar. Vector arguments must be real, finite, non-integer-class numeric arrays with the stated element count; row and column orientation are both accepted.
Every failure, including the wrong number of arguments, a value of the wrong kind, and a value that violates the feature-graph contract (a nonpositive or non-finite length, radius, depth, distance, or angle, or an all-zero direction), raises the builtin's own RunMat:geometry:<name>:InvalidInput identifier, and no value is returned. Feature identities are derived from a digest of each operation, so repeating the same construction yields the same feature identity.
Use in a study
Return the finished part from a pure .m function: geometry.finish(feature) turns the final feature into a geometry.Generated product, and geometry.withRegion publishes typed selections under names. A .fea geometry declaration written as generated by function.<name> calls that function, realizes the exact geometry, and exposes each named selection as output.region.<name> for meshing, material assignment, constraints, and loads.
geometry.facesIntroducedBy(pocketed) selects the pocket walls and floor.
Errors
RunMat:geometry:pocket:InvalidInput reports every failure of the call: the wrong number of arguments, a target or profile that is not a geometry.Feature, conflicting feature definitions, a depth that cannot be converted, or a direction that is not a finite three-element real vector, or a value that violates the feature-graph contract, such as a zero or negative dimension, a non-finite value, or an all-zero direction. A failed call returns nothing, and earlier values are unchanged because builder values are immutable.
Examples
Record a 3 mm deep pocket
plate = geometry.box(80e-3, 50e-3, 8e-3);
profile = geometry.box(20e-3, 10e-3, 1e-3);
pocketed = geometry.pocket(plate, profile, 3e-3, [0 0 1]);
class(pocketed)A zero depth is rejected
plate = geometry.box(80e-3, 50e-3, 8e-3);
profile = geometry.box(20e-3, 10e-3, 1e-3);
pocketed = geometry.pocket(plate, profile, 0, [0 0 1]);Using geometry.pocket with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how geometry.pocket changes the result.
Run a small geometry.pocket example, explain the result, then change one input and compare the output.
FAQ
Can the profile be a solid?⌄
No. The sweep of the profile must be a solid tool, so the profile must be a face or sheet. Use geometry.subtract to remove a solid tool directly.
How do I enter millimeter dimensions?⌄
Convert to meters before the call, for example geometry.box(80e-3, 50e-3, 8e-3). When the function is called from a .fea declaration, length inputs already arrive in meters.
Related Geometry functions
Construction
geometry.box · geometry.chamfer · geometry.cylinder · geometry.edges · geometry.edgesIntroducedBy · geometry.extrude · geometry.faces · geometry.facesIntroducedBy · geometry.fillet · geometry.finish · geometry.hole · geometry.instance · geometry.intersect · geometry.revolve · geometry.solid · geometry.sphere · geometry.subtract · geometry.transform · geometry.union · geometry.withRegion
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how geometry.pocket is executed, line by line, in Rust.
- View the source for geometry.pocket in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.