API Reference > frontend-devTools > Tools > FreezeSceneTool

FreezeSceneTool Class

Beta  

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): void Protected    

Inherited methods

Name Inherited from Description
parseAndRun(...args: string[]): boolean ViewportToggleTool  
run(enable?: boolean): boolean ViewportToggleTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static 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 ReadOnly string ViewportToggleTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly 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,
ViewportToggleTool.flyover is returned.
englishKeyin Accessor StaticReadOnly 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 ReadOnly string ViewportToggleTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly 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,
ViewportToggleTool.keyin is returned.
hidden Static boolean ViewportToggleTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N ViewportToggleTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string ViewportToggleTool Get the iconSpec from this Tool's class.
iconSpec Static string ViewportToggleTool The icon for this Tool.
keyin Accessor ReadOnly string ViewportToggleTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly 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 StaticReadOnly number ViewportToggleTool  
minArgs Accessor StaticReadOnly number ViewportToggleTool  
namespace Static I18NNamespace ViewportToggleTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor 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: 12 June, 2024