SetupInput Object

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

Description

Object that represents an setup creation parameters. The input-object can be used from the Setups.add method to instantiate a new setup

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
fixtureEnabled Set this value to enable the use of fixtures for this setup. To then set the fixture models themselves use the `fixtures` property.
fixtures An array of models that represent fixtures, where a model can be an Occurrence, BRepBody, or MeshBody.

The returned array is connected to the SetupInput and can be added to directly without needing to create a new array, populate it, and assign using this property, although, that is supported too.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
machine Gets and sets the Machine associated with the setup.
models A list of models, where a model can be an Occurrence, BRepBody, or MeshBody. The returned array is connected to the SetupInput and can be added to directly without needing to create a new array, populate it, and assign it using this property, although, that is supported too.
name Name of the new setup. This is displayed in the browser tree and can be used to access the setup from Setups.
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():
operationType Operation Type for the setup
parameters Get all parameters for the setup to be created. Parameters are initialized by user defaults. Configure operation parameters before creation for a better performance.
printSetting Gets and sets the PrintSetting associated with the setup.
stockMode StockMode for the setup.
stockSolids An array of models, where a model can be a Component, ManufacturingModel, BRepBody, or MeshBody. Setting this property, or adding the first object to the returned array will automatically set the stockMode to "SolidStock".

The returned array is connected to the SetupInput and can be added to directly without needing to create a new array, populate it, and assign it using this property, although, that is supported too.

Accessed From

Setups.createInput

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.

Manufacturing Workflow API Sample Manufacturing Workflow API Sample

This sample script starts by creating a simple component which is then used to describe a milling workflow. It creates a setup, a few operations, pick some tools from a Fusion sample tool library using loops and queries and ends up post-processing the operations out using an NC Program.

Version

Introduced in version April 2023