RecognizedPocketInput Object Preview

Derived from: Base Object
Defined in namespace "adsk::cam" and the header file is <Cam/PocketRecognition/RecognizedPocketInput.h>

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Input object containing properties used to recognize pockets. Includes bosses along open and closed pockets. The class is only available with the Machining Extension.

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().
create Creates a new RecognizedPocketInput object.

Properties

Name Description
attackVectors The attack vectors used to recognize pockets. If left empty, this array will be filled with normals of all planar faces on the given body. There vectors should be pointing down along the tool towards its tip and the pocket floors.
body The body on which to recognize pockets.
isIncludingBosses Sets and gets whether bosses should be included in the recognized pockets. Bosses are defined as pockets that protrude above the surrounding model faces and thus only consist of islands without an outer boundary. This value is true by default.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
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():

Accessed From

RecognizedPocketInput.create

Version

Introduced in version April 2026