spatial-monorepo

---

spatial-monorepo / core/src / FloorPlanImageLayerClass

Class: FloorPlanImageLayerClass

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:127

MapLibre CustomLayerInterface that renders a homography-warped floor-plan raster image. Use this in read-only <SpatialMap> views.

Example

const layer = new FloorPlanImageLayer({
  id: 'floorplan-image-lobby',
  imageUrl: 'https://cdn.example.com/lobby.png',
  homography: [1,0,0, 0,1,0, 0,0,1],
  opacity: 0.8,
});
map.addLayer(layer, /* beforeId */);

Constructors

Constructor

new FloorPlanImageLayerClass(options): FloorPlanImageLayer

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:143

Parameters

options

FloorPlanImageLayerOptions

Returns

FloorPlanImageLayer

Properties

id

readonly id: string

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:129

---

type

readonly type: "custom"

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:128

Methods

getImageUrl()

getImageUrl(): string

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:307

Replaces the image URL — forces a re-initialization on next onAdd call.

Returns

string

---

getOpacity()

getOpacity(): number

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:291

Returns the current opacity.

Returns

number

---

isHidden()

isHidden(): boolean

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:302

Returns true when the layer is currently hidden.

Returns

boolean

---

onAdd()

onAdd(map, gl): void

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:153

Parameters

map

any

gl

WebGLRenderingContext

Returns

void

---

onRemove()

onRemove(_map, gl): void

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:263

Parameters

_map

any

gl

WebGLRenderingContext

Returns

void

---

render()

render(gl, options): void

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:220

Parameters

gl

WebGLRenderingContext

options

RenderMatrixArg

Returns

void

---

setHidden()

setHidden(hidden): void

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:296

Shows or hides the layer without removing it from the map.

Parameters

hidden

boolean

Returns

void

---

updateOpacity()

updateOpacity(opacity): void

Defined in: packages/core/src/layers/FloorPlanImageLayer.ts:285

Clamps opacity to [0, 1] and triggers a map repaint.

Parameters

opacity

number

Returns

void