API Reference > imodeljs-frontend > Tools > InteractiveTool

InteractiveTool Class

A Tool that may be installed, via ToolAdmin, to handle user input. The ToolAdmin manages the currently installed ViewingTool, PrimitiveTool, InputCollector, and IdleTool. Each must derive from this class and there may only be one of each type installed at a time.

Extends

Extended by

Methods

Name Description
constructor(..._args: any[]): InteractiveTool    
applyToolSettingPropertyChange(_updatedValue: DialogPropertySyncItem): boolean Used to receive property changes from UI. Beta  
beginDynamics(): void Call to initialize dynamics mode.  
bumpToolSetting(_settingIndex?: number): Promise<boolean> Used to "bump" the value of a tool setting. Beta  
changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void Helper method to keep the view cursor, display of locate circle, and coordinate lock overrides consistent with AccuSnap.isLocateEnabled and AccuSnap.isSnapEnabled.  
decorate(_context: DecorateContext): void Called to allow an active tool to display non-element decorations in overlay mode.  
decorateSuspended(_context: DecorateContext): void Called to allow a suspended tool to display non-element decorations in overlay mode.  
endDynamics(): void Call to terminate dynamics mode.  
exitTool(): void Abstract    
filterHit(_hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus> Invoked to allow tools to filter which elements can be located.  
getCurrentButtonEvent(ev: BeButtonEvent): void Fill the supplied button event from the current cursor location.  
getDecorationGeometry(_hit: HitDetail): undefined | GeometryStreamProps Called to allow snapping to pickable decoration geometry.  
getToolTip(_hit: HitDetail): Promise<string | HTMLElement> Invoked before the locate tooltip is displayed to retrieve the information about the located element.  
initLocateElements(enableLocate: boolean = true, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void Helper method for tools that need to locate existing elements.  
isCompatibleViewport(_vp: ScreenViewport, _isSelectedViewChange: boolean): boolean    
isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean    
onCleanup(): void Invoked when the tool becomes no longer active, to perform additional cleanup logic  
onDataButtonDown(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the data button is pressed.  
onDataButtonUp(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the data button is released.  
onDynamicFrame(_ev: BeButtonEvent, _context: DynamicsContext): void Called to allow Tool to display dynamic elements.  
onInstall(): boolean Override to execute additional logic when tool is installed.  
onKeyTransition(_wentDown: boolean, _keyEvent: KeyboardEvent): Promise<EventHandled> Called when any key is pressed or released.  
onMiddleButtonDown(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the middle mouse button is pressed.  
onMiddleButtonUp(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the middle mouse button is released.  
onModifierKeyTransition(_wentDown: boolean, _modifier: BeModifierKeys, _event: KeyboardEvent): Promise<EventHandled> Called when Control, Shift, or Alt modifier keys are pressed or released.  
onMouseEndDrag(ev: BeButtonEvent): Promise<EventHandled> Invoked when the button is released after onMouseStartDrag.  
onMouseMotion(_ev: BeButtonEvent): Promise<void> Invoked when the cursor is moving  
onMouseStartDrag(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the cursor begins moving while a button is depressed.  
onMouseWheel(_ev: BeWheelEvent): Promise<EventHandled> Invoked when the mouse wheel moves.  
onPostInstall(): void Override to execute additional logic after tool becomes active  
onReinitialize(): void Override Call to reset tool to initial state  
onResetButtonDown(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the reset button is pressed.  
onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled> Invoked when the reset button is released.  
onSelectedViewportChanged(_previous: undefined | ScreenViewport, _current: undefined | ScreenViewport): void Called when active view changes.  
onSuspend(): void Notification of a ViewTool or InputCollector starting and this tool is being suspended.  
onTouchCancel(_ev: BeTouchEvent): Promise<void> Called when a touch point is interrupted in some way and needs to be dropped from the list of target touches.  
onTouchComplete(_ev: BeTouchEvent): Promise<void> Called when the last touch point is removed from the surface completing the current gesture.  
onTouchEnd(_ev: BeTouchEvent): Promise<void> Called when user removes a touch point by lifting a finger or stylus from the surface.  
onTouchMove(_ev: BeTouchEvent): Promise<void> Called when a touch point moves along the surface.  
onTouchMoveStart(_ev: BeTouchEvent, _startEv: BeTouchEvent): Promise<EventHandled> Called after at least one touch point has moved for an appreciable time and distance along the surface to not be considered a tap.  
onTouchStart(_ev: BeTouchEvent): Promise<void> Called when user adds a touch point by placing a finger or stylus on the surface.  
onTouchTap(_ev: BeTouchEvent): Promise<EventHandled> Called when touch point(s) are added and removed from a surface within a small time window without any touch point moving.  
onUnsuspend(): void Notification of a ViewTool or InputCollector exiting and this tool is being unsuspended.  
reloadToolSettingsProperties(): void Called by tool to inform UI to reload ToolSettings with new set of properties. Beta  
supplyToolSettingsProperties(): undefined | DialogItem[] Used to supply list of properties that can be used to generate ToolSettings. Beta  
syncToolSettingsProperties(syncData: DialogPropertySyncItem[]): void Called by tool to synchronize the UI with property changes made by tool. Beta  
testDecorationHit(_id: string): boolean Called to support operations on pickable decorations, like snapping.  

Inherited methods

Name Inherited from Description
parseAndRun(..._args: string[]): boolean Tool Run this instance of a tool using a series of string arguments.
run(..._args: any[]): boolean Tool Run this instance of a Tool.
register(namespace?: I18NNamespace, i18n?: I18N): void Static Tool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
isControlDown Accessor ReadOnly boolean Convenience method to check whether control key is currently down without needing a button event.  
isDynamicsStarted Accessor ReadOnly boolean Call to find out if dynamics are currently active.  
receivedDownEvent boolean Used to avoid sending tools up events for which they did not receive the down event.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string Tool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string Tool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
Tool.flyover is returned.
englishKeyin Accessor StaticReadOnly string Tool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
flyover Accessor ReadOnly string Tool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string Tool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
Tool.keyin is returned.
hidden Static boolean Tool If true, this Tool will not appear in the list from ToolRegistry.getToolList.
i18n Static I18N Tool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string Tool Get the iconSpec from this Tool's class.
iconSpec Static string Tool The icon for this Tool.
keyin Accessor ReadOnly string Tool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string Tool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
maxArgs Accessor StaticReadOnly undefined | number Tool The maximum number of arguments allowed by Tool.parseAndRun, or undefined if there is no maximum.
If subclasses override Tool.parseAndRun, they should also override this method to indicate the maximum
number of arguments their implementation expects.
minArgs Accessor StaticReadOnly number Tool The minimum number of arguments allowed by Tool.parseAndRun. If subclasses override Tool.parseAndRun, they should also
override this method to indicate the minimum number of arguments their implementation expects. UI controls can use
this information to ensure the tool has enough information to execute.
namespace Static I18NNamespace Tool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string Tool Get the toolId string for this Tool class. This string is used to identify the Tool in the ToolRegistry and is used to localize
the keyin, description, etc. from the current locale.
toolId Static string Tool The unique string that identifies this tool.

Defined in

Last Updated: 12 June, 2024