Class Tool<T>`Abstract`

Base class for all tools.

Type Parameters

T extends ToolArgumentTypes

Index

Constructors

Methods

cancel execute handle opened valid

Constructors

constructor

new Tool<T extends ToolArgumentTypes>(): Tool<T>
Constructor.
Type Parameters
- T extends ToolArgumentTypes
Returns Tool<T>

Methods

cancel

cancel(object: T): void
Called when the user requests to cancel the tool.
Parameters
- object: T
  The context argument, which can be used by the tool.
Returns void

`Abstract`execute

execute(object: T): void
Called when the user requests to execute the tool.
Parameters
- object: T
  The context argument, which can be used by the tool.
Returns void

handle

handle<T extends ITrackable<any>>(
type: TrackableType<T>,
value?: null | T,
): Handle<T>
Creates a handle (weak reference) to a trackable object.
Type Parameters
- T extends ITrackable<any>
Parameters
- type: TrackableType<T>
  The type of object that is to be referenced.
- value: null | T = null
  The object that is initially referenced by the handle.
Returns Handle<T>
A handle to a trackable object.

opened

opened(object: T): void
Called when the user requests to use the tool.
Parameters
- object: T
  The context argument, which can be used by the tool.
Returns void

`Abstract`valid

valid(object: T): boolean
Whether the tool should be displayed to the user.
Parameters
- object: T
  The argument that would be passed to the tool.
Returns boolean
True if the tool should be displayed, false otherwise.