Interface PoiServiceInterface

interface PoiServiceInterface {
    highlightedPois: Set<PoiInterface>;
    onPoiClick: Signal<PoiClickHandler>;
    onPoiClose: Signal<PoiCloseHandler>;
    onPoiDelete: Signal<PoiDeleteHandler>;
    onPoiMouseOut: Signal<PoiMouseOutHandler>;
    onPoiMouseOver: Signal<PoiMouseOverHandler>;
    onPoiOpen: Signal<PoiOpenHandler>;
    onPoiSave: Signal<PoiSaveHandler>;
    onPoisHighlight: Signal<PoiHighlightHandler>;
    onPoisUnhighlight: Signal<PoiUnhighlightHandler>;
    openedPoi: PoiInterface;
    closePoi(): void;
    goToPoi(poi?: PoiInterface): Promise<void>;
    highlightPois(pois: PoiInterface[]): void;
    openPoi(poi: PoiInterface): boolean;
    refreshPois(resetCache?: boolean): void;
    unhighlightPois(pois: PoiInterface[]): void;
}

Properties

highlightedPois onPoiClick onPoiClose onPoiDelete onPoiMouseOut onPoiMouseOver onPoiOpen onPoiSave onPoisHighlight onPoisUnhighlight openedPoi

Methods

closePoi goToPoi highlightPois openPoi refreshPois unhighlightPois

Properties

ReadonlyhighlightedPois

highlightedPois: Set<PoiInterface>

An array of the POIs that have been highlighted in the scene.

ReadonlyonPoiClick

onPoiClick: Signal<PoiClickHandler>

Signal that is emitted when a user clicks the POI either in the scene or UI.

ReadonlyonPoiClose

onPoiClose: Signal<PoiCloseHandler>

Signal that is emitted when the POI details panel closed.

ReadonlyonPoiDelete

onPoiDelete: Signal<PoiDeleteHandler>

Signal that is emitted when a POI is deleted in the current, local session.

ReadonlyonPoiMouseOut

onPoiMouseOut: Signal<PoiMouseOutHandler>

Signal that is emitted when a user leaves the POI with mouse in the scene.

ReadonlyonPoiMouseOver

onPoiMouseOver: Signal<PoiMouseOverHandler>

Signal that is emitted when a user enters the POI with mouse in the scene.

ReadonlyonPoiOpen

onPoiOpen: Signal<PoiOpenHandler>

Signal that is emitted when the POI details panel is opened.

ReadonlyonPoiSave

onPoiSave: Signal<PoiSaveHandler>

Signal that is emitted when a POI is saved in the current, local session.

ReadonlyonPoisHighlight

onPoisHighlight: Signal<PoiHighlightHandler>

Signal that is emitted when POIs are highlighted.

ReadonlyonPoisUnhighlight

onPoisUnhighlight: Signal<PoiUnhighlightHandler>

Signal that is emitted when POIs are unhighlighted.

ReadonlyopenedPoi

openedPoi: PoiInterface

POI with the currently opened POI details panel.

Methods

closePoi

  • closePoi(): void

  • Closes the POI details panel if it is visible. Emits onPoiClose signal.

    Returns void

goToPoi

highlightPois

  • highlightPois(pois): void

  • Highlights given POIs in the scene. Emits onPoisHighlight signals.

    Parameters

    Returns void

openPoi

  • openPoi(poi): boolean

  • Opens the POI details panel. Closes the current openedPoi. Emits onPoiOpen signal.

    Parameters

    Returns boolean

    false if the details panel is deactivated in the settings.

refreshPois

  • refreshPois(resetCache?): void

  • Re-renders POIs in the scenes.

    Parameters

    • OptionalresetCache: boolean

      Reset requests cache

    Returns void

unhighlightPois

  • unhighlightPois(pois): void

  • Removes highlight from given POIs in the scene. Emits onPoisUnhighlight signals.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods