Skip to content

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ónTipoRequeridoDescripción
adapter'three' | 'aframe' | 'babylon'Adapter integrado
THREEobjectThree.jsNamespace de Three.js
sceneobjectThree/BabylonEscena del motor
cameraobjectThree/BabylonCámara del motor
rendererobjectThreeRenderer de Three.js
sceneElHTMLElementA-Frame<a-scene> cargada
engineobjectBabylonEngine de Babylon.js
BABYLONobjectBabylonNamespace de Babylon.js
domOverlayRootHTMLElementNoRoot para UI overlay en WebXR

Métodos

MétodoDevuelveDescripción
start(options)Promise<void>Valida licencia e inicializa el SDK
enterAR(options?)Promise<XRSession | null>Solicita sesión AR
startTracking()voidActiva búsqueda de superficies
pauseTracking()voidPausa tracking
setRenderLoop(callback)voidDefine loop de render
updateTracking()voidActualiza cámara/indicador
getIndicatorPose(){ position, rotation, visible } | nullPose del punto de colocación
setIndicatorVisible(visible)voidMuestra/oculta indicador
setTransparentBackground()voidFondo transparente para AR
setDesktopBackground(color?)voidFondo para preview
reset()voidRestaura estado
isPresenting()booleanIndica si hay sesión AR activa
on(event, callback)() => voidSuscribe evento
off(event, callback)voidDesuscribe evento

start(options)

OpciónTipoRequeridoDescripción
mode'surface'Modo de tracking
licenseKeystringLicense key de World

Eventos

EventoPayloadDescripción
surfacefound{ pose }Superficie detectada
surfacelostobjectSuperficie perdida
select{ nativeEvent }Tap/select en AR
sessionstart{ platform, ...payload }Sesión iniciada
sessionend{ platform, ...payload }Sesión terminada
trackingstartundefinedTracking activo
trackingpauseundefinedTracking pausado
licensedobjectLicencia validada
errorErrorError