@fabwcie/free-drawing / components/toolbar/widgets/Eraser/Trail / Trail

Class: Trail

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:28

Trail following pointer: thinner towards its tail, points disappear after duration

Constructors

Constructor

new Trail(layer, options?): Trail

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:41

Create a trail, its line is added to the layer by start

Parameters

layer

Layer

Layer of the trail line (selection layer: not saved), its scale keeps trail size the same

options?

Partial<TrailOptions> = {}

Color, size, duration and glow, defaults for missing ones

Returns

Trail

Properties

layer

private readonly layer: Layer

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:43

Layer of the trail line (selection layer: not saved), its scale keeps trail size the same whatever zoom

---

options

readonly options: TrailOptions

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:30

Options given to constructor, completed with defaults

Methods

add()

add(x, y): void

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:74

Add pointer position (layer coordinates)

Parameters

x

number

Horizontal position of pointer, in layer coordinates

y

number

Vertical position of pointer, in layer coordinates

Returns

void

---

destroy()

destroy(): void

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:88

Remove trail now

Returns

void

---

start()

start(): void

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:52

Start following pointer, call add with its positions

Returns

void

---

stop()

stop(): void

Defined in: packages/free-drawing/src/components/toolbar/widgets/Eraser/Trail.ts:81

Stop following pointer, trail fades out then is removed

Returns

void