API Reference > frontend-devTools > Tools > TogglePrimitiveVisibilityTool

TogglePrimitiveVisibilityTool Class

Beta  

Control whether all geometry renders, or only instanced or batched geometry. Allowed argument: "instanced", "batched", "all". Defaults to "all" if no arguments supplied.

Extends

Methods

Name Description
constructor(..._args: any[]): TogglePrimitiveVisibilityTool    
execute(control: RenderTargetDebugControl, vp: ScreenViewport): void    
parseAndRun(...args: string[]): boolean Run this instance of a tool using a series of string arguments.  

Inherited methods

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

Properties

Name Type Description
maxArgs Accessor StaticReadOnly number    
minArgs Accessor StaticReadOnly number    
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string RenderTargetDebugControlTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string RenderTargetDebugControlTool 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,
RenderTargetDebugControlTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string RenderTargetDebugControlTool 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 RenderTargetDebugControlTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string RenderTargetDebugControlTool 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,
RenderTargetDebugControlTool.keyin is returned.
hidden Static boolean RenderTargetDebugControlTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N RenderTargetDebugControlTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string RenderTargetDebugControlTool Get the iconSpec from this Tool's class.
iconSpec Static string RenderTargetDebugControlTool The icon for this Tool.
keyin Accessor ReadOnly string RenderTargetDebugControlTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string RenderTargetDebugControlTool 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").
namespace Static I18NNamespace RenderTargetDebugControlTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string RenderTargetDebugControlTool 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