API Reference > frontend-devTools > Tools > ToggleSkyboxTool

ToggleSkyboxTool Class

Beta  

Toggles the skybox.

Extends

Methods

Name Description
constructor(..._args: any[]): ToggleSkyboxTool    
execute(vp: Viewport): boolean    
parse(_args: string[]): boolean    

Inherited methods

Name Inherited from Description
parseAndRun(...args: string[]): boolean DisplayStyleTool  
run(): boolean DisplayStyleTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static DisplayStyleTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
require3d Accessor ReadOnly boolean    
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string DisplayStyleTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string DisplayStyleTool 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,
DisplayStyleTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string DisplayStyleTool 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 DisplayStyleTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string DisplayStyleTool 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,
DisplayStyleTool.keyin is returned.
hidden Static boolean DisplayStyleTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N DisplayStyleTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string DisplayStyleTool Get the iconSpec from this Tool's class.
iconSpec Static string DisplayStyleTool The icon for this Tool.
keyin Accessor ReadOnly string DisplayStyleTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string DisplayStyleTool 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 DisplayStyleTool The maximum number of arguments allowed by DisplayStyleTool.parseAndRun, or undefined if there is no maximum.
If subclasses override DisplayStyleTool.parseAndRun, they should also override this method to indicate the maximum
number of arguments their implementation expects.
minArgs Accessor StaticReadOnly number DisplayStyleTool The minimum number of arguments allowed by DisplayStyleTool.parseAndRun. If subclasses override DisplayStyleTool.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 I18NNamespace DisplayStyleTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string DisplayStyleTool 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: 11 June, 2024