PocketRecognitionSelection Object

Derived from: CurveSelection Object
Defined in namespace "adsk::cam" and the header file is <Cam/GeometrySelections/PocketRecognitionSelection.h>

Description

Pocket type curve selection. It searches for pockets matching the criteria on the selected bodies The result of the value property call may contain duplicates. See also RecognizedPockets for the ability to analyze the pockets

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

Properties

Name Description
areHolesIncluded Flag to interpret holes as pockets.
error PreviewGets the last warning string encountered after the selection was applied to a parent.
hasError PreviewGets if errors were encountered when applying the selection to a a parent.
hasWarning PreviewGets if warnings were encountered when applying the selection to a parent.
inputGeometry Get or set the value of the input geometry. If the value originates from a component instead of an occurrence, or an occurrence outside of the CAM environment, then the subpath is checked against the CAM model tree. For some child classes, this may be the same as the value property, but might also consist of fewer elements. Valid elements depend on the capabilities of the derived class. An exception is thrown if the matching fails or the given entity does not match the expected type.
isSetupModelSelected Flag to include all B-Rep bodies set as the setup models.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
maximumCornerRadius The largest corner radius that can appear in a pocket to machine.
maximumPocketDepth The deepest pocket (measured from top to bottom) to machine.
minimumCornerRadius The smallest corner radius that can appear in a pocket to machine.
minimumHoleDiameter Lower bound for the diameter for the hole detection. It can only be set if areHoldeIncluded is set to true.
minimumPocketDepth The shallowest pocket (measured from top to bottom) to machine.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
value Returns the resulting value of the selection. In general, this returns the input selection, but child classes can override the return value if needed. Refer to the child classes comments for further details. The collection may contain duplicates.
warning PreviewGets the last warning string encountered after the selection was applied to a parent.

Accessed From

CurveSelections.createNewPocketRecognitionSelection

Samples

Name Description
Hole and Pocket Recognition API Sample

This sample script demonstrates three different methods for feature recognition: one for holes and two for pockets.

The script starts by creating a simple component which is then used to demonstrate the three methods. After the features are recognised they are coloured and milling and drilling operations are created for each feature.

RecognizedHoleGroup returns a list of BRepFaces that can be used as selections for the drilling operation. RecognizedPocket and PocketRecognitionSelection do not return BRepFaces, and their output needs additional processing before the output can be used for creating machining operations.

The sample script demonstrates a couple of different methods, including finding the pocket BRepFaces and creating sketches from the recognized pockets.

This script works only if the Manufacturing Extension is active.

Version

Introduced in version July 2023