ThreeAdapter

Integration adapter for Three.js.

Constructor

import { ThreeAdapter } from './adapters/three.js'

const adapter = new ThreeAdapter({
  scene,            // THREE.Scene
  camera,           // THREE.PerspectiveCamera
  renderer,         // THREE.WebGLRenderer
  showVideo: true   // Show camera feed as background (default: true)
})

Parameter	Type	Required	Description
scene	THREE.Scene	Yes	Three.js scene
camera	THREE.PerspectiveCamera	Yes	Camera
renderer	THREE.WebGLRenderer	Yes	Renderer
showVideo	boolean	No	Show camera video as background (default: true)

Methods

attach(tracker)

Connects the adapter to the tracker.

adapter.attach(tracker)

addARContent(targetId, object3D, options)

Adds 3D content associated with a target.

adapter.addARContent('myMarker', cube, { scale: 1, flipX: false })

Parameter	Type	Description
targetId	string	Target ID
object3D	THREE.Object3D	Any Three.js 3D object
options.scale	number	Scale multiplier (default: 1)
options.flipX	boolean	Flip horizontally (default: false)

setup()

Configures the video background and the camera. Call after tracker.start().

await tracker.start()
adapter.setup()

startRenderLoop()

Starts an automatic render loop. Optional if you prefer to handle rendering manually.

adapter.startRenderLoop()