API Reference › editor-frontend › Editing › TransformElementsTool

TransformElementsTool Class

Edit tool base class for applying a transform to element placements. Example of a tool that would translate elements:

class SampleMoveElementsTool extends TransformElementsTool {
  public static override toolId = "SampleMoveElements";
  public static override iconSpec = "icon-move";
  protected calculateTransform(ev: BeButtonEvent): Transform | undefined {
    return (this.anchorPoint ? Transform.createTranslation(ev.point.minus(this.anchorPoint)) : undefined);
  }
  public async onRestartTool(): Promise<void> {
    const tool = new SampleMoveElementsTool();
    if (!await tool.run()) return this.exitTool();
  }
}

Extends

  • ElementSetTool

Methods

Name Description
constructor(..._args: any[]): TransformElementsTool    
calculateTransform(ev: BeButtonEvent): undefined | Transform ProtectedAbstract    
clearAgendaGraphics(): Promise<void> Protected    
createAgendaGraphics(changed: boolean): Promise<void> Protected    
initAgendaDynamics(): Promise<boolean> Protected    
onAgendaModified(): Promise<void> Protected    
onCleanup(): Promise<void>    
onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void    
onProcessComplete(): Promise<void>    
processAgenda(ev: BeButtonEvent): Promise<void>    
replaceAgenda(newIds: undefined | Id64Arg): Promise<void> Protected    
startCommand(): Promise<string> Protected    
transformAgenda(transform: Transform): Promise<void> Protected    
transformAgendaDynamics(transform: Transform, context: DynamicsContext): void Protected    
transformAndCopyAgenda(_transform: Transform): Promise<undefined | Id64Arg> Protected    
updateAnchorLocation(transform: Transform): void Protected    

Inherited methods

