Skip to content

ui/map/rendering/IEntityRenderer

Interfaces

IEntityRenderer

Defined in: ui/map/rendering/IEntityRenderer.ts:11

Common interface for entity renderers (2D and 3D)

This interface provides a unified API for rendering entities on the map, allowing for different rendering implementations (e.g., 2D sprites, 3D models) to be used interchangeably.

Type Parameters

T

T extends EntityData

Methods

initialize()
initialize(map): void;

Defined in: ui/map/rendering/IEntityRenderer.ts:16

Initialize renderer and add to map

Parameters
map

Map$1

The MapLibre GL map instance

Returns

void

updateEntities()
updateEntities(entities, simTime): void;

Defined in: ui/map/rendering/IEntityRenderer.ts:23

Update entities with new data

Parameters
entities

Map\<string, T>

Map of entity ID to entity data

simTime

number

Current simulation time in seconds

Returns

void

updateDisplayOptions()
updateDisplayOptions(options): void;

Defined in: ui/map/rendering/IEntityRenderer.ts:29

Update display options (colors, sizes, visibility)

Parameters
options

DisplayOptions

Updated display options

Returns

void

onStyleChange()
onStyleChange(): void;

Defined in: ui/map/rendering/IEntityRenderer.ts:35

Handle map style changes Called when the map style is changed to allow renderer to recreate layers

Returns

void

destroy()
destroy(): void;

Defined in: ui/map/rendering/IEntityRenderer.ts:41

Cleanup resources Called when renderer is being destroyed or replaced

Returns

void

getType()
getType(): "2d" | "3d";

Defined in: ui/map/rendering/IEntityRenderer.ts:47

Get renderer type

Returns

"2d" | "3d"

'2d' for sprite-based rendering, '3d' for model-based rendering