Skip to content

Image ThreeAdapter

Import

js
import { ThreeAdapter } from 'monolook/image/three'

Constructor

js
const adapter = new ThreeAdapter({
  scene,
  camera,
  renderer,
  showVideo: true,
  container: document.body
})
OptionTypeRequiredDefault
sceneTHREE.SceneYes-
cameraTHREE.CameraYes-
rendererTHREE.WebGLRendererYes-
showVideobooleanNotrue
containerHTMLElementNodocument.body

Methods

MethodReturnsDescription
attach(tracker)voidConnects to MonolookImage
detach()voidRemoves listeners
addARContent(targetId, object, options?)voidMaps 3D object to target
removeARContent(targetId)voidRemoves AR content
setupVideoBackground()voidCreates video background
setup()voidConfigures background and camera after tracker.start()
startRenderLoop()voidStarts internal loop
stopRenderLoop()voidStops internal loop
destroy()voidCleanup

addARContent options

OptionTypeDefault
scalenumber1
flipXbooleanfalse