UNPKG

@plattar/plattar-ar-adapter

Version:

Plattar AR Adapter for interfacing with Google & Apple WebAR

40 lines (39 loc) 1.22 kB
import { LauncherAR } from "./launcher-ar"; export interface SceneVariationSelection { readonly sceneProductID?: string; readonly productID?: string; readonly variationID?: string; } export interface SceneAROptions { readonly sceneID: string; readonly variationSelection: SceneVariationSelection; readonly useARBanner: boolean; } /** * Performs AR functionality related to Plattar Scenes */ export declare class SceneAR extends LauncherAR { private _analytics; private readonly _options; private _ar; constructor(options: SceneAROptions); get sceneID(): string; private _SetupAnalytics; /** * Composes a Scene into an AR Model (remote operation) that can be used to launch * an AR File */ private _ComposeScene; /** * Initialise the SceneAR instance. This returns a Promise that resolves * successfully if initialisation is successful, otherwise it will fail. * * filure can occur for a number of reasons but it generally means that AR * cannot be performed. */ init(): Promise<LauncherAR>; start(): void; canQuicklook(): boolean; canRealityViewer(): boolean; canSceneViewer(): boolean; }