onMouseButton MethodOptional

Optional method to be called whenever this decorator is picked and a mouse button is pressed or released inside this decoration.

onMouseButton(ev: BeButtonEvent): boolean

@returns true if the event was handled by this decoration and should not be forwarded to the active tool.

@note This method is called for both mouse up and down events. If it returns true for a down event, it should also return true for the corresponding up event.

Parameter Type Description
ev BeButtonEvent  

Returns - boolean

true if the event was handled by this decoration and should not be forwarded to the active tool.

Defined in

Last Updated: 29 March, 2024