Skip to main content
Version: 4.x

Interface: OverlayCollection<ContentType>

A set of overlays managed.

Type Parameters

ContentType

Methods

addOverlays()

addOverlays(overlays): Overlay3D<ContentType>[]

Add overlays to the collection.

Parameters

overlays: OverlayInfo<ContentType>[]

Overlays to add to the collection.

Returns

Overlay3D<ContentType>[]

The added overlays.

Defined in

packages/3d-overlays/src/OverlayCollection.ts:47


getOverlays()

getOverlays(): Overlay3D<ContentType>[]

Get all overlays in the collection.

Returns

Overlay3D<ContentType>[]

Defined in

packages/3d-overlays/src/OverlayCollection.ts:40


removeAllOverlays()

removeAllOverlays(): void

Remove all overlays from the collection.

Returns

void

Defined in

packages/3d-overlays/src/OverlayCollection.ts:58


removeOverlays()

removeOverlays(overlays): void

Remove overlays from the collection.

Parameters

overlays: Overlay3D<ContentType>[]

Overlays to remove from the collection.

Returns

void

Defined in

packages/3d-overlays/src/OverlayCollection.ts:53


setVisibility()

setVisibility(visibility): void

Sets whether overlays in the collection should be visible.

Parameters

visibility: boolean

Returns

void

Defined in

packages/3d-overlays/src/OverlayCollection.ts:63