CustomFeatureEvent Object Preview

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

A CustomFeature event is an event associated with handling changes to a custom feature.

Methods

Name Description
add Add a handler to be notified when the file event occurs.
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().
remove Removes a handler from the event.

Properties

Name Description
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
name The name of the event - e.g. "DocumentOpening"
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():
sender The object that is firing the event. For example, in the case of a command input event this will return the command.

Accessed From

CustomFeatureDefinition.customFeatureCompute

Version

Introduced in version January 2021