Monolook World API

Import

import { Monolook } from 'monolook/world'

const monolook = new Monolook({
  adapter: 'three',
  THREE,
  scene,
  camera,
  renderer,
  domOverlayRoot
})

Option	Type	Required	Description
`adapter`	`'three' \| 'aframe' \| 'babylon'`	Yes	Built-in adapter
`THREE`	`object`	Three.js	Three.js namespace
`scene`	`object`	Three/Babylon	Engine scene
`camera`	`object`	Three/Babylon	Engine camera
`renderer`	`object`	Three	Three.js renderer
`sceneEl`	`HTMLElement`	A-Frame	Loaded `<a-scene>`
`engine`	`object`	Babylon	Babylon.js engine
`BABYLON`	`object`	Babylon	Babylon.js namespace
`domOverlayRoot`	`HTMLElement`	No	Root for WebXR overlay UI

Method	Returns	Description
`start(options)`	`Promise<void>`	Validates license and initializes SDK
`enterAR(options?)`	`Promise<XRSession \| null>`	Requests AR session
`startTracking()`	`void`	Starts surface search
`pauseTracking()`	`void`	Pauses tracking
`setRenderLoop(callback)`	`void`	Sets render loop
`updateTracking()`	`void`	Updates camera/indicator
`getIndicatorPose()`	`{ position, rotation, visible } \| null`	Placement point pose
`setIndicatorVisible(visible)`	`void`	Shows/hides indicator
`setTransparentBackground()`	`void`	Transparent AR background
`setDesktopBackground(color?)`	`void`	Preview background
`reset()`	`void`	Resets state
`isPresenting()`	`boolean`	Whether an AR session is active
`on(event, callback)`	`() => void`	Subscribes to event
`off(event, callback)`	`void`	Unsubscribes event

Option	Type	Required	Description
`mode`	`'surface'`	Yes	Tracking mode
`licenseKey`	`string`	Yes	World license key