Class: MapWaypointColliderController

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:26

Controls the registration of map colliders for rendered waypoints.

Extends

• MapSystemController<any, any, any, MapWaypointColliderControllerContext>

Constructors

Constructor

new MapWaypointColliderController(context, colliderFactory): MapWaypointColliderController

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:38

Creates a new instance of MapWaypointColliderController. The controller is initialized to a paused state.

Parameters

Parameter	Type	Description
context	MapSystemContext<any, any, any, MapWaypointColliderControllerContext>	This controller's map context.
colliderFactory	MapWaypointIconColliderFactory	The factory used by this controller to create and manage colliders for rendered waypoints.

Returns

MapWaypointColliderController

Overrides

MapSystemController.constructor

Properties

context

protected readonly context: MapSystemContext<any, any, any, MapWaypointColliderControllerContext>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24

Inherited from

MapSystemController.context

Accessors

isAlive

Get Signature

get isAlive(): boolean

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:20

Whether this controller is alive.

Returns

boolean

Inherited from

MapSystemController.isAlive

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:197

Destroys this controller.

Returns

void

Overrides

MapSystemController.destroy

---

isResumed()

isResumed(): boolean

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:59

Checks whether this controller is resumed.

Returns

boolean

Whether this controller is resumed.

---

onAfterMapRender()

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:46

This method is called after this controller' map is rendered.

Returns

void

Overrides

MapSystemController.onAfterMapRender

---

onAfterUpdated()

onAfterUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:78

This method is called immediately after this controller's map updates its layers.

Parameters

Parameter	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onAfterUpdated

---

onBeforeUpdated()

onBeforeUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:68

This method is called immediately before this controller's map updates its layers.

Parameters

Parameter	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onBeforeUpdated

---

onDeadZoneChanged()

onDeadZoneChanged(deadZone): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:48

This method is called when the dead zone of this controller's map changes.

Parameters

Parameter	Type	Description
deadZone	ReadonlyFloat64Array	The map's new dead zone.

Returns

void

Inherited from

MapSystemController.onDeadZoneChanged

---

onMapDestroyed()

onMapDestroyed(): void

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:192

This method is called when this controller's map is destroyed.

Returns

void

Overrides

MapSystemController.onMapDestroyed

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:58

This method is called when the projection of this controller's map changes.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The map projection.
changeFlags	number	Bit flags describing the type of change.

Returns

void

Inherited from

MapSystemController.onMapProjectionChanged

---

onSleep()

onSleep(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:92

This method is called when this controller's map is put to sleep.

Returns

void

Inherited from

MapSystemController.onSleep

---

onWake()

onWake(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:85

This method is called when this controller's map is awakened.

Returns

void

Inherited from

MapSystemController.onWake

---

pause()

pause(): void

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:84

Pauses this controller. When paused, the controller immediately deregisters all colliders for any currently rendered waypoints and will not automatically register colliders as waypoints are rendered.

Returns

void

---

resume()

resume(): void

Defined in: src/garminsdk/components/map/controllers/MapWaypointColliderController.ts:67

Resumes this controller. When resumed, the controller immediately registers colliders for all currently rendered waypoints and will automatically register and deregister colliders as waypoints are rendered and unrendered.

Returns

void