Interface: OverlayCollection<ContentType>
Defined in: packages/3d-overlays/src/OverlayCollection.ts:36
A set of overlays managed.
Type Parameters
ContentType
ContentType
Methods
addOverlays()
addOverlays(
overlays):Overlay3D<ContentType>[]
Defined in: packages/3d-overlays/src/OverlayCollection.ts:47
Add overlays to the collection.
Parameters
overlays
OverlayInfo<ContentType>[]
Overlays to add to the collection.
Returns
Overlay3D<ContentType>[]
The added overlays.
getOverlays()
getOverlays():
Overlay3D<ContentType>[]
Defined in: packages/3d-overlays/src/OverlayCollection.ts:40
Get all overlays in the collection.
Returns
Overlay3D<ContentType>[]
removeAllOverlays()
removeAllOverlays():
void
Defined in: packages/3d-overlays/src/OverlayCollection.ts:58
Remove all overlays from the collection.
Returns
void
removeOverlays()
removeOverlays(
overlays):void
Defined in: packages/3d-overlays/src/OverlayCollection.ts:53
Remove overlays from the collection.
Parameters
overlays
Overlay3D<ContentType>[]
Overlays to remove from the collection.
Returns
void
setVisibility()
setVisibility(
visibility):void
Defined in: packages/3d-overlays/src/OverlayCollection.ts:63
Sets whether overlays in the collection should be visible.
Parameters
visibility
boolean
Returns
void