Monolook World API
Import
js
import { Monolook } from 'monolook/world'Constructor
js
const monolook = new Monolook({
adapter: 'three',
THREE,
scene,
camera,
renderer,
domOverlayRoot
})Opciones
| Opción | Tipo | Requerido | Descripción |
|---|---|---|---|
adapter | 'three' | 'aframe' | 'babylon' | Sí | Adapter integrado |
THREE | object | Three.js | Namespace de Three.js |
scene | object | Three/Babylon | Escena del motor |
camera | object | Three/Babylon | Cámara del motor |
renderer | object | Three | Renderer de Three.js |
sceneEl | HTMLElement | A-Frame | <a-scene> cargada |
engine | object | Babylon | Engine de Babylon.js |
BABYLON | object | Babylon | Namespace de Babylon.js |
domOverlayRoot | HTMLElement | No | Root para UI overlay en WebXR |
Métodos
| Método | Devuelve | Descripción |
|---|---|---|
start(options) | Promise<void> | Valida licencia e inicializa el SDK |
enterAR(options?) | Promise<XRSession | null> | Solicita sesión AR |
startTracking() | void | Activa búsqueda de superficies |
pauseTracking() | void | Pausa tracking |
setRenderLoop(callback) | void | Define loop de render |
updateTracking() | void | Actualiza cámara/indicador |
getIndicatorPose() | { position, rotation, visible } | null | Pose del punto de colocación |
setIndicatorVisible(visible) | void | Muestra/oculta indicador |
setTransparentBackground() | void | Fondo transparente para AR |
setDesktopBackground(color?) | void | Fondo para preview |
reset() | void | Restaura estado |
isPresenting() | boolean | Indica si hay sesión AR activa |
on(event, callback) | () => void | Suscribe evento |
off(event, callback) | void | Desuscribe evento |
start(options)
| Opción | Tipo | Requerido | Descripción |
|---|---|---|---|
mode | 'surface' | Sí | Modo de tracking |
licenseKey | string | Sí | License key de World |
Eventos
| Evento | Payload | Descripción |
|---|---|---|
surfacefound | { pose } | Superficie detectada |
surfacelost | object | Superficie perdida |
select | { nativeEvent } | Tap/select en AR |
sessionstart | { platform, ...payload } | Sesión iniciada |
sessionend | { platform, ...payload } | Sesión terminada |
trackingstart | undefined | Tracking activo |
trackingpause | undefined | Tracking pausado |
licensed | object | Licencia validada |
error | Error | Error |