Class SoundUITool

This tool, when enabled, plays a sound representing the color of the portion of the display currently under the cursor. This tool adds a button that can be navigated to with the tab key that enables/disables the tool.

This allows the user to explore the content of the display without a working screen.

Hierarchy (View Summary)

BaseTool
- SoundUITool

Constructors

constructor

new SoundUITool(editor: Editor, description: string): SoundUITool
Parameters
- editor: Editor
- description: string
Returns SoundUITool
Overrides BaseTool.constructor
- Defined in tools/SoundUITool.ts:128

Properties

`Readonly`description

description: string

Methods

canReceiveInputInReadOnlyEditor

canReceiveInputInReadOnlyEditor(): boolean
Override this to allow this tool to be enabled in a read-only editor

Returns boolean
Overrides BaseTool.canReceiveInputInReadOnlyEditor
- Defined in tools/SoundUITool.ts:148

enabledValue

enabledValue(): ReactiveValue<boolean>
Returns a ReactiveValue that updates based on whether this tool is enabled.

Returns ReactiveValue<boolean>
Example
```
const tool = new SomeTool();

// Watch for changes in enabled status
tool.enabledValue().onUpdate(enabled => doSomething(enabled));
```
Inherited from BaseTool.enabledValue
- Defined in tools/BaseTool.ts:180

getInputMapper

getInputMapper(): null | InputMapper
Returns null | InputMapper
Inherited from BaseTool.getInputMapper
- Defined in tools/BaseTool.ts:64

getToolGroup

getToolGroup(): null | ToolEnabledGroup
Returns null | ToolEnabledGroup
Inherited from BaseTool.getToolGroup
- Defined in tools/BaseTool.ts:194

isEnabled

isEnabled(): boolean
Returns boolean
Inherited from BaseTool.isEnabled
- Defined in tools/BaseTool.ts:164

onContextMenu

onContextMenu(_event: ContextMenuEvt): boolean
Parameters
- _event: ContextMenuEvt
Returns boolean
Inherited from BaseTool.onContextMenu
- Defined in tools/BaseTool.ts:147

onCopy

onCopy(_event: CopyEvent): boolean
Parameters
- _event: CopyEvent
Returns boolean
Inherited from BaseTool.onCopy
- Defined in tools/BaseTool.ts:131

onDestroy

onDestroy(): void
Called when the tool is removed/when the editor is destroyed. Subclasses that override this method must call super.onDestroy().

Returns void
Inherited from BaseTool.onDestroy
- Defined in tools/BaseTool.ts:204

onGestureCancel

onGestureCancel(): void
Returns void
Overrides BaseTool.onGestureCancel
- Defined in tools/SoundUITool.ts:224

onKeyPress

onKeyPress(event: KeyPressEvent): boolean
Parameters
- event: KeyPressEvent
Returns boolean
Overrides BaseTool.onKeyPress
- Defined in tools/SoundUITool.ts:176

onKeyUp

onKeyUp(_event: KeyUpEvent): boolean
Parameters
- _event: KeyUpEvent
Returns boolean
Inherited from BaseTool.onKeyUp
- Defined in tools/BaseTool.ts:143

onPaste

onPaste(_event: PasteEvent): boolean
Parameters
- _event: PasteEvent
Returns boolean
Inherited from BaseTool.onPaste
- Defined in tools/BaseTool.ts:135

onPointerDown

onPointerDown(__namedParameters: PointerEvt): boolean
Returns true iff the tool handled the event and thus should receive additional events.
Parameters
- __namedParameters: PointerEvt
Returns boolean
Overrides BaseTool.onPointerDown
- Defined in tools/SoundUITool.ts:187

onPointerMove

onPointerMove(__namedParameters: PointerEvt): void
Parameters
- __namedParameters: PointerEvt
Returns void
Overrides BaseTool.onPointerMove
- Defined in tools/SoundUITool.ts:206

onPointerUp

onPointerUp(_event: PointerEvt): void
Returns true iff there are additional pointers down and the tool should remain active to handle the additional events.

For most purposes, this should return false or nothing.
Parameters
- _event: PointerEvt
Returns void
Overrides BaseTool.onPointerUp
- Defined in tools/SoundUITool.ts:220

onWheel

onWheel(_event: WheelEvt): boolean
Parameters
- _event: WheelEvt
Returns boolean
Inherited from BaseTool.onWheel
- Defined in tools/BaseTool.ts:127

setEnabled

setEnabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Overrides BaseTool.setEnabled
- Defined in tools/SoundUITool.ts:163

setInputMapper

setInputMapper(mapper: null | InputMapper): void
Parameters
- mapper: null | InputMapper
Returns void
Inherited from BaseTool.setInputMapper
- Defined in tools/BaseTool.ts:57

setToolGroup

setToolGroup(group: ToolEnabledGroup): void
Connect this tool to a set of other tools, ensuring that at most one of the tools in the group is enabled.
Parameters
- group: ToolEnabledGroup
Returns void
Inherited from BaseTool.setToolGroup
- Defined in tools/BaseTool.ts:186

Class SoundUITool

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SoundUITool

Properties

Readonlydescription

Methods

canReceiveInputInReadOnlyEditor

Returns boolean

enabledValue

Returns ReactiveValue<boolean>

Example

getInputMapper

Returns null | InputMapper

getToolGroup

Returns null | ToolEnabledGroup

isEnabled

Returns boolean

onContextMenu

Parameters

Returns boolean

onCopy

Parameters

Returns boolean

onDestroy

Returns void

onGestureCancel

Returns void

onKeyPress

Parameters

Returns boolean

onKeyUp

Parameters

Returns boolean

onPaste

Parameters

Returns boolean

onPointerDown

Parameters

Returns boolean

onPointerMove

Parameters

Returns void

onPointerUp

Parameters

Returns void

onWheel

Parameters

Returns boolean

setEnabled

Parameters

Returns void

setInputMapper

Parameters

Returns void

setToolGroup

Parameters

Returns void

Settings

On This Page

`Readonly`description