Class PenMode

Abstract base class for all drawing modes. Each mode handles touch events and optionally draws an in-progress overlay.

Hierarchy (View Summary)

DrawingMode
- PenMode

Index

Constructors

Properties

Methods

activate deactivate drawOverlay onLayerRemoved onSnapShotRestored onTouchCancel onTouchEnd onTouchMove onTouchStart

Constructors

constructor

new PenMode(canvas: DrawingCanvas): PenMode
Parameters
- canvas: DrawingCanvas
Returns PenMode
Inherited from DrawingMode.constructor
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:15

Properties

`Protected`canvas

canvas: DrawingCanvas

`Readonly`name

name: "pen"

Methods

activate

activate(): void
Called when this mode becomes active

Returns void
Inherited from DrawingMode.activate
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:30

deactivate

deactivate(): void
Called when this mode becomes inactive

Returns void
Inherited from DrawingMode.deactivate
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:32

drawOverlay

drawOverlay(canvas: Canvas): void
Draw any in-progress overlay for this mode. Called during the DrawingCanvas onDraw pass after all layers.
Parameters
- canvas: Canvas
Returns void
Overrides DrawingMode.drawOverlay
- Defined in packages/ui-drawingcanvas/modes/PenMode.d.ts:11

onLayerRemoved

onLayerRemoved(shape: DrawableShape, index: number): void
Parameters
- shape: DrawableShape
- index: number
Returns void
Inherited from DrawingMode.onLayerRemoved
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:34

onSnapShotRestored

onSnapShotRestored(): void
Returns void
Inherited from DrawingMode.onSnapShotRestored
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:33

onTouchCancel

onTouchCancel(_point: TouchPoint): void
Called when the touch is cancelled
Parameters
- _point: TouchPoint
Returns void
Overrides DrawingMode.onTouchCancel
- Defined in packages/ui-drawingcanvas/modes/PenMode.d.ts:10

onTouchEnd

onTouchEnd(_point: TouchPoint): void
Called when the touch ends
Parameters
- _point: TouchPoint
Returns void
Overrides DrawingMode.onTouchEnd
- Defined in packages/ui-drawingcanvas/modes/PenMode.d.ts:9

onTouchMove

onTouchMove(point: TouchPoint): void
Called as the touch moves
Parameters
- point: TouchPoint
Returns void
Overrides DrawingMode.onTouchMove
- Defined in packages/ui-drawingcanvas/modes/PenMode.d.ts:8

onTouchStart

onTouchStart(point: TouchPoint): void
Called when a touch begins
Parameters
- point: TouchPoint
Returns void
Overrides DrawingMode.onTouchStart
- Defined in packages/ui-drawingcanvas/modes/PenMode.d.ts:7