Class EraserTool

A tool that allows a user to erase parts of an image.

Hierarchy (View Summary)

BaseTool
- EraserTool

Constructors

constructor

new EraserTool(
    editor: Editor,
    description: string,
    options?: InitialEraserOptions,
): EraserTool
Parameters
- editor: Editor
- description: string
- Optionaloptions: InitialEraserOptions
Returns EraserTool
Overrides BaseTool.constructor
- Defined in tools/Eraser.ts:108

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
Inherited from BaseTool.canReceiveInputInReadOnlyEditor
- Defined in tools/BaseTool.ts:53

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

getModeValue

getModeValue(): MutableReactiveValue<EraserMode>
Returns MutableReactiveValue<EraserMode>
An object that allows switching between a full stroke and a partial stroke eraser.
- Defined in tools/Eraser.ts:381

getThickness

getThickness(): number
Returns the side-length of the tip of this eraser.

Returns number
- Defined in tools/Eraser.ts:363

getThicknessValue

getThicknessValue(): MutableReactiveValue<number>
Returns a MutableReactiveValue that can be used to watch this tool's thickness.

Returns MutableReactiveValue<number>
- Defined in tools/Eraser.ts:376

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

makeEraserSwitcherTool

makeEraserSwitcherTool(): BaseTool
Returns BaseTool
a tool that briefly enables the eraser when a physical eraser is used. This tool should be added to the tool list after the primary tools.
- Defined in tools/Eraser.ts:139

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(_event: GestureCancelEvt): void
Parameters
- _event: GestureCancelEvt
Returns void
Overrides BaseTool.onGestureCancel
- Defined in tools/Eraser.ts:335

onKeyPress

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

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(event: PointerEvt): boolean
Returns true iff the tool handled the event and thus should receive additional events.
Parameters
- event: PointerEvt
Returns boolean
Overrides BaseTool.onPointerDown
- Defined in tools/Eraser.ts:269

onPointerMove

onPointerMove(event: PointerEvt): void
Parameters
- event: PointerEvt
Returns void
Overrides BaseTool.onPointerMove
- Defined in tools/Eraser.ts:283

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/Eraser.ts:289

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
Inherited from BaseTool.setEnabled
- Defined in tools/BaseTool.ts:160

setInputMapper

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

setThickness

setThickness(thickness: number): void
Sets the side-length of this' tip.
Parameters
- thickness: number
Returns void
- Defined in tools/Eraser.ts:368

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

OpenSource licenses