Hierarchy

  • En

Constructors

  • Parameters

    • commInterface: string = 'vuplex'
    • w: Window = window

    Returns En

Properties

actionResult: Subject<MessageIncoming> = ...
actionResult$: Observable<MessageIncoming> = ...

actionResult$ - Observable to listen to action results from Endymion Browser

assetCollition: Subject<MessageIncoming> = ...
assetCollition$: Observable<MessageIncoming> = ...

assetCollition$ - Observable to listen to collitions messages from Endymion Browser

commInterface: string = 'vuplex'
connections: Map<number, null | EnWebview> = ...
currentConnectionImageId: number = -1
message: Subject<MessageIncoming> = ...
message$: Observable<MessageIncoming> = ...

message$ - Observable to listen to messages from Endymion Browser if debug mode is enabled, messages will be logged to console

pageVisibility: Subject<boolean> = ...
pageVisibility$: Observable<boolean> = ...

pageVisibility$ - Observable to listen to page visibility events from Endymion Browser

qrcode: {
    init: ((trackMode, maxActives?, maxCached?, refSize?) => void);
    reset: (() => void);
    run: (() => void);
    stop: (() => void);
} = ...

qrcode methods

Type declaration

  • init: ((trackMode, maxActives?, maxCached?, refSize?) => void)
      • (trackMode, maxActives?, maxCached?, refSize?): void
      • Parameters

        • trackMode: "anchor" | "cv"

          track mode to be used

        • maxActives: number = 1

          max possible active qrcodes at same time

        • maxCached: number = 10

          max number of qrcode to keep in cache

        • refSize: number = 0.1

          qrcode reference size in meters (only for "anchor" mode)

        Returns void

  • reset: (() => void)
      • (): void
      • qr code scan reset

        Returns void

  • run: (() => void)
      • (): void
      • qr code scan start

        Returns void

  • stop: (() => void)
      • (): void
      • qr code scan stop

        Returns void

qrcodeDetected: Subject<MessageIncoming> = ...
qrcodeDetected$: Observable<MessageIncoming> = ...

qrcodeDetected$ - Observable to listen qrcode detection event

trackImage: Subject<MessageIncoming> = ...
trackImage$: Observable<MessageIncoming> = ...

trackImage$ - Observable to listen to tracking image events from Endymion Browser

trackingImage: {
    add: ((url, refWidth?) => number);
    init: (() => void);
    reset: (() => void);
} = ...

Tracking Image methods allow to set an use image to start an experience

Type declaration

  • add: ((url, refWidth?) => number)
      • (url, refWidth?): number
      • Parameters

        • url: string
        • refWidth: number = 0.05

        Returns number

  • init: (() => void)
      • (): void
      • init tracking image system

        Returns void

  • reset: (() => void)
      • (): void
      • reset tracking image

        Returns void

w: Window = window
webViewMessage: Subject<MessageIncoming> = ...
webViewMessage$: Observable<MessageIncoming> = ...

webViewMessage$ - Observable to listen to webview messages from Endymion Browser

win: Win

Methods

  • add tracking image to the scene

    Parameters

    • url: string

      url of the image to be tracked

    • refWidth: number = 0.05

      reference width of the image to be tracked

    Returns number

    id of the image

    Obsolete

  • Parameters

    • enable: boolean
    • radius: number = 0

    Returns void

  • enable debug mode message from Endymion Browser will be logged to console action sended to Endymion Browser will be logged to console a box will appear in the scene to show the debug message

    Returns void

Generated using TypeDoc