editor › Globals › HintDataProvider

Class: HintDataProvider

Abstract class for something that provides some kind of data to hints. The idea is that hints themselves do not need to know the specifics of the data source, but just what kind of data (position, rotation, …) they provide.

Hierarchy

• HintDataProvider

↳ HintPositionProvider

↳ HintRotationProvider

Index

Methods

• calculate
• destroy
• isValid

Methods

Abstract calculate

▸ calculate(): void

Defined in src/renderContext/hints/HintDataProvider.ts:15

Trigger recalculation of internally stored values

Returns: void

---

destroy

▸ destroy(): void

Defined in src/renderContext/hints/HintDataProvider.ts:20

Called when the hint that uses this provider is destroyed. You want to do cleanup here.

Returns: void

---

Abstract isValid

▸ isValid(): boolean

Defined in src/renderContext/hints/HintDataProvider.ts:10

Checks whether this hint is still valid (e.g. edge it annotates still exists)

Returns: boolean