Tool Class

Base Tool class for writing an immediate tool that executes it's assigned task immediately without further input.

see InteractiveTool for a base Tool class to handle user input events from a Viewport.

see Tools

Extended by

Methods

Name Description
constructor(..._args: any[]): Tool    
run(..._arg: any[]): boolean Run this instance of a Tool.  
register(namespace?: I18NNamespace): void Static Register this Tool class with the ToolRegistry.  

Properties

Name Type Description
description Accessor StaticReadOnly string Get the localized description for this Tool class.  
description Accessor ReadOnly string Get the localized description string from this Tool's class  
flyover Accessor StaticReadOnly string Get the localized flyover for this Tool class.  
flyover Accessor ReadOnly string Get the localized flyover string from this Tool's class  
hidden Static boolean If true, this Tool will not appear in the list from ToolRegistry.getToolList.  
keyin Accessor StaticReadOnly string Get the localized keyin string for this Tool class.  
keyin Accessor ReadOnly string Get the localized keyin string from this Tool's class  
namespace Static I18NNamespace The I18NNamespace that provides localized strings for this Tool.  
toolId Accessor ReadOnly string Get the toolId string for this Tool class.  
toolId Static string The unique string that identifies this tool.  

Defined in

Last Updated: 03 June, 2019