Tools

Classes for working with Tools

Classes

Name Description
AccuDrawShortcuts A shortcut may require no user input (immediate) or it may install a viewing tool.Tool implementors should not use
AccuDrawTool
BeButtonEvent
BeButtonState
BeTouchEvent Specialization of ButtonEvent for touch input.
BeWheelEvent Information about movement of the mouse wheel.
ElementAgenda
EventController An EventController maps user input events from the canvas of a Viewport to the ToolAdmin so that tools can process them.
FitViewTool A tool that performs a fit view
FlyViewTool A tool that performs the fly operation
FuzzySearch
FuzzySearchResults This class is used to return the results of FuzzySearch.search.
IdleTool The default "idle" tool.
InputCollector The InputCollector class can be used to implement a command for gathering input (ex.
InteractiveTool A Tool that may be installed, via ToolAdmin, to handle user input.
LookViewTool A tool that performs the look operation
PanViewTool The tool that performs a Pan view operation
PluginTool An Immediate Tool that allows an iModelJs plugin module to be loaded .
PrimitiveTool The PrimitiveTool class can be used to implement tools to create or modify geometric elements.
RotateViewTool A tool that performs a Rotate view operation
ScrollViewTool A tool that performs the scroll operation
Tool Base Tool class for writing an immediate tool that executes it's assigned task immediately without further input.
ToolAdmin Controls operation of Tools.
ToolRegistry The ToolRegistry holds a mapping between toolIds and their corresponding Tool class.
ToolSettings Settings that control the behavior of built-in tools.
ViewManip Base class for tools that manipulate the frustum of a Viewport.
ViewRedoTool A tool that performs view redo operation.
ViewToggleCameraTool A tool that toggles the camera on/off in a spatial view
ViewTool An InteractiveTool that manipulates a view.
ViewUndoTool A tool that performs view undo operation.
WalkViewTool A tool that performs the walk operation
WindowAreaTool A tool that performs a Window-area view operation
ZoomViewTool A tool that performs the zoom operation

Enumerations

Name Description
BeButton
BeModifierKeys Numeric mask for a set of modifier keys (control, shift, and alt).
ClipResult Helps determine the action ModifyAgenda will take on the agenda elements after calling doFenceClip.
CoordinateLockOverrides
CoordSource The source that generated a coordinate.
ElemMethod The method that will be used to update the tool's ElementAgenda.
ElemSource The requested source for the elements to modify.
ErrorNums ElemSource specific failures.
EventHandled
HilitedState
InputSource The source that generated an event.
ManipulatorToolEvent
ModifyElementSource
StartOrResume
UsesDragSelect Should ElemSource::Pick allow a drag select to identify elements.
UsesFence Should the active fence be used, required, or ignored as a possible ElemSource.
UsesSelection Should the active selection set be used, required, or ignored as a possible ElemSource.
ViewHandleType
ViewHandleWeight
ViewManipPriority

Interfaces

Name Description
FuzzySearchResult Interface implemented by objects returned while iterating through FuzzySearchResults
GroupMark

Namespaces

Name Description
EditManipulator A manipulator maintains a set of controls used to modify element(s) or pickable decorations.

Type Aliases

Name Description
ToolList
ToolType

Last Updated: 17 December, 2018