API Reference > frontend-devTools > Tools > PlanarMaskBaseTool

PlanarMaskBaseTool Class

Beta  

Base class for the reality model planar masking tools.

Extends

Extended by

Methods

Name Description
constructor(..._args: any[]): PlanarMaskBaseTool    
allowSelection(): boolean Protected    
applyMask(vp: ScreenViewport): void ProtectedAbstract    
createElementMask(option: "include" | "exclude"): PlanarClipMaskSettings Protected    
createModelMask(): PlanarClipMaskSettings Protected    
createSubCategoryMask(): PlanarClipMaskSettings Protected    
createToolInstance(): PlanarMaskBaseTool ProtectedAbstract    
elementRequired(): boolean Protected    
exitTool(): void    
filterHit(hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus>    
onCleanup(): void    
onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>    
onPostInstall(): void    
onRestartTool(): void    
onUnsuspend(): void    
parseAndRun(...args: string[]): boolean    
requireWriteableTarget(): boolean    
setRealityModelMask(vp: ScreenViewport, mask: PlanarClipMaskSettings): void Protected    
showPrompt(): void ProtectedAbstract    
targetModelRequired(): boolean Protected    

Inherited methods

Name Inherited from Description
applyToolSettingPropertyChange(_updatedValue: DialogPropertySyncItem): boolean PrimitiveTool Used to receive property changes from UI.
autoLockTarget(): void PrimitiveTool Called on data button down event to lock the tool to its current target model.
beginDynamics(): void PrimitiveTool Call to initialize dynamics mode.
bumpToolSetting(_settingIndex?: number): Promise<boolean> PrimitiveTool Used to "bump" the value of a tool setting.
changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void PrimitiveTool Helper method to keep the view cursor, display of locate circle, and coordinate lock overrides consistent with isLocateEnabled and isSnapEnabled.
decorate(_context: DecorateContext): void PrimitiveTool Called to allow an active tool to display non-element decorations in overlay mode.
decorateSuspended(_context: DecorateContext): void PrimitiveTool Called to allow a suspended tool to display non-element decorations in overlay mode.
endDynamics(): void PrimitiveTool Call to terminate dynamics mode.
getCurrentButtonEvent(ev: BeButtonEvent): void PrimitiveTool Fill the supplied button event from the current cursor location.
getDecorationGeometry(_hit: HitDetail): undefined | GeometryStreamProps PrimitiveTool 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<string | HTMLElement> PrimitiveTool 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 PrimitiveTool Helper method for tools that need to locate existing elements.
isCompatibleViewport(vp: undefined | Viewport, 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.
onDataButtonUp(_ev: BeButtonEvent): Promise<EventHandled> PrimitiveTool Invoked when the data button is released.
onDynamicFrame(_ev: BeButtonEvent, _context: DynamicsContext): void PrimitiveTool Called to allow Tool to display dynamic elements.
onInstall(): boolean PrimitiveTool Override to execute additional logic when tool is installed.
onKeyTransition(_wentDown: boolean, _keyEvent: KeyboardEvent): Promise<EventHandled> PrimitiveTool Called when any key is pressed or released.
onMiddleButtonDown(_ev: BeButtonEvent): Promise<EventHandled> PrimitiveTool Invoked when the middle mouse button is pressed.
onMiddleButtonUp(_ev: BeButtonEvent): Promise<EventHandled> PrimitiveTool Invoked when the middle mouse button is released.
onModifierKeyTransition(_wentDown: boolean, _modifier: BeModifierKeys, _event: KeyboardEvent): Promise<EventHandled> PrimitiveTool Called when Control, Shift, or Alt modifier keys are pressed or released.
onMouseEndDrag(ev: BeButtonEvent): Promise<EventHandled> PrimitiveTool Invoked when the button is released after onMouseStartDrag.
onMouseMotion(_ev: BeButtonEvent): Promise<void> PrimitiveTool Invoked when the cursor is moving
onMouseStartDrag(_ev: BeButtonEvent): Promise<EventHandled> PrimitiveTool Invoked when the cursor begins moving while a button is depressed.
onMouseWheel(_ev: BeWheelEvent): Promise<EventHandled> PrimitiveTool 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> PrimitiveTool Invoked when the reset button is pressed.
onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled> PrimitiveTool Invoked when the reset button is released.
onSelectedViewportChanged(_previous: undefined | Viewport, current: undefined | Viewport): void PrimitiveTool Called when active view changes.
onSuspend(): void PrimitiveTool Notification of a ViewTool or InputCollector starting and this tool is being suspended.
onTouchCancel(_ev: BeTouchEvent): Promise<void> PrimitiveTool 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> PrimitiveTool Called when the last touch point is removed from the surface completing the current gesture.
onTouchEnd(_ev: BeTouchEvent): Promise<void> PrimitiveTool Called when user removes a touch point by lifting a finger or stylus from the surface.
onTouchMove(_ev: BeTouchEvent): Promise<void> PrimitiveTool Called when a touch point moves along the surface.
onTouchMoveStart(_ev: BeTouchEvent, _startEv: BeTouchEvent): Promise<EventHandled> PrimitiveTool 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> PrimitiveTool Called when user adds a touch point by placing a finger or stylus on the surface.
onTouchTap(_ev: BeTouchEvent): Promise<EventHandled> PrimitiveTool 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.
reloadToolSettingsProperties(): void PrimitiveTool Called by tool to inform UI to reload ToolSettings with new set of properties.
run(..._args: any[]): boolean PrimitiveTool Establish this tool as the active PrimitiveTool.
saveChanges(): Promise<void> PrimitiveTool If this tool is editing a briefcase, commits any elements that the tool has changed, supplying the tool name as the undo string.
supplyToolSettingsProperties(): undefined | DialogItem[] PrimitiveTool Used to supply list of properties that can be used to generate ToolSettings.
syncToolSettingsProperties(syncData: DialogPropertySyncItem[]): void PrimitiveTool Called by tool to synchronize the UI with property changes made by tool.
testDecorationHit(_id: string): boolean PrimitiveTool Called to support operations on pickable decorations, like snapping.
register(namespace?: I18NNamespace, i18n?: I18N): void Static PrimitiveTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
_acceptedElementIds ProtectedReadonly Set<string>    
_acceptedModelIds ProtectedReadonly Set<string>    
_acceptedSubCategoryIds ProtectedReadonly Set<string>    
_targetMaskModel Protected string | ContextRealityModelState    
_transparency Protected undefined | number    
_useSelection Protected boolean    

Inherited properties

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

Defined in

Last Updated: 12 June, 2024