Name Inherited from Description
applyToolSettingPropertyChange(_updatedValue: DialogPropertySyncItem): Promise<boolean> ElementSetTool Used to receive property changes from UI.
autoLockTarget(): void ElementSetTool Called on data button down event to lock the tool to its current target model.
beginDynamics(): void ElementSetTool Call to initialize dynamics mode.
buildDragSelectAgenda(vp: Viewport, origin: Point3d, corner: Point3d, method: SelectionMethod, overlap: boolean): Promise<boolean> Protected ElementSetTool Populate ElementSetTool.agenda by drag box or crossing line information.
buildLocateAgenda(hit: HitDetail): Promise<boolean> Protected ElementSetTool Populate ElementSetTool.agenda from a HitDetail.
buildSelectionSetAgenda(ss: SelectionSet): Promise<boolean> Protected ElementSetTool Populate ElementSetTool.agenda from a SelectionSet.
bumpToolSetting(_settingIndex?: number): Promise<boolean> ElementSetTool Used to "bump" the value of a tool setting.
changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void ElementSetTool Helper method to keep the view cursor, display of locate circle, and coordinate lock overrides consistent with isLocateEnabled and isSnapEnabled.
changeToolSettingPropertyValue(syncItem: DialogPropertySyncItem): boolean ElementSetTool Helper method for responding to a tool setting property value change by updating saved settings.
chooseNextHit(ev: BeButtonEvent): Promise<EventHandled> Protected ElementSetTool Allow reset to cycle between elements identified for overlapping the locate circle.
decorate(context: DecorateContext): void ElementSetTool Show graphics for when drag selection is active.
decorateSuspended(_context: DecorateContext): void ElementSetTool Called to allow a suspended tool to display non-element decorations in overlay mode.
doLocate(ev: BeButtonEvent, newSearch: boolean): Promise<boolean> Protected ElementSetTool Identify an element and update the element agenda.
doProcessSelectionSetImmediate(): Promise<void> Protected ElementSetTool Support either requireAcceptForSelectionSetOperation or requireAcceptForSelectionSetDynamics returning false.
endDynamics(): void ElementSetTool Call to terminate dynamics mode.
exitTool(): Promise<void> ElementSetTool  
filterHit(hit: HitDetail, out?: LocateResponse): Promise<LocateFilterStatus> ElementSetTool Called from doLocate as well as auto-locate to accept or reject elements under the cursor.
gatherElements(ev: BeButtonEvent): Promise<undefined | EventHandled> Protected ElementSetTool Collect element input until tool has a sufficient number to complete.
gatherInput(ev: BeButtonEvent): Promise<undefined | EventHandled> Protected ElementSetTool Collect point input until tool has a sufficient number to complete.
getCurrentButtonEvent(ev: BeButtonEvent): void ElementSetTool Fill the supplied button event from the current cursor location.
getDecorationGeometry(_hit: HitDetail): undefined | GeometryStreamProps ElementSetTool Called to allow snapping to pickable decoration geometry.
getDragSelectCandidates(vp: Viewport, origin: Point3d, corner: Point3d, method: SelectionMethod, overlap: boolean): Promise<Id64Arg> Protected ElementSetTool Get element ids to process from drag box or crossing line selection.
getGroupIds(id: string): Promise<Id64Arg> Protected ElementSetTool If the supplied element is a member of an assembly, return all member ids.
getLocateCandidates(hit: HitDetail): Promise<Id64Arg> Protected ElementSetTool Get element id(s) to process from a HitDetail already accepted by isElementValidForOperation.
getPrompt(): string ElementSetTool Returns the prompt based on the tool's current state.
getSelectionSetCandidates(ss: SelectionSet): Promise<Id64Arg> Protected ElementSetTool Get element ids to process from the active selection set.
getToolSettingPropertyLocked(_property: DialogProperty<any>): undefined | DialogProperty<any> ElementSetTool Override to return the property that is disabled/enabled if the supplied property is a lock property.
getToolTip(_hit: HitDetail): Promise<string | HTMLElement> ElementSetTool 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 ElementSetTool Helper method for tools that need to locate existing elements.
initializeToolSettingPropertyValues(properties: DialogProperty<any>[]): void ElementSetTool Helper method to establish initial values for tool setting properties from saved settings.
isCompatibleViewport(vp: undefined | Viewport, isSelectedViewChange: boolean): boolean ElementSetTool Determine whether the supplied Viewport is compatible with this tool.
isElementIdValid(id: string, source: ModifyElementSource): boolean Protected ElementSetTool Quick id validity check.
isElementValidForOperation(hit: HitDetail, _out?: LocateResponse): Promise<boolean> Protected ElementSetTool Sub-classes should override to apply tool specific filtering and to provide an explanation for rejection.
isValidLocation(ev: BeButtonEvent, isButtonEvent: boolean): boolean ElementSetTool Checks that the adjusted point from the supplied button event is within the project extents for spatial views.
onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled> ElementSetTool  
onDataButtonUp(ev: BeButtonEvent): Promise<EventHandled> ElementSetTool  
onInstall(): Promise<boolean> ElementSetTool Override to execute additional logic when tool is installed.
onKeyTransition(_wentDown: boolean, _keyEvent: KeyboardEvent): Promise<EventHandled> ElementSetTool Called when any key is pressed or released.
onMiddleButtonDown(_ev: BeButtonEvent): Promise<EventHandled> ElementSetTool Invoked when the middle mouse button is pressed.
onMiddleButtonUp(_ev: BeButtonEvent): Promise<EventHandled> ElementSetTool Invoked when the middle mouse button is released.
onModifierKeyTransition(_wentDown: boolean, modifier: BeModifierKeys, _event: KeyboardEvent): Promise<EventHandled> ElementSetTool Update prompts, cursor, graphics, etc.
onMouseEndDrag(ev: BeButtonEvent): Promise<EventHandled> ElementSetTool Support completing active drag selection on mouse end drag event and update ElementSetTool.agenda.
onMouseMotion(ev: BeButtonEvent): Promise<void> ElementSetTool Make sure drag selection graphics are updated when mouse moves.
onMouseStartDrag(ev: BeButtonEvent): Promise<EventHandled> ElementSetTool Support initiating drag selection on mouse start drag event when allowDragSelect is true.
onMouseWheel(_ev: BeWheelEvent): Promise<EventHandled> ElementSetTool Invoked when the mouse wheel moves.
onPostInstall(): Promise<void> ElementSetTool Setup initial element state, prompts, check SelectionSet, etc.
onRedoPreviousStep(): Promise<boolean> ElementSetTool Called to reinstate to a previous tool state (ex.
onReinitialize(): Promise<void> ElementSetTool Exit and start default tool when isSelectionSetModify is true to allow SelectionSet to be modified,
onResetButtonDown(ev: BeButtonEvent): Promise<EventHandled> ElementSetTool  
onResetButtonUp(ev: BeButtonEvent): Promise<EventHandled> ElementSetTool  
onRestartTool(): Promise<void> Abstract ElementSetTool Called when an external event may invalidate the current tool's state.
onSelectedViewportChanged(_previous: undefined | Viewport, current: undefined | Viewport): Promise<void> ElementSetTool Called when active view changes.
onSuspend(): Promise<void> ElementSetTool Notification of a ViewTool or InputCollector starting and this tool is being suspended.
onTouchCancel(_ev: BeTouchEvent): Promise<void> ElementSetTool 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> ElementSetTool Called when the last touch point is removed from the surface completing the current gesture.
onTouchEnd(_ev: BeTouchEvent): Promise<void> ElementSetTool Called when user removes a touch point by lifting a finger or stylus from the surface.
onTouchMove(_ev: BeTouchEvent): Promise<void> ElementSetTool Called when a touch point moves along the surface.
onTouchMoveStart(_ev: BeTouchEvent, _startEv: BeTouchEvent): Promise<EventHandled> ElementSetTool 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> ElementSetTool Called when user adds a touch point by placing a finger or stylus on the surface.
onTouchTap(_ev: BeTouchEvent): Promise<EventHandled> ElementSetTool 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> ElementSetTool Called to reverse to a previous tool state (ex.
onUnsuspend(): Promise<void> ElementSetTool Restore tool assistance after no longer being suspended by either a ViewTool or InputCollector.
parseAndRun(..._args: string[]): Promise<boolean> ElementSetTool Run this instance of a tool using a series of string arguments.
processAgendaImmediate(): Promise<void> Protected ElementSetTool Sub-classes that return false for requireAcceptForSelectionSetOperation should override to apply the tool operation to ElementSetTool.agenda.
processDataButton(ev: BeButtonEvent): Promise<EventHandled> Protected ElementSetTool Orchestrates advancing the internal state of the tool on a data button event.
processResetButton(ev: BeButtonEvent): Promise<EventHandled> Protected ElementSetTool Orchestrates updating the internal state of the tool on a reset button event.
provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void Protected ElementSetTool Sub-classes should override to provide tool specific instructions.
reloadToolSettingsProperties(): void ElementSetTool Called by tool to inform UI to reload ToolSettings with new set of properties.
requireWriteableTarget(): boolean ElementSetTool 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> ElementSetTool Establish this tool as the active PrimitiveTool.
saveChanges(): Promise<void> ElementSetTool If this tool is editing a briefcase, commits any elements that the tool has changed, supplying the tool name as the undo string.
selectByPointsDecorate(context: DecorateContext): void Protected ElementSetTool Display drag box and crossing line selection graphics.
selectByPointsEnd(ev: BeButtonEvent): Promise<boolean> Protected ElementSetTool Finish drag selection and update ElementSetTool.agenda with any elements that may have been identified.
selectByPointsStart(ev: BeButtonEvent): Promise<boolean> Protected ElementSetTool Initiate tool state for start of drag selection.
setPreferredElementSource(): void Protected ElementSetTool Whether tool should operate on an existing selection set or instead prompt user to identity elements.
setupAndPromptForNextAction(): void Protected ElementSetTool Setup auto-locate, AccuSnap, AccuDraw, and supply tool assistance.
supplyToolSettingsProperties(): undefined | DialogItem[] ElementSetTool Used to supply list of properties that can be used to generate ToolSettings.
syncToolSettingsProperties(syncData: DialogPropertySyncItem[]): void ElementSetTool Called by tool to synchronize the UI with property changes made by tool.
testDecorationHit(_id: string): boolean ElementSetTool Called to support operations on pickable decorations, like snapping.
useOverlapSelection(ev: BeButtonEvent): boolean Protected ElementSetTool Whether drag box selection only identifies elements that are wholly inside or also allows those that overlap
wantProcessAgenda(_ev: BeButtonEvent): boolean Protected ElementSetTool Whether the tool is ready for processAgenda to be called to complete the tool operation.
register(namespace?: string): void Static ElementSetTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
_graphicsProvider Protected undefined | TransformGraphicsProvider    
_startedCmd Protected undefined | string    
allowDragSelect Accessor ProtectedReadOnly boolean    
allowGroups Accessor ProtectedReadOnly boolean    
allowSelectionSet Accessor ProtectedReadOnly boolean    
controlKeyContinuesSelection Accessor ProtectedReadOnly boolean    
wantAccuSnap Accessor ProtectedReadOnly boolean    
wantDynamics Accessor ProtectedReadOnly boolean    
wantMakeCopy Accessor ProtectedReadOnly boolean    
wantRepeatOperation Accessor ProtectedReadOnly boolean    

Inherited properties

Name Type Inherited from Description
agenda Accessor ProtectedReadOnly ElementAgenda ElementSetTool Get the ElementAgenda the tool will operate on.
anchorPoint Protected undefined | Point3d ElementSetTool The accept point for a selection set, drag select, or final located element.
briefcase Accessor ReadOnly undefined | BriefcaseConnection ElementSetTool Get the briefcase on which this tool operates, if the tool has successfully installed and the target iModel is a briefcase.
clearSelectionSet Accessor ProtectedReadOnly boolean ElementSetTool Whether to clear the active selection set for tools that return false for allowSelectionSet.
controlKeyInvertsSelection Accessor ProtectedReadOnly boolean ElementSetTool Whether to invert selection of elements identified with the ctrl key held down.
currentElementCount Accessor ProtectedReadOnly number ElementSetTool Convenience method to get current count from ElementSetTool.agenda.
description Accessor ReadOnly string ElementSetTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string ElementSetTool 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.
dragStartPoint Protected undefined | Point3d ElementSetTool The button down location that initiated box or crossing line selection.
englishKeyin Accessor StaticReadOnly string ElementSetTool 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 ElementSetTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string ElementSetTool 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 ElementSetTool If true, this Tool will not appear in the list from getToolList.
iconSpec Accessor ReadOnly string ElementSetTool Get the iconSpec from this Tool's class.
iconSpec Static string ElementSetTool The icon for this Tool.
iModel Accessor ReadOnly IModelConnection ElementSetTool Get the iModel on which this tool operates.
isControlDown Accessor ReadOnly boolean ElementSetTool Convenience method to check whether control key is currently down without needing a button event.
isDynamicsStarted Accessor ReadOnly boolean ElementSetTool Call to find out if dynamics are currently active.
isSelectByPoints Accessor ProtectedReadOnly boolean ElementSetTool Whether drag box or crossing line selection is currently active.
isSelectionSetModify Accessor ProtectedReadOnly boolean ElementSetTool Whether original source of elements being modified was the active selection set.
keyin Accessor ReadOnly string ElementSetTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string ElementSetTool 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 ElementSetTool 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 ElementSetTool 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 string ElementSetTool The namespace that provides localized strings for this Tool.
receivedDownEvent boolean ElementSetTool Used to avoid sending tools up events for which they did not receive the down event.
requireAcceptForSelectionSetDynamics Accessor ProtectedReadOnly boolean ElementSetTool Whether to begin dynamics for a selection set immediately or wait for a data button.
requireAcceptForSelectionSetOperation Accessor ProtectedReadOnly boolean ElementSetTool Whether a selection set should be processed immediately upon installation or require a data button to accept.
requiredElementCount Accessor ProtectedReadOnly number ElementSetTool Minimum required number of elements for tool to be able to complete.
shouldEnableLocate Accessor ProtectedReadOnly boolean ElementSetTool  
shouldEnableSnap Accessor ProtectedReadOnly boolean ElementSetTool  
targetIsLocked boolean ElementSetTool  
targetModelId Accessor undefined | string ElementSetTool  
targetView undefined | Viewport ElementSetTool The viewport within which the tool operates.
toolId Accessor ReadOnly string ElementSetTool 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 ElementSetTool The unique string that identifies this tool.
wantAdditionalElements Accessor ProtectedReadOnly boolean ElementSetTool Whether tool is done identifying elements and is ready to move to the next phase.
wantAdditionalInput Accessor ProtectedReadOnly boolean ElementSetTool Whether the tool has gathered enough input to call processAgenda.
Sub-classes should override to check for additional point input they collected in wantProcessAgenda.

Defined in

Last Updated: 16 April, 2024