five-on-it / apps/client/src/renderer/dog-view / Leads

Class: Leads

Defined in: apps/client/src/renderer/dog-view.ts:370

The leads drawn: a line per dog on its lead, made once and moved every frame. A frame starts with Leads.begin, places the leads that show and ends with Leads.end, which hides the others.

Constructors

Constructor

new Leads(scene): Leads

Defined in: apps/client/src/renderer/dog-view.ts:382

Parameters

scene

Scene

Returns

Leads

Accessors

shown

Get Signature

get shown(): number

Defined in: apps/client/src/renderer/dog-view.ts:387

Leads shown this frame.

Returns

number

Methods

begin()

begin(): void

Defined in: apps/client/src/renderer/dog-view.ts:394

Starts a frame: every lead hidden until placed.

Returns

void

---

dispose()

dispose(): void

Defined in: apps/client/src/renderer/dog-view.ts:444

Lets go of every lead, and of their material.

Returns

void

---

drop()

drop(eid): void

Defined in: apps/client/src/renderer/dog-view.ts:435

Lets go of the lead of the dog eid (gone).

Parameters

eid

number

Returns

void

---

end()

end(): void

Defined in: apps/client/src/renderer/dog-view.ts:424

Ends a frame: the leads nobody placed hidden.

Returns

void

---

place()

place(eid, hand, collar, floor): void

Defined in: apps/client/src/renderer/dog-view.ts:399

Draws the lead of the dog eid this frame, from its walker's hand to its collar, over ground floor high.

Parameters

eid

number

hand

Vector3

collar

Vector3

floor

number

Returns

void

---

pointsOf()

pointsOf(eid): readonly Vector3[] | undefined

Defined in: apps/client/src/renderer/dog-view.ts:429

Where the lead of the dog eid runs now (its points, hand first), or undefined when none is shown.

Parameters

eid

number

Returns

readonly Vector3[] | undefined