MachineAvoidSelectionBase Object Preview

Derived from: GeometrySelection Object
Defined in namespace "adsk::cam" and the header file is <Cam/MachineAvoidSelections/MachineAvoidSelectionBase.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

Base parent class for all machine/avoid selection classes.

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
axialOffset Axial offset - sets the corresponding axial offset value based on the machine mode
combinedOffset Combined offset - clearance and stock to leave based on the machine mode This only applies to strategies that use a single offset value (Advanced Swarf, Multi-Axis Clearing, Multi-Axis Finishing, Deburr and Geodesic)
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.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
machineMode Desired machining mode. The default is Avoid. The current machining mode will determine which value the radial and axial offset functions refer to. When set to Machine, the radial and axial offset methods will read/set the stock to leave parameter. When set to Avoid, the radial and axial offset methods will read/set the clearance value, and the Fixture mode will map to the relative fixture clearance value.
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():
radialOffset Radial offset - sets the corresponding radial offset value based on the machine mode
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

MachineAvoidGroups.defaultGroup, MachineAvoidGroups.item

Derived Classes

MachineAvoidDefaultSelection, MachineAvoidDirectSelection

Version

Introduced in version September 2024