API Reference > core-frontend > Tools > PrimitiveTool

PrimitiveTool Class

The PrimitiveTool class can be used to implement tools to create or modify geometric elements.

see Writing a PrimitiveTool

extensions

Extends

Extended by

Methods

Name Description
constructor(..._args: any[]): PrimitiveTool    
autoLockTarget(): void Called on data button down event to lock the tool to its current target model.  
exitTool(): Promise<void>    
getPrompt(): string Returns the prompt based on the tool's current state.  
isCompatibleViewport(vp: undefined | Viewport, isSelectedViewChange: boolean): boolean Determine whether the supplied Viewport is compatible with this tool.  
isValidLocation(ev: BeButtonEvent, isButtonEvent: boolean): boolean Checks that the adjusted point from the supplied button event is within the project extents for spatial views.  
onRedoPreviousStep(): Promise<boolean> Called to reinstate to a previous tool state (ex.  
onReinitialize(): Promise<void> Called to reset tool to initial state.  
onRestartTool(): Promise<void> Abstract Called when an external event may invalidate the current tool's state.  
onSelectedViewportChanged(_previous: undefined | Viewport, current: undefined | Viewport): Promise<void> Called when active view changes.  
onUndoPreviousStep(): Promise<boolean> Called to reverse to a previous tool state (ex.  
requireWriteableTarget(): boolean Called from isCompatibleViewport to check for a read only iModel, which is not a valid target for tools that create or modify elements.  
run(..._args: any[]): Promise<boolean> Establish this tool as the active PrimitiveTool.  
saveChanges(): Promise<void> If this tool is editing a briefcase, commits any elements that the tool has changed, supplying the tool name as the undo string.  

Inherited methods

Name Inherited from Description
applyToolSettingPropertyChange(_updatedValue: DialogPropertySyncItem): Promise<boolean> InteractiveTool Used to receive property changes from UI.
beginDynamics(): void InteractiveTool Call to initialize dynamics mode.
bumpToolSetting(_settingIndex?: number): Promise<boolean> InteractiveTool Used to "bump" the value of a tool setting.
changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void InteractiveTool Helper method to keep the view cursor, display of locate circle, and coordinate lock overrides consistent with AccuSnap.isLocateEnabled and AccuSnap.isSnapEnabled.
changeToolSettingPropertyValue(syncItem: DialogPropertySyncItem): boolean InteractiveTool Helper method for responding to a tool setting property value change by updating saved settings.
decorate(_context: DecorateContext): void InteractiveTool Called to allow an active tool to display non-element decorations in overlay mode.
decorateSuspended(_context: DecorateContext): void InteractiveTool Called to allow a suspended tool to display non-element decorations in overlay mode.
endDynamics(): void InteractiveTool Call to terminate dynamics mode.
filterHit(_hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus> InteractiveTool Invoked to allow tools to filter which elements can be located.
getCurrentButtonEvent(ev: BeButtonEvent): void InteractiveTool Fill the supplied button event from the current cursor location.
getDecorationGeometry(_hit: HitDetail): undefined | GeometryStreamProps InteractiveTool Called to allow snapping to pickable decoration geometry.
getToolSettingPropertyLocked(_property: DialogProperty<any>): undefined | DialogProperty<any> InteractiveTool Override to return the property that is disabled/enabled if the supplied property is a lock property.
getToolTip(_hit: HitDetail): Promise<string | HTMLElement> InteractiveTool 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 InteractiveTool Helper method for tools that need to locate existing elements.
initializeToolSettingPropertyValues(properties: DialogProperty<any>[]): void InteractiveTool Helper method to establish initial values for tool setting properties from saved settings.
onCleanup(): Promise<void> InteractiveTool Invoked when the tool becomes no longer active, to perform additional cleanup logic
onDataButtonDown(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the data button is pressed.
onDataButtonUp(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the data button is released.
onDynamicFrame(_ev: BeButtonEvent, _context: DynamicsContext): void InteractiveTool Called to allow Tool to display dynamic elements.
onInstall(): Promise<boolean> InteractiveTool Override to execute additional logic when tool is installed.
onKeyTransition(_wentDown: boolean, _keyEvent: KeyboardEvent): Promise<EventHandled> InteractiveTool Called when any key is pressed or released.
onMiddleButtonDown(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the middle mouse button is pressed.
onMiddleButtonUp(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the middle mouse button is released.
onModifierKeyTransition(_wentDown: boolean, _modifier: BeModifierKeys, _event: KeyboardEvent): Promise<EventHandled> InteractiveTool Called when Control, Shift, or Alt modifier keys are pressed or released.
onMouseEndDrag(ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the button is released after onMouseStartDrag.
onMouseMotion(_ev: BeButtonEvent): Promise<void> InteractiveTool Invoked when the cursor is moving
onMouseStartDrag(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the cursor begins moving while a button is depressed.
onMouseWheel(_ev: BeWheelEvent): Promise<EventHandled> InteractiveTool Invoked when the mouse wheel moves.
onPostInstall(): Promise<void> InteractiveTool Override to execute additional logic after tool becomes active
onResetButtonDown(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the reset button is pressed.
onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the reset button is released.
onSuspend(): Promise<void> InteractiveTool Notification of a ViewTool or InputCollector starting and this tool is being suspended.
onTouchCancel(_ev: BeTouchEvent): Promise<void> InteractiveTool 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> InteractiveTool Called when the last touch point is removed from the surface completing the current gesture.
onTouchEnd(_ev: BeTouchEvent): Promise<void> InteractiveTool Called when user removes a touch point by lifting a finger or stylus from the surface.
onTouchMove(_ev: BeTouchEvent): Promise<void> InteractiveTool Called when a touch point moves along the surface.
onTouchMoveStart(_ev: BeTouchEvent, _startEv: BeTouchEvent): Promise<EventHandled> InteractiveTool 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> InteractiveTool Called when user adds a touch point by placing a finger or stylus on the surface.
onTouchTap(_ev: BeTouchEvent): Promise<EventHandled> InteractiveTool Called when touch point(s) are added and removed from a surface within a small time window without any touch point moving.
onUnsuspend(): Promise<void> InteractiveTool Notification of a ViewTool or InputCollector exiting and this tool is being unsuspended.
parseAndRun(..._args: string[]): Promise<boolean> InteractiveTool Run this instance of a tool using a series of string arguments.
reloadToolSettingsProperties(): void InteractiveTool Called by tool to inform UI to reload ToolSettings with new set of properties.
supplyToolSettingsProperties(): undefined | DialogItem[] InteractiveTool Used to supply list of properties that can be used to generate ToolSettings.
syncToolSettingsProperties(syncData: DialogPropertySyncItem[]): void InteractiveTool Called by tool to synchronize the UI with property changes made by tool.
testDecorationHit(_id: string): boolean InteractiveTool Called to support operations on pickable decorations, like snapping.
register(namespace?: string): void Static InteractiveTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
briefcase Accessor ReadOnly undefined | BriefcaseConnection Get the briefcase on which this tool operates, if the tool has successfully installed and the target PrimitiveTool.iModel is a briefcase.  
iModel Accessor ReadOnly IModelConnection Get the iModel on which this tool operates.  
targetIsLocked boolean    
targetModelId Accessor undefined | string    
targetView undefined | Viewport The viewport within which the tool operates.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string InteractiveTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string InteractiveTool 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,
InteractiveTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string InteractiveTool 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 InteractiveTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string InteractiveTool 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,
InteractiveTool.keyin is returned.
hidden Static boolean InteractiveTool If true, this Tool will not appear in the list from ToolRegistry.getToolList.
iconSpec Accessor ReadOnly string InteractiveTool Get the iconSpec from this Tool's class.
iconSpec Static string InteractiveTool The icon for this Tool.
isControlDown Accessor ReadOnly boolean InteractiveTool Convenience method to check whether control key is currently down without needing a button event.
isDynamicsStarted Accessor ReadOnly boolean InteractiveTool Call to find out if dynamics are currently active.
keyin Accessor ReadOnly string InteractiveTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string InteractiveTool 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 InteractiveTool The maximum number of arguments allowed by InteractiveTool.parseAndRun, or undefined if there is no maximum.
If subclasses override InteractiveTool.parseAndRun, they should also override this method to indicate the maximum
number of arguments their implementation expects.
minArgs Accessor StaticReadOnly number InteractiveTool The minimum number of arguments allowed by InteractiveTool.parseAndRun. If subclasses override InteractiveTool.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 string InteractiveTool The namespace that provides localized strings for this Tool.
receivedDownEvent boolean InteractiveTool Used to avoid sending tools up events for which they did not receive the down event.
toolId Accessor ReadOnly string InteractiveTool 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 InteractiveTool The unique string that identifies this tool.

Defined in

Last Updated: 30 November, 2023