SelectionEvent Object

Derived from: Event Object

Description

An event endpoint that supports the connection to client implemented SelectionEventHandlers.

Defined in namespace "adsk::core" and the header file is <Core/UserInterface/SelectionEvent.h>.

Methods

Name Description
add Adds an event handler to this event endpoint.
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 this event endpoint.

Properties

Name Description
activeInput Returns the SelectionCommandInput that is currently active in the command dialog and that the user is selecting entities for. This can be used to determine which set of rules you want to apply to determine if the current entity is selectable or not.
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

Command.preSelect, Command.preSelectEnd, Command.preSelectMouseMove, Command.preSelectStart, Command.select, Command.selectionEvent, Command.unselect

Samples

Name Description
Selection Events API Sample The sample demos how to use selection events of a command.

Version

Introduced in version August 2014