Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AvGadget

The singleton gadget object for the browser.

Hierarchy

  • AvGadget

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

initialInterfaces

  • get initialInterfaces(): InitialInterfaceLock[]

isRemote

  • get isRemote(): boolean

manifest

  • get manifest(): AardvarkManifest

url

  • get url(): string

Methods

clearInterfaceEntityProcessor

  • clearInterfaceEntityProcessor(nodeId: number): void

findInitialInterface

  • findInitialInterface(intefaceName: string): InitialInterfaceLock

  • Returns a specific initial interface lock if it exists.

    Parameters

    • intefaceName: string

    Returns InitialInterfaceLock

getActionStateForHand

  • getActionStateForHand(hand: EHand, action: EAction): boolean

  • Returns true if the gadget is in edit mode for the specified hand.

    Parameters

    • hand: EHand
    • action: EAction

    Returns boolean

getEndpointAddressForId

  • getEndpointAddressForId(id: string): EndpointAddr

  • Returns the endpoint address for a DOM node Id, or null if there isn't a matching Aardvark node with that Id.

    Parameters

    • id: string

    Returns EndpointAddr

getEndpointId

  • getEndpointId(): number

getInstalledGadgets

  • getInstalledGadgets(): Promise<string[]>

getName

  • getName(): string

listenForActionState

  • listenForActionState(action: EAction, hand: EHand, rising: () => void, falling: () => void): number

  • Parameters

    • action: EAction
    • hand: EHand
    • rising: () => void
        • (): void

        • Returns void

    • falling: () => void
        • (): void

        • Returns void

    Returns number

listenForActionStateWithComponent

  • listenForActionStateWithComponent(hand: EHand, action: EAction, comp: Component): number

listenForVector2ActionState

  • listenForVector2ActionState(action: EAction, hand: EHand, update: (value: [number, number]) => void): number

  • Parameters

    • action: EAction
    • hand: EHand
    • update: (value: [number, number]) => void
        • (value: [number, number]): void

        • Parameters

          • value: [number, number]

          Returns void

    Returns number

loadManifest

  • loadManifest(gadgetUri: string): Promise<AardvarkManifest>

  • Loads a gadget manifest by gadget URI.

    Parameters

    • gadgetUri: string

    Returns Promise<AardvarkManifest>

    a promise that will resolve to the specified gadget's manifest

markDirty

  • markDirty(): void

onEndpointOpen

  • onEndpointOpen(settings: any): void

onGadgetStarted

  • onGadgetStarted(m: MsgGadgetStarted, env: Envelope): void

register

registerAsyncMessageHandler

  • registerAsyncMessageHandler(type: MessageType, handler: AsyncMessageHandler): void

  • Adds an asynchronous handler for a raw Aardvark message. You probably don't need this.

    Parameters

    • type: MessageType
    • handler: AsyncMessageHandler

    Returns void

registerForSettings

  • registerForSettings(callback: (settings: any) => void): void

  • The callback registered with this function will be invoked when the gadget's settings are reloaded from the server.

    Parameters

    • callback: (settings: any) => void
        • (settings: any): void

        • Parameters

          • settings: any

          Returns void

    Returns void

registerMessageHandler

  • registerMessageHandler(type: MessageType, handler: MessageHandler): void

  • Adds a handler for a raw Aardvark message. You probably don't need this.

    Parameters

    • type: MessageType
    • handler: MessageHandler

    Returns void

saveSettings

  • saveSettings(settings: any): void

  • Persists the gadget's settings. These weill be passed to the gadget via the callback registered with registerForSettings whenever the gadget is reloaded.

    Parameters

    • settings: any

    Returns void

sendHapticEvent

  • sendHapticEvent(nodeId: EndpointAddr, amplitude: number, frequency: number, duration: number): void

  • Parameters

    • nodeId: EndpointAddr
    • amplitude: number
    • frequency: number
    • duration: number

    Returns void

sendInterfaceEvent

  • sendInterfaceEvent(nodeId: number, destination: EndpointAddr, iface: string, data: object): void

sendMessage

  • sendMessage(type: MessageType, message: object, sendingNode?: number): void

  • Sends a message to the server. You probably don't need this either.

    Parameters

    • type: MessageType
    • message: object
    • Optional sendingNode: number

    Returns void

sendMessageAndWaitForResponse

  • sendMessageAndWaitForResponse<T>(type: MessageType, msg: any, responseType: MessageType): Promise<[T, Envelope]>

  • Sends a message and returns a promise that resolves when the response to that message arrives.

    Type parameters

    • T

    Parameters

    • type: MessageType
    • msg: any
    • responseType: MessageType

    Returns Promise<[T, Envelope]>

setInterfaceEntityProcessor

setInterfaceEventProcessor

  • setInterfaceEventProcessor(nodeId: number, processor: AvInterfaceEventProcessor): void

startGadget

  • startGadget(uri: string, initialInterfaces: InitialInterfaceLock[]): Promise<AvStartGadgetResult>

  • Parameters

    • uri: string
    • initialInterfaces: InitialInterfaceLock[]

    Returns Promise<AvStartGadgetResult>

unlistenForActionState

  • unlistenForActionState(handle: number): void

unregister

updateSceneGraph

  • updateSceneGraph(): void

waitForConnect

  • waitForConnect(): Promise<unknown>

  • Returns a promise that resolves when the initial endpoint handshake is complete

    Returns Promise<unknown>

Static instance

Generated using TypeDoc