CustomFeatureEventArgs Object Preview

Derived from: EventArgs Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/CustomFeatureEventArgs.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

The CustomFeatureEventArgs provides information associated with a custom feature event.

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
computeStatus Provides access to the Status object associated with this compute. If the compute is successful you shouldn't do anything with this property. If the compute is not fully successful, you can use this returned Status object to define any errors or warnings that occurred during the compute. These warnings and errors will be shown to the user in the Alerts dialog.
customFeature Provides access to the custom feature that is being recomputed.
firingEvent The event that the firing is in response to.
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():

Version

Introduced in version January 2021