SelectionTool Class

Tool for picking a set of elements of interest, selected by the user.

Extends

Methods

Name Description
constructor(..._args: any[]): SelectionTool    
applyToolSettingPropertyChange(updatedValue: ToolSettingsPropertySyncItem): boolean Used to send changes from UI back to Tool Beta
autoLockTarget(): void    
decorate(context: DecorateContext): void    
filterHit(hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus>    
initSelectTool(): void Protected    
onCleanup(): void    
onDataButtonUp(ev: BeButtonEvent): Promise<EventHandled>    
onModifierKeyTransition(_wentDown: boolean, modifier: BeModifierKeys, _event: KeyboardEvent): Promise<EventHandled>    
onMouseEndDrag(ev: BeButtonEvent): Promise<EventHandled>    
onMouseMotion(ev: BeButtonEvent): Promise<void>    
onMouseStartDrag(ev: BeButtonEvent): Promise<EventHandled>    
onPostInstall(): void    
onResetButtonUp(ev: BeButtonEvent): Promise<EventHandled>    
onRestartTool(): void    
onSuspend(): void    
onTouchCancel(ev: BeTouchEvent): Promise<void>    
onTouchComplete(ev: BeTouchEvent): Promise<void>    
onTouchMove(ev: BeTouchEvent): Promise<void>    
onTouchMoveStart(ev: BeTouchEvent, startEv: BeTouchEvent): Promise<EventHandled>    
onUnsuspend(): void    
processSelection(elementId: Id64Arg, process: SelectionProcessing): Promise<boolean>    
requireWriteableTarget(): boolean    
selectByPointsEnd(ev: BeButtonEvent): boolean Protected    
selectByPointsProcess(origin: Point3d, corner: Point3d, ev: BeButtonEvent, method: SelectionMethod, overlap: boolean): void Protected    
selectByPointsStart(ev: BeButtonEvent): boolean Protected    
selectDecoration(ev: BeButtonEvent, currHit?: HitDetail): Promise<EventHandled>    
showPrompt(mode: SelectionMode, method: SelectionMethod): void Protected    
supplyToolSettingsProperties(): ToolSettingsPropertyRecord[] | undefined Used to supply DefaultToolSettingProvider with a list of properties to use to generate ToolSettings. Beta
updateSelection(elementId: Id64Arg, process: SelectionProcessing): boolean    
useOverlapSelection(ev: BeButtonEvent): boolean Protected    
wantEditManipulators(): boolean Protected    
wantPickableDecorations(): boolean Protected    
wantSelectionClearOnMiss(_ev: BeButtonEvent): boolean Protected    
wantToolSettings(): boolean Protected    
startTool(): boolean Static    

Inherited methods

Name Inherited from Description
beginDynamics(): void InteractiveTool Call to initialize dynamics mode.
changeLocateState(enableLocate: boolean, enableSnap?: false | true, 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.
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.
exitTool(): void PrimitiveTool  
getCurrentButtonEvent(ev: BeButtonEvent): void InteractiveTool Fill the supplied button event from the current cursor location.
getDecorationGeometry(_hit: HitDetail): GeometryStreamProps | undefined InteractiveTool Called to allow snapping to pickable decoration geometry.
getPrompt(): string PrimitiveTool Returns the prompt based on the tool's current state.
getToolTip(_hit: HitDetail): Promise<HTMLElement | string> InteractiveTool Invoked before the locate tooltip is displayed to retrieve the information about the located element.
initLocateElements(enableLocate: boolean = true, enableSnap?: false | true, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void InteractiveTool Helper method for tools that need to locate existing elements.
isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean PrimitiveTool Determine whether the supplied Viewport is compatible with this tool.
isValidLocation(ev: BeButtonEvent, isButtonEvent: boolean): boolean PrimitiveTool Checks that the adjusted point from the supplied button event is within the project extents for spatial views.
onDataButtonDown(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the data button is pressed.
onDynamicFrame(_ev: BeButtonEvent, _context: DynamicsContext): void InteractiveTool Called to allow Tool to display dynamic elements.
onInstall(): 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.
onMouseMotionStopped(_ev: BeButtonEvent): Promise<void> InteractiveTool Invoked when the cursor was previously moving, and has stopped moving.
onMouseNoMotion(_ev: BeButtonEvent): Promise<void> InteractiveTool Invoked when the cursor is not moving
onMouseWheel(_ev: BeWheelEvent): Promise<EventHandled> InteractiveTool Invoked when the mouse wheel moves.
onRedoPreviousStep(): Promise<boolean> PrimitiveTool Called to reinstate to a previous tool state (ex.
onReinitialize(): void PrimitiveTool Called to reset tool to initial state.
onResetButtonDown(_ev: BeButtonEvent): Promise<EventHandled> InteractiveTool Invoked when the reset button is pressed.
onSelectedViewportChanged(_previous: Viewport | undefined, current: Viewport | undefined): void PrimitiveTool Called when active view changes.
onTouchEnd(_ev: BeTouchEvent): Promise<void> InteractiveTool Called when user removes a touch point by lifting a finger or stylus from the surface.
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.
onUndoPreviousStep(): Promise<boolean> PrimitiveTool Called to reverse to a previous tool state (ex.
run(): boolean PrimitiveTool Establish this tool as the active PrimitiveTool.
saveChanges(): Promise<void> PrimitiveTool Tools need to call SaveChanges to commit any elements they have added/changes they have made.
syncToolSettingsProperties(syncData: ToolSettingsPropertySyncItem[]): 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?: I18NNamespace): void Static Tool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
_isSelectByPoints Protected boolean    
_isSuspended Protected boolean    
_points Protected Point3d[]    
hidden Static boolean    
selectionMethod Accessor SelectionMethod    
selectionMode Accessor SelectionMode    
toolId Static string    

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 the
.json file for the current locale of its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
the flyover property is returned.
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 the
.json file for the current locale of its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
the keyin property is returned.
iModel Accessor ReadOnly IModelConnection PrimitiveTool Get the iModel the tool is operating against.
isDynamicsStarted Accessor ReadOnly boolean InteractiveTool Call to find out if dynamics are currently active.
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 the
.json file for the current locale of its registered Namespace (e.g. "en/MyApp.json")
namespace Static I18NNamespace Tool The I18NNamespace 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.
targetIsLocked boolean PrimitiveTool  
targetModelId undefined | string PrimitiveTool  
targetView undefined | Viewport PrimitiveTool  
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.

Defined in

Last Updated: 03 June, 2019