Tools

Interactive- and immediate-mode tools, most of which can be executed via key-in. All key-ins are documented in the package's README.

Classes

Name Description  
AnimationIntervalTool Changes the IModelApp.animationInterval. Beta
ApplyRenderingStyleTool Given a "rendering style" as a partial DispalyStyle3dSettingsProperties JSON string, apply it to the selected viewport's display style. Beta
ApplyViewByIdTool Given the Id of a persistent ViewDefinition, applies that view to the active viewport. Beta
ApplyViewTool Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport. Beta
ChangeEmphasisSettingsTool Changes the selected viewport's emphasis settings. Beta
ChangeHiliteSettingsTool Changes the selected viewport's hilite settings, or resets to defaults. Beta
ChangeHiliteTool Changes the selected viewport's hilite or emphasis settings. Beta
ChangeUnitsTool Controls whether quantities are formatted using imperial or metric units. Beta
ChangeViewFlagsTool Modifies the selected viewport's ViewFlags. Beta
ClearIsolatedElementsTool Clear the set of isolated elements. Beta
ClearModelAppearanceOverrides clear model appearance overrides in display style. Beta
ClearRealityModelAppearanceOverrides Clear reality model appearance override in display style. Beta
CompileShadersTool Compiles all registered shader programs for which compilation has not already been attempted. Beta
DisplayStyleTool Modifies the selected viewport's DisplayStyleState. Beta
ElementIdFromSourceAspectIdTool Given the Id of an element in the iModel, output the source aspect Id of the object in the source document from which the element originated. Beta
EmphasizeElementsTool Applies the EmphasizeElements API in some way to the selected Viewport. Beta
EmphasizeSelectedElementsTool If any elements are selected, emphasize them all by overriding their color to be orange; and de-emphasize all other elements by drawing them transparent grey. Beta
FadeOutTool Enables or disables fade-out transparency mode for the selected viewport. Beta
FreezeSceneTool Freeze or unfreeze the scene for the selected viewport. Beta
FrustumDecorator Decorates the viewport with a graphical depiction of a Frustum. Beta
IsolateSelectedElementsTool Isolate all selected elements so that only those elements will be drawn. Beta
LoseWebGLContextTool Forces webgl context loss. Beta
ProjectExtentsDecoration Beta
RenderSystemDebugControlTool Executes some code against a RenderSystemDebugControl obtained from the IModelApp's RenderSystem. Beta
RenderTargetDebugControlToggleTool Toggles some aspect of a RenderTargetDebugControl for the selected viewport. Beta
RenderTargetDebugControlTool Executes some code against a RenderTargetDebugControl obtained from the selected viewport. Beta
ReportWebGLCompatibilityTool Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager. Beta
SaveRenderingStyleTool Outputs (and optionally copies to the clipboard) a "rendering style" as a partial DisplayStyle3dSettingsProps JSON object based Beta
SaveViewTool Copies a JSON representation of the active viewport's view to the clipboard. Beta
SelectElementsByIdTool Replaces the contents of the selection set with the set of element Ids specified. Beta
SetModelColorTool Set model appearance override for color in display style. Beta
SetModelEmphasizedTool Set model appearance override for emphasized in display style. Beta
SetModelIgnoresMaterialsTool Set model appearance override for ignoreMaterials in display style. Beta
SetModelLineCodeTool Set model appearance override for line code in display style. Beta
SetModelLineWeightTool Set model appearance override for line weight in display style. Beta
SetModelLocateTool Set model appearance override for nonLocatable in display style. Beta
SetModelTransparencyTool Set model appearance override for transparency in display style. Beta
SetRealityModelColorTool Set reality model appearance override for color in display style. Beta
SetRealityModelEmphasizedTool Set reality model appearance override for emphasized in display style. Beta
SetRealityModelLocateTool Set reality model appearance override for locatable in display style. Beta
SetRealityModelTransparencyTool Set reality model appearance override for transparency in display style. Beta
ShowTileVolumesTool Set the tile bounding volume decorations to display in the selected viewport. Beta
SourceAspectIdFromElementIdTool Given a source aspect Id, output the Id of the corresponding element in the iModel. Beta
SourceAspectIdTool Base class for a tool that can convert between source aspect Ids and element Ids. Beta
ToggleDPIForLODTool Toggles whether or not device pixel ratio should be taken into account when computing LOD for tiles and decoration graphics. Beta
ToggleFrustumSnapshotTool Enable ("ON"), disable ("OFF"), or toggle ("TOGGLE" or omitted) the FrustumDecorator. Beta
TogglePrimitiveVisibilityTool Control whether all geometry renders, or only instanced or batched geometry. Beta
ToggleProjectExtentsTool Enable or disable project extents decoration. Beta
ToggleReadPixelsTool Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Beta
ToggleSelectedViewFrustumTool Enable ("ON"), disable ("OFF"), or toggle ("TOGGLE" or omitted) the selected view frustum decoration. Beta
ToggleShadowFrustumTool Toggle visualization of the selected viewport's shadow frustum in all other viewports. Beta
ToggleSkyboxTool Toggles the skybox. Beta
ToggleTileRequestDecorationTool Display in every viewport a range graphic for every tile currently being requested for the viewport that was initially selected when the decorator was installed. Beta
ToggleTileTreeBoundsDecorationTool Display in every viewport a green range graphic for each displayed tile tree, plus a red range graphic for each tile tree's content range if defined. Beta
ToggleToolTipsTool Replaces the default tooltips displayed when mousing over elements to instead display information useful for debugging, including Beta
ToggleViewAttachmentBoundariesTool Toggle display of view attachment boundaries in sheet views. Beta
ToggleViewAttachmentClipShapesTool Toggle display of view attachment clip shapes in sheet views. Beta
ToggleViewAttachmentsTool Toggles display of view attachments in sheet views. Beta
ToggleWiremeshTool Toggles pseudo-wiremesh surface display, for better visualization of mesh faces. Beta
ViewportToggleTool Base class for a tool that toggles some aspect of a Viewport. Beta

Global Functions

Name Description  
deserializeViewState Instantiate a ViewState serialized by [serializeViewState]. Beta
parseArgs Given a list of arguments, parse the arguments into name-value pairs. Beta
serializeViewState Serialize a ViewState to JSON. Beta
toggleProjectExtents Enable or disable the project extents decoration. Beta

Interfaces

Name Description  
ToolArgs Represents parsed arguments as name-value pairs. Beta

Last Updated: 16 August, 2020