- Docs
- Experience Library
- Place on the floor
Place on the floor World tracking
A ring shows on the floor, a tap places a cube, and it stays when you walk around. With a diagnostics panel.
Code
The code of this experience, split in the files you would keep: HTML, CSS and JavaScript. The live page keeps them in one file; copy each part into its own file and the page works the same.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
<title>World tracking (A-Frame)</title>
<!-- 1. A-Frame. 2. Tempusxr for A-Frame. 3. The world tracker. WebXR AR: Chrome on an Android phone with ARCore. -->
<script src="/node_modules/aframe/dist/aframe-v1.8.0.min.js"></script>
<script src="/packages/sdk-aframe/dist/index.umd.cjs"></script>
<script src="/packages/sdk-tracker-world/dist/index.umd.cjs"></script>
<link rel="stylesheet" href="page.css" />
</head>
<body>
<div id="diagnostics"></div>
<!--
The whole experience is this scene. tracker: world places content on the real floor, in meters.
A button "Start AR" appears (WebXR starts from a tap). Move the phone slowly until the ring shows, then tap.
anchors: "spot" is placed by a tap, "spot:auto" at the first surface found.
-->
<a-scene
tempusxr="tracker: world; anchors: spot; debug: false"
renderer="alpha: true"
gltf-model="dracoDecoderPath: /node_modules/three/examples/jsm/libs/draco/"
vr-mode-ui="enabled: false"
>
<a-camera look-controls="enabled: false" wasd-controls="enabled: false"></a-camera>
<a-light type="ambient" intensity="1.2"></a-light>
<a-light type="directional" position="0.5 1 1" intensity="1.5"></a-light>
<a-entity tempusxr-anchor="index: 0">
<a-box position="0 0.1 0" width="0.2" height="0.2" depth="0.2" color="#fecb02"></a-box>
</a-entity>
<a-entity tempusxr-reticle>
<a-ring
rotation="-90 0 0"
radius-inner="0.06"
radius-outer="0.075"
color="#ffffff"
></a-ring>
</a-entity>
</a-scene>
<script type="module" src="page.js"></script>
</body>
</html>
body {
margin: 0;
}
#diagnostics {
position: fixed;
z-index: 5;
top: 8px;
left: 8px;
padding: 8px 12px;
border-radius: 10px;
background: rgba(0, 0, 0, 0.6);
color: #fff;
font:
12px/1.4 ui-monospace,
monospace;
pointer-events: none;
}
import { startDiagnostics } from '/examples/world/diagnostics.js';
import { addTestToggle } from '/examples/test-mode.js';
import { launchIfNoAr } from '/examples/launch-ar.js';
void launchIfNoAr();
addTestToggle(document.body, { floating: true });
import { BIKE, bikeExists, fit } from '/examples/world/bike.js';
// The bicycle takes the cube's place when its file is there. Add ?cube to keep the cube.
if (!location.search.includes('cube') && (await bikeExists())) {
const anchor = document.querySelector('[tempusxr-anchor]');
const bike = document.createElement('a-entity');
bike.setAttribute('gltf-model', BIKE);
bike.addEventListener('model-loaded', () => {
fit(AFRAME.THREE, bike.getObject3D('mesh'), 1.7);
anchor.querySelector('a-box')?.remove();
});
anchor.append(bike);
}
const scene = document.querySelector('a-scene');
startDiagnostics(document.getElementById('diagnostics'), () => {
const state = scene.components.tempusxr?.state;
return state?.tracker ?? null;
});
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
<title>World tracking (Three.js)</title>
<!-- Three.js with the SDK and the world tracker. WebXR AR: Chrome on an Android phone with ARCore. -->
<script type="importmap">
{
"imports": {
"three": "/node_modules/three/build/three.module.js",
"three/addons/": "/node_modules/three/examples/jsm/",
"@tempusxr/sdk-core": "/packages/sdk-core/dist/index.js",
"@tempusxr/sdk-three": "/packages/sdk-three/dist/index.js",
"@tempusxr/sdk-tracker-world": "/packages/sdk-tracker-world/dist/index.js"
}
}
</script>
<link rel="stylesheet" href="page.css" />
</head>
<body>
<!-- Move the phone slowly until the ring shows on the floor, then tap: the cube stays where you put it. -->
<div id="ar"></div>
<div id="diagnostics"></div>
<button id="start" type="button">Start AR</button>
<script type="module" src="page.js"></script>
</body>
</html>
html,
body {
margin: 0;
height: 100%;
background: #111;
font:
14px/1.4 system-ui,
sans-serif;
color: #fff;
}
#diagnostics {
position: fixed;
z-index: 5;
top: 8px;
left: 8px;
padding: 8px 12px;
border-radius: 10px;
background: rgba(0, 0, 0, 0.6);
font:
12px/1.4 ui-monospace,
monospace;
pointer-events: none;
}
#start {
position: fixed;
z-index: 6;
left: 50%;
bottom: 12%;
transform: translateX(-50%);
padding: 14px 28px;
border: 0;
border-radius: 999px;
background: #fff;
color: #111;
font:
600 16px system-ui,
sans-serif;
}
import * as THREE from 'three';
import { create } from '@tempusxr/sdk-three';
import { WebXRProvider } from '@tempusxr/sdk-core';
import { addTestToggle } from '/examples/test-mode.js';
import { launchIfNoAr } from '/examples/launch-ar.js';
void launchIfNoAr();
import '@tempusxr/sdk-tracker-world';
import { startDiagnostics } from '/examples/world/diagnostics.js';
import { BIKE, bikeExists, fit } from '/examples/world/bike.js';
const container = document.getElementById('ar');
const ar = create({
container,
camera: new WebXRProvider({ domOverlay: container }),
});
window.__ar = ar;
addTestToggle(document.body, { floating: true });
let tracker = null;
await startDiagnostics(document.getElementById('diagnostics'), () => tracker);
tracker = await ar.use('world', { anchors: [{ id: 'spot', placement: 'tap' }] });
const lights = new THREE.Group();
lights.add(new THREE.AmbientLight(0xffffff, 1.2));
const sun = new THREE.DirectionalLight(0xffffff, 1.5);
sun.position.set(0.5, 1, 1);
lights.add(sun);
ar.scene.add(lights);
// Units are meters: a 20 cm cube that sits on the surface.
const content = new THREE.Mesh(
new THREE.BoxGeometry(0.2, 0.2, 0.2).translate(0, 0.1, 0),
new THREE.MeshStandardMaterial({ color: '#fecb02' }),
);
ar.attach(tracker.anchors[0], content);
// The bicycle takes the cube's place when its file is there. Add ?cube to keep the cube.
// It loads while the person reads the page: the Start button does not wait for it.
if (!location.search.includes('cube')) {
void (async () => {
if (!(await bikeExists())) return;
const [{ GLTFLoader }, { DRACOLoader }] = await Promise.all([
import('three/addons/loaders/GLTFLoader.js'),
import('three/addons/loaders/DRACOLoader.js'),
]);
const draco = new DRACOLoader().setDecoderPath(
'/node_modules/three/examples/jsm/libs/draco/',
);
const gltf = await new GLTFLoader().setDRACOLoader(draco).loadAsync(BIKE);
fit(THREE, gltf.scene, 1.7);
const holder = new THREE.Group();
holder.add(gltf.scene);
ar.attach(tracker.anchors[0], holder);
ar.scene.remove(content);
})().catch((error) => console.error('The bicycle could not be loaded:', error));
}
const ring = new THREE.Mesh(
new THREE.RingGeometry(0.06, 0.075, 48).rotateX(-Math.PI / 2),
new THREE.MeshBasicMaterial({ color: 0xffffff, side: THREE.DoubleSide }),
);
ar.attach(tracker.reticle, ring);
// WebXR starts from a tap.
document.getElementById('start').addEventListener('click', async (event) => {
event.currentTarget.remove();
await ar.start();
});
{
"version": 1,
"id": "world-from-a-scene",
"name": "World tracking, as a scene file: place the badge on the floor",
"tracker": {
"kind": "world",
"anchors": [{ "id": "spot", "placement": "tap" }]
},
"assets": [
{ "id": "title", "type": "text", "text": "Tempusxr", "color": "#fecb02", "size": 0.1 },
{ "id": "badge", "type": "image", "src": "../tree-frame/tree.png" }
],
"nodes": [
{ "id": "heading", "asset": "title", "anchor": "spot", "position": [0, 0.5, 0] },
{
"id": "badge-node",
"asset": "badge",
"anchor": "spot",
"position": [0, 0.2, 0],
"scale": [0.3, 0.3, 0.3]
}
],
"behaviors": []
}
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
<title>Tempusxr scene</title>
<!-- A scene file, opened the way the Viewer opens it. Open ?scene=your.json to try another one. -->
<script type="importmap">
{
"imports": {
"three": "/node_modules/three/build/three.module.js",
"three/addons/": "/node_modules/three/examples/jsm/",
"@tempusxr/scene": "/packages/scene/dist/index.js",
"@tempusxr/sdk-core": "/packages/sdk-core/dist/index.js",
"@tempusxr/sdk-three": "/packages/sdk-three/dist/index.js",
"@tempusxr/sdk-tracker-image": "/packages/sdk-tracker-image/dist/index.js",
"@tempusxr/sdk-tracker-world": "/packages/sdk-tracker-world/dist/index.js",
"@tempusxr/sdk-capture": "/packages/sdk-capture/dist/index.js",
"@tempusxr/ui": "/packages/ui/dist/index.js"
}
}
</script>
<link rel="stylesheet" href="page.css" />
</head>
<body>
<div id="ar"></div>
<div id="gate">
<div id="status">Loading...</div>
<button id="start" type="button" disabled>Start</button>
<div id="qr" hidden><span>Scan to open on your phone</span></div>
<div id="error"></div>
</div>
<script type="module" src="page.js"></script>
</body>
</html>
html,
body {
margin: 0;
height: 100%;
background: #111;
color: #fff;
font:
16px/1.5 system-ui,
sans-serif;
}
#gate {
position: fixed;
inset: 0;
z-index: 20;
display: grid;
place-content: center;
gap: 14px;
padding: 24px;
text-align: center;
background: #111;
}
#gate[hidden] {
display: none;
}
#start {
padding: 14px 32px;
border: 0;
border-radius: 999px;
background: #fecb02;
color: #1b1b1b;
font: inherit;
font-weight: 700;
}
#start:disabled {
opacity: 0.4;
}
#qr {
display: grid;
justify-items: center;
gap: 6px;
color: #a49cb1;
font-size: 14px;
}
#qr[hidden] {
display: none;
}
#qr svg {
width: 168px;
height: 168px;
border-radius: 10px;
}
#error {
color: #ff7b6b;
white-space: pre-wrap;
}
import { loadScene } from '@tempusxr/sdk-three';
import '@tempusxr/sdk-tracker-image';
import '@tempusxr/sdk-tracker-world';
import { qrSvg } from '@tempusxr/ui';
import { addTestToggle } from '/examples/test-mode.js';
import { launchOnIphone } from '/examples/launch-ar.js';
addTestToggle(document.getElementById('gate'));
const status = document.getElementById('status');
const start = document.getElementById('start');
const sceneUrl = new URLSearchParams(location.search).get('scene') || 'scene.json';
const events = (window.__events = []);
// On a computer, show the QR code of this page, so a phone can scan it from the screen.
if (matchMedia('(pointer: fine)').matches) {
const box = document.getElementById('qr');
box.insertAdjacentHTML('afterbegin', qrSvg(location.href, { ecc: 'Q' }));
box.hidden = false;
}
try {
const experience = await loadScene(sceneUrl, {
container: '#ar',
onProgress: ({ loaded, total }) => (status.textContent = `Loading ${loaded} / ${total}`),
onEvent: (event) => events.push(event),
// Models with KTX2 textures need the Basis transcoder files.
decoders: {
basisPath: '/node_modules/three/examples/jsm/libs/basis/',
dracoPath: '/node_modules/three/examples/jsm/libs/draco/',
},
// ?analytics sends opened, found, tap and time events to the dev server, which prints them.
...(new URLSearchParams(location.search).has('analytics')
? { analytics: { endpoint: '/__analytics' } }
: {}),
});
window.__experience = experience;
// ?capture adds the photo and video shutter. Videos hold the sound of the scene and of the room
// (the phone asks for the microphone the first time).
if (new URLSearchParams(location.search).has('capture')) {
const { enableCapture } = await import('@tempusxr/sdk-capture');
window.__capture = enableCapture(experience, { microphone: true });
}
status.textContent = experience.scene.meta?.title ?? 'Ready';
start.disabled = false;
// The tap is what lets the phone play sound and video later.
start.addEventListener('click', async () => {
document.getElementById('gate').hidden = true;
await experience.start();
});
} catch (error) {
// A world scene on an iPhone: Safari has no WebXR, so Variant Launch opens it in an App Clip.
if (error.code === 'unsupported' && launchOnIphone()) status.textContent = 'Opening AR...';
else status.textContent = 'This experience could not be opened.';
const lines = [`${error.code ?? 'error'}: ${error.message}`];
for (const issue of error.issues ?? []) lines.push(`${issue.code} ${issue.path}`);
document.getElementById('error').textContent = lines.join('\n');
window.__loadError = { code: error.code, file: error.file, issues: error.issues };
}