API Reference > imodeljs-markup > MarkupTools > SketchTool

SketchTool Class

Tool for placing Markup freehand sketches

Extends

Methods

Name Description
constructor(..._args: any[]): SketchTool    
createMarkup(svgMarkup: G, ev: BeButtonEvent, isDynamics: boolean): void Protected    
onMouseMotion(ev: BeButtonEvent): Promise<void> Invoked when the cursor is moving  
showPrompt(): void Protected    

Inherited methods

Name Inherited from Description
applyToolSettingPropertyChange(_updatedValue: DialogPropertySyncItem): boolean RedlineTool Used to receive property changes from UI.
autoLockTarget(): void RedlineTool Called on data button down event to lock the tool to its current target model.
beginDynamics(): void RedlineTool Call to initialize dynamics mode.
bumpToolSetting(_settingIndex?: number): Promise<boolean> RedlineTool Used to "bump" the value of a tool setting.
changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void RedlineTool Helper method to keep the view cursor, display of locate circle, and coordinate lock overrides consistent with isLocateEnabled and isSnapEnabled.
clearDynamicsMarkup(_isDynamics: boolean): void Protected RedlineTool  
decorate(_context: DecorateContext): void RedlineTool Called to allow an active tool to display non-element decorations in overlay mode.
decorateSuspended(_context: DecorateContext): void RedlineTool Called to allow a suspended tool to display non-element decorations in overlay mode.
endDynamics(): void RedlineTool Call to terminate dynamics mode.
exitTool(): void RedlineTool  
filterHit(_hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus> RedlineTool Invoked to allow tools to filter which elements can be located.
getCurrentButtonEvent(ev: BeButtonEvent): void RedlineTool Fill the supplied button event from the current cursor location.
getDecorationGeometry(_hit: HitDetail): undefined | GeometryStreamProps RedlineTool Called to allow snapping to pickable decoration geometry.
getPrompt(): string RedlineTool Returns the prompt based on the tool's current state.
getToolTip(_hit: HitDetail): Promise<string | HTMLElement> RedlineTool Invoked before the locate tooltip is displayed to retrieve the information about the located element.
initLocateElements(enableLocate?: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void RedlineTool Helper method for tools that need to locate existing elements.
isCompatibleViewport(vp: undefined | Viewport, isSelectedViewChange: boolean): boolean RedlineTool  
isComplete(_ev: BeButtonEvent): boolean Protected RedlineTool  
isValidLocation(ev: BeButtonEvent, isButtonEvent: boolean): boolean RedlineTool Checks that the adjusted point from the supplied button event is within the project extents for spatial views.
onAdded(el: Element): void Protected RedlineTool  
onCleanup(): void RedlineTool Invoked when the tool becomes no longer active, to perform additional cleanup logic
onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the data button is pressed.
onDataButtonUp(_ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the data button is released.
onDynamicFrame(_ev: BeButtonEvent, _context: DynamicsContext): void RedlineTool Called to allow Tool to display dynamic elements.
onInstall(): boolean RedlineTool  
onKeyTransition(_wentDown: boolean, _keyEvent: KeyboardEvent): Promise<EventHandled> RedlineTool Called when any key is pressed or released.
onMiddleButtonDown(_ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the middle mouse button is pressed.
onMiddleButtonUp(_ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the middle mouse button is released.
onModifierKeyTransition(_wentDown: boolean, _modifier: BeModifierKeys, _event: KeyboardEvent): Promise<EventHandled> RedlineTool Called when Control, Shift, or Alt modifier keys are pressed or released.
onMouseEndDrag(ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the button is released after onMouseStartDrag.
onMouseStartDrag(_ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the cursor begins moving while a button is depressed.
onMouseWheel(_ev: BeWheelEvent): Promise<EventHandled> RedlineTool Invoked when the mouse wheel moves.
onPostInstall(): void RedlineTool  
onRedoPreviousStep(): Promise<boolean> RedlineTool Called to reinstate to a previous tool state (ex.
onReinitialize(): void RedlineTool Called to reset tool to initial state.
onResetButtonDown(_ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the reset button is pressed.
onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled> RedlineTool Invoked when the reset button is released.
onRestartTool(): void RedlineTool  
onSelectedViewportChanged(_previous: undefined | Viewport, current: undefined | Viewport): void RedlineTool Called when active view changes.
onSuspend(): void RedlineTool Notification of a ViewTool or InputCollector starting and this tool is being suspended.
onTouchCancel(ev: BeTouchEvent): Promise<void> RedlineTool  
onTouchComplete(ev: BeTouchEvent): Promise<void> RedlineTool  
onTouchEnd(_ev: BeTouchEvent): Promise<void> RedlineTool Called when user removes a touch point by lifting a finger or stylus from the surface.
onTouchMove(ev: BeTouchEvent): Promise<void> RedlineTool  
onTouchMoveStart(ev: BeTouchEvent, startEv: BeTouchEvent): Promise<EventHandled> RedlineTool  
onTouchStart(_ev: BeTouchEvent): Promise<void> RedlineTool Called when user adds a touch point by placing a finger or stylus on the surface.
onTouchTap(_ev: BeTouchEvent): Promise<EventHandled> RedlineTool 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> RedlineTool Called to reverse to a previous tool state (ex.
onUnsuspend(): void RedlineTool  
outputMarkupPrompt(msg: string): void Protected RedlineTool  
parseAndRun(..._args: string[]): boolean RedlineTool Run this instance of a tool using a series of string arguments.
pickElement(pt: Readonly<WritableXAndY>): undefined | Element RedlineTool Find the topmost MarkupElement at the specified point in the markup view.
provideToolAssistance(mainInstrKey: string, singlePoint: boolean = false): void Protected RedlineTool  
redoPreviousStep(): Promise<boolean> RedlineTool  
reloadToolSettingsProperties(): void RedlineTool Called by tool to inform UI to reload ToolSettings with new set of properties.
requireWriteableTarget(): boolean RedlineTool  
run(..._args: any[]): boolean RedlineTool Establish this tool as the active PrimitiveTool.
saveChanges(): Promise<void> RedlineTool If this tool is editing a briefcase, commits any elements that the tool has changed, supplying the tool name as the undo string.
setCurrentStyle(element: Element, canBeFilled: boolean): void Protected RedlineTool  
setCurrentTextStyle(element: Element): void Protected RedlineTool  
setupAndPromptForNextAction(): void Protected RedlineTool  
supplyToolSettingsProperties(): undefined | DialogItem[] RedlineTool Used to supply list of properties that can be used to generate ToolSettings.
syncToolSettingsProperties(syncData: DialogPropertySyncItem[]): void RedlineTool Called by tool to synchronize the UI with property changes made by tool.
testDecorationHit(_id: string): boolean RedlineTool Called to support operations on pickable decorations, like snapping.
undoPreviousStep(): Promise<boolean> RedlineTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static RedlineTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
_minDistSquared Protected number    
iconSpec Static string The icon for this Tool.  
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
_minPoints Protected number RedlineTool  
_nRequiredPoints Protected number RedlineTool  
_points ProtectedReadonly Point3d[] RedlineTool  
description Accessor ReadOnly string RedlineTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string RedlineTool 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,
RedlineTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string RedlineTool 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 RedlineTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string RedlineTool 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,
RedlineTool.keyin is returned.
hidden Static boolean RedlineTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N RedlineTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string RedlineTool Get the iconSpec from this Tool's class.
iModel Accessor ReadOnly IModelConnection RedlineTool Get the iModel on which this tool operates.
isControlDown Accessor ReadOnly boolean RedlineTool Convenience method to check whether control key is currently down without needing a button event.
isDynamicsStarted Accessor ReadOnly boolean RedlineTool Call to find out if dynamics are currently active.
keyin Accessor ReadOnly string RedlineTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string RedlineTool 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").
markup Markup RedlineTool  
maxArgs Accessor StaticReadOnly undefined | number RedlineTool The maximum number of arguments allowed by RedlineTool.parseAndRun, or undefined if there is no maximum.
If subclasses override RedlineTool.parseAndRun, they should also override this method to indicate the maximum
number of arguments their implementation expects.
minArgs Accessor StaticReadOnly number RedlineTool The minimum number of arguments allowed by RedlineTool.parseAndRun. If subclasses override RedlineTool.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 RedlineTool The I18NNamespace that provides localized strings for this Tool.
receivedDownEvent boolean RedlineTool Used to avoid sending tools up events for which they did not receive the down event.
targetIsLocked boolean RedlineTool  
targetModelId Accessor undefined | string RedlineTool  
targetView undefined | Viewport RedlineTool The viewport within which the tool operates.
toolId Accessor ReadOnly string RedlineTool 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.
toolKey Static string RedlineTool  

Defined in

Last Updated: 11 June, 2024