adding ar plane detection event

mrdoob · Oct 26, 2022 · dbd5ba7 · dbd5ba7
1 parent f787070
commit dbd5ba7
Show file tree

Hide file tree

Showing 4 changed files with 231 additions and 0 deletions.
diff --git a/examples/files.json b/examples/files.json
@@ -354,6 +354,7 @@
 		"webxr_ar_hittest",
 		"webxr_ar_lighting",
 		"webxr_ar_paint",
+		"webxr_ar_plane_detection",
 		"webxr_vr_ballshooter",
 		"webxr_vr_cubes",
 		"webxr_vr_dragging",

diff --git a/examples/screenshots/webxr_ar_plane_detection.jpg b/examples/screenshots/webxr_ar_plane_detection.jpg
diff --git a/examples/webxr_ar_plane_detection.html b/examples/webxr_ar_plane_detection.html
@@ -0,0 +1,155 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<title>three.js ar - plane detection</title>
+		<meta charset="utf-8">
+		<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
+		<link type="text/css" rel="stylesheet" href="main.css">
+	</head>
+	<body>
+
+		<div id="info">
+			<a href="https://threejs.org" target="_blank" rel="noopener">three.js</a> ar - plane detection<br/>(Chrome Android 81+)
+		</div>
+
+		<!-- Import maps polyfill -->
+		<!-- Remove this when import maps will be widely supported -->
+		<script async src="https://unpkg.com/[email protected]/dist/es-module-shims.js"></script>
+
+		<script type="importmap">
+			{
+				"imports": {
+					"three": "../build/three.module.js",
+					"three/addons/": "./jsm/"
+				}
+			}
+		</script>
+
+		<script type="module">
+
+			import * as THREE from 'three';
+			import { ARButton } from 'three/addons/webxr/ARButton.js';
+
+			let camera, scene, renderer;
+			let controller;
+
+			init();
+			animate();
+
+			const planesAdded = new Set();
+
+			function init() {
+
+				const container = document.createElement( 'div' );
+				document.body.appendChild( container );
+
+				scene = new THREE.Scene();
+
+				camera = new THREE.PerspectiveCamera( 70, window.innerWidth / window.innerHeight, 0.01, 20 );
+
+				const light = new THREE.HemisphereLight( 0xffffff, 0xbbbbff, 1 );
+				light.position.set( 0.5, 1, 0.25 );
+				scene.add( light );
+
+				//
+
+				renderer = new THREE.WebGLRenderer( { antialias: true, alpha: true } );
+				renderer.setPixelRatio( window.devicePixelRatio );
+				renderer.setSize( window.innerWidth, window.innerHeight );
+				renderer.xr.enabled = true;
+				container.appendChild( renderer.domElement );
+
+				//
+
+				document.body.appendChild( ARButton.createButton( renderer, {
+					requiredFeatures: ['plane-detection']
+				} ) );
+
+				//
+
+				window.addEventListener( 'resize', onWindowResize );
+
+				renderer.xr.addEventListener( 'sessionstart', function () {
+
+					camera.position.set( 0, 0, 0 );
+
+				} );
+
+				renderer.xr.addEventListener( 'planeadded', function (e) {
+					console.log("plane added")
+				});
+
+				renderer.xr.addEventListener( 'planedeleted', function (e) {
+					console.log("plane deleted")
+				});
+
+				renderer.xr.addEventListener( 'planechanged', function (e) {
+					console.log("plane changed")
+				});
+
+				renderer.xr.addEventListener( 'planesdetected', function (e) {
+					const detectedPlanes = e.data;
+					const referenceSpace = renderer.xr.getReferenceSpace();
+
+					console.log(`Detected ${detectedPlanes.size} planes`);
+
+					detectedPlanes.forEach( plane => {
+						if ( planesAdded.has( plane ) ) return;
+						planesAdded.add( plane );
+						const frame = renderer.xr.getFrame();
+						const planePose = frame.getPose( plane.planeSpace, referenceSpace );
+						const planeGeometry = new THREE.BufferGeometry();
+						const polygon = plane.polygon;
+
+						let minX = Number.MAX_SAFE_INTEGER;
+						let maxX = Number.MIN_SAFE_INTEGER;
+						let minZ = Number.MAX_SAFE_INTEGER;
+						let maxZ = Number.MIN_SAFE_INTEGER;
+
+						polygon.forEach( point => {
+							minX = Math.min( minX, point.x );
+							maxX = Math.max( maxX, point.x );
+							minZ = Math.min( minZ, point.z );
+							maxZ = Math.max( maxZ, point.z );
+						} )
+
+						const width = maxX - minX;
+						const height = maxZ - minZ;
+
+						const boxMesh = new THREE.Mesh(
+							new THREE.BoxBufferGeometry( width, 0.01, height ),
+							new THREE.MeshBasicMaterial( { color: 0xffffff * Math.random() } )
+						);
+						boxMesh.matrixAutoUpdate = false;
+						boxMesh.matrix.fromArray( planePose.transform.matrix );
+						scene.add( boxMesh );
+					} );
+				} );
+			}
+
+			function onWindowResize() {
+
+				camera.aspect = window.innerWidth / window.innerHeight;
+				camera.updateProjectionMatrix();
+
+				renderer.setSize( window.innerWidth, window.innerHeight );
+
+			}
+
+			//
+
+			function animate() {
+
+				renderer.setAnimationLoop( render );
+
+			}
+
+			function render() {
+
+				renderer.render( scene, camera );
+
+			}
+
+		</script>
+	</body>
+</html>
diff --git a/src/renderers/webxr/WebXRManager.js b/src/renderers/webxr/WebXRManager.js
@@ -43,6 +43,9 @@ class WebXRManager extends EventDispatcher {
 		const controllers = [];
 		const controllerInputSources = [];
 
+		let knownPlanes = null;
+		let knownPlaneLastChangedTimes = null;
+
 		//
 
 		const cameraL = new PerspectiveCamera();
@@ -708,6 +711,78 @@ class WebXRManager extends EventDispatcher {
 
 			if ( onAnimationFrameCallback ) onAnimationFrameCallback( time, frame );
 
+			if ( frame.detectedPlanes ) {
+
+				scope.dispatchEvent( { type: 'planesdetected', data: frame.detectedPlanes } );
+
+				if ( knownPlanes === null ) {
+
+					knownPlanes = new Set();
+
+				}
+
+				if ( knownPlaneLastChangedTimes === null ) {
+
+					knownPlaneLastChangedTimes = new Map();
+
+				}
+
+				let planesToRemove = null;
+
+				for ( const plane of knownPlanes ) {
+
+					if ( ! frame.detectedPlanes.has( plane ) ) {
+
+						if ( planesToRemove === null ) {
+
+							planesToRemove = [];
+
+						}
+
+						planesToRemove.push( plane );
+
+					}
+
+				}
+
+				if ( planesToRemove !== null ) {
+
+					for ( const plane of planesToRemove ) {
+
+						knownPlanes.delete( plane );
+						knownPlaneLastChangedTimes.delete( plane );
+						scope.dispatchEvent( { type: 'planeremoved', data: plane } );
+
+					}
+
+				}
+
+				for ( const plane of frame.detectedPlanes ) {
+
+					if ( ! knownPlanes.has( plane ) ) {
+
+						knownPlanes.add( plane );
+						knownPlaneLastChangedTimes.set( plane, frame.lastChangedTime );
+
+						scope.dispatchEvent( { type: 'planeadded', data: plane } );
+
+					} else {
+
+						const lastKnownTime = knownPlaneLastChangedTimes.get( plane );
+
+						if ( plane.lastChangedTime > lastKnownTime ) {
+
+							knownPlaneLastChangedTimes.set( plane, plane.lastChangedTime );
+							scope.dispatchEvent( { type: 'planechanged', data: plane } );
+
+						}
+
+					}
+
+				}
+
+			}
+
 			xrFrame = null;
 
 		}