API Reference › frontend-devTools› Tools › FreezeSceneTool

FreezeSceneTool Class

Freeze or unfreeze the scene for the selected viewport. While the scene is frozen, no new tiles will be selected for drawing within the viewport.

Extends

Methods

Name Description
constructor(..._args: any[]): FreezeSceneTool    
toggle(vp: Viewport, enable?: boolean): Promise<void> Protected    

Inherited methods

Name Inherited from Description
parseAndRun(...args: string[]): Promise<boolean> Inherited ViewportToggleTool Run this instance of a tool using a series of string arguments.
run(enable?: boolean): Promise<boolean> Inherited ViewportToggleTool Run this instance of a Tool.
register(namespace?: string): void Static Inherited ViewportToggleTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor Inherited ReadOnly string ViewportToggleTool Get the localized description string from this Tool's class
description Accessor Static Inherited ReadOnly string ViewportToggleTool 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 Static Inherited ReadOnly string ViewportToggleTool 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 Inherited ReadOnly string ViewportToggleTool Get the localized flyover string from this Tool's class
flyover Accessor Static Inherited ReadOnly string ViewportToggleTool 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 Inherited boolean ViewportToggleTool If true, this Tool will not appear in the list from ToolRegistry.getToolList.
iconSpec Accessor Inherited ReadOnly string ViewportToggleTool Get the iconSpec from this Tool's class.
iconSpec Static Inherited string ViewportToggleTool The icon for this Tool.
keyin Accessor Inherited ReadOnly string ViewportToggleTool Get the localized keyin string from this Tool's class
keyin Accessor Static Inherited ReadOnly string ViewportToggleTool 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 Static Inherited ReadOnly number ViewportToggleTool 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 Static Inherited ReadOnly number ViewportToggleTool 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 Inherited string ViewportToggleTool The namespace that provides localized strings for this Tool.
toolId Accessor Inherited ReadOnly string ViewportToggleTool 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.

Defined in

Last Updated: 29 November, 2024