1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
<!doctype html>
<!--
Copyright 2018 The Immersive Web Community Group
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-->
<html>
<head>
<meta charset='utf-8'>
<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no'>
<meta name='mobile-web-app-capable' content='yes'>
<meta name='apple-mobile-web-app-capable' content='yes'>
<!-- Origin Trial Token, feature = WebXR Device API (For Chrome M76+), origin = storage.googleapis.com, expires = 2019-07-24 -->
<meta http-equiv="origin-trial" data-feature="WebXR Device API (For Chrome M76+)" data-expires="2019-07-24" content="Ap6io/uhkGK7vXCD+golNnQfj8wJ4so790EzZoqb8YOljMXIBTvBEQFPTHYIz5d/BgtuwZTKOLrmHAOt30f38g8AAABxeyJvcmlnaW4iOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb206NDQzIiwiZmVhdHVyZSI6IldlYlhSRGV2aWNlTTc2IiwiZXhwaXJ5IjoxNTY0MDA5MzU2LCJpc1N1YmRvbWFpbiI6dHJ1ZX0=">
<title>Teleportation</title>
<link href='css/common.css' rel='stylesheet'></link>
<!--The polyfill is not needed for browser that have native API support,
but is linked by these samples for wider compatibility.-->
<!--script src='https://cdn.jsdelivr.net/npm/webxr-polyfill@latest/build/webxr-polyfill.js'></script-->
<script src='js/xrray-polyfill.js' type='module'></script>
<script src='js/webxr-polyfill.js'></script>
<script src='js/webxr-button.js'></script>
</head>
<body>
<header>
<details open>
<summary>Teleportation</summary>
<p>
This sample demonstrates teleporting the viewer by updating the
XRSession reference space. Select a point on the floor with a
controller to teleport to it. Select the leftmost box to rotate to the
left by 30 degrees. Selecting the rightmost box rotates the viewer by
30 degress to the right. Select the middle box to reset the
viewer orientation.
<a class="back" href="./index.html">Back</a>
</p>
</details>
</header>
<script type="module">
import {Scene} from './js/cottontail/src/scenes/scene.js';
import {Renderer, createWebGLContext} from './js/cottontail/src/core/renderer.js';
import {Gltf2Node} from './js/cottontail/src/nodes/gltf2.js';
import {QueryArgs} from './js/cottontail/src/util/query-args.js';
import {FallbackHelper} from './js/cottontail/src/util/fallback-helper.js';
import {Node} from './js/cottontail/src/core/node.js';
import {PbrMaterial} from './js/cottontail/src/materials/pbr.js';
import {BoxBuilder} from './js/cottontail/src/geometry/box-builder.js';
import {mat4, vec3, quat} from './js/cottontail/src/math/gl-matrix.js';
import {BoundsRenderer} from './js/cottontail/src/nodes/bounds-renderer.js';
// If requested, initialize the WebXR polyfill
if (QueryArgs.getBool('allowPolyfill', false)) {
var polyfill = new WebXRPolyfill();
}
// If requested, don't display the frame rate info.
let hideStats = QueryArgs.getBool('hideStats', false);
// XR globals. Several additional reference spaces are required because of
// how the teleportation mechanic in onSelect works.
let xrButton = null;
let xrImmersiveRefSpaceBase = null;
let xrImmersiveRefSpaceOffset = null;
let xrNonImmersiveRefSpaceBase = null;
let xrNonImmersiveRefSpaceOffset = null;
let xrViewerSpaces = {};
let trackingSpaceOriginInWorldSpace = vec3.create();
let trackingSpaceHeadingDegrees = 0; // around +Y axis, positive angles rotate left
let floorSize = 10;
let floorPosition = [0, -floorSize / 2 + 0.01, 0];
let floorNode = null;
// WebGL scene globals.
let gl = null;
let renderer = null;
let scene = new Scene();
let boundsRenderer = null;
if (hideStats) {
scene.enableStats(false);
}
scene.addNode(new Gltf2Node({url: '../media/gltf/cube-room/cube-room.gltf'}));
scene.standingStats(true);
let boxes = [];
function initXR() {
xrButton = new XRDeviceButton({
onRequestSession: onRequestSession,
onEndSession: onEndSession,
supportedSessionTypes: ['immersive-vr']
});
xrButton.addToHeader();
if (navigator.xr) {
requestInlineSession()
.then((session) => {
gl.canvas.addEventListener('touchend', () => {
session.end().then(() => {
requestInlineSession({ optionalFeatures: ['local-floor'] });
}, { once: true });
})
});
} else {
// Still render the initial scene if WebXR is not available.
initFallback();
}
}
function initFallback() {
initGL();
let fallbackHelper = new FallbackHelper(scene, gl);
fallbackHelper.emulateStage = true;
}
function addBox(x, y, z, r, g, b, box_list) {
let boxBuilder = new BoxBuilder();
boxBuilder.pushCube([0, 0, 0], 0.4);
let boxPrimitive = boxBuilder.finishPrimitive(renderer);
let boxMaterial = new PbrMaterial();
boxMaterial.baseColorFactor.value = [r, g, b, 1.0];
let boxRenderPrimitive = renderer.createRenderPrimitive(boxPrimitive, boxMaterial);
let boxNode = new Node();
boxNode.addRenderPrimitive(boxRenderPrimitive);
// Marks the node as one that needs to be checked when hit testing.
boxNode.selectable = true;
box_list.push({
node: boxNode,
renderPrimitive: boxRenderPrimitive,
position: [x, y, z]
});
scene.addNode(boxNode);
}
function addFloorBox() {
let boxBuilder = new BoxBuilder();
boxBuilder.pushCube([0, 0, 0], floorSize);
let boxPrimitive = boxBuilder.finishPrimitive(renderer);
let boxMaterial = new PbrMaterial();
boxMaterial.baseColorFactor.value = [0.3, 0.3, 0.3, 1.0];
let boxRenderPrimitive = renderer.createRenderPrimitive(boxPrimitive, boxMaterial);
floorNode = new Node();
floorNode.addRenderPrimitive(boxRenderPrimitive);
floorNode.selectable = true;
scene.addNode(floorNode);
mat4.identity(floorNode.matrix);
mat4.translate(floorNode.matrix, floorNode.matrix, floorPosition);
}
function initGL() {
if (gl)
return;
gl = createWebGLContext({
xrCompatible: true
});
document.body.appendChild(gl.canvas);
function onResize () {
gl.canvas.width = (gl.canvas.offsetWidth * window.devicePixelRatio);
gl.canvas.height = (gl.canvas.offsetHeight * window.devicePixelRatio);
}
window.addEventListener('resize', onResize);
onResize();
renderer = new Renderer(gl);
scene.setRenderer(renderer);
scene.inputRenderer.setControllerMesh(new Gltf2Node({url: '../media/gltf/controller/controller.gltf'}));
// Create several boxes to use for hit testing.
addBox(-1.0, 1.6, -1.3, 1.0, 0.0, 0.0, boxes);
addBox(0.0, 1.7, -1.5, 0.0, 1.0, 0.0, boxes);
addBox(1.0, 1.6, -1.3, 0.0, 0.0, 1.0, boxes);
// Represent the floor as a box so that we can perform a hit test
// against it onSelect so that we can teleport the user to that
// particular location.
addFloorBox();
}
function onRequestSession() {
const mode = 'immersive-vr';
navigator.xr.requestSession(mode, {requiredFeatures: ['local-floor']})
.then((session) => {
session.mode = mode;
xrButton.setSession(session);
onSessionStarted(session);
});
}
function requestInlineSession(options) {
return navigator.xr.requestSession('inline', options)
.then((session) => {
session.mode = 'inline';
return onSessionStarted(session);
});
}
function onSessionStarted(session) {
session.addEventListener('end', onSessionEnded);
// By listening for the 'select' event we can find out when the user has
// performed some sort of primary input action and respond to it.
session.addEventListener('select', onSelect);
initGL();
session.updateRenderState({
baseLayer: new XRWebGLLayer(session, gl)
});
session.requestReferenceSpace('local-floor').then((refSpace) => {
console.log("created local-floor reference space for " + session.mode + " session");
return refSpace;
}, (e) => {
if (!session.mode.startsWith('immersive')) {
// If we're in inline mode, our underlying platform may not support
// the local-floor reference space, but a viewer space is guaranteed.
console.log("falling back to viewer reference space for " + session.mode + "session");
return session.requestReferenceSpace('viewer').then((viewerRefSpace) => {
// Adjust the viewer space for an estimated user height. Otherwise,
// the poses queried with this space will originate from the floor.
let xform = new XRRigidTransform({x: 0, y: -1.5, z: 0});
return viewerRefSpace.getOffsetReferenceSpace(xform);
});
} else {
throw e;
}
}).then((refSpace) => {
// Save the session-specific base reference space, and apply the current
// player orientation/position as originOffset. This reference space
// won't change for the duration of the session and is used when
// updating the player position and/or orientation in onSelect.
setRefSpace(session, refSpace, false);
updateOriginOffset(session);
session.requestReferenceSpace('viewer').then(function(viewerSpace){
// Save a separate reference space that represents the tracking space
// origin, which does not change for the duration of the session.
// This is used when updating the player position and/or orientation
// in onSelect.
xrViewerSpaces[session.mode] = viewerSpace;
session.requestAnimationFrame(onXRFrame);
});
});
return session;
}
// Used for updating the origin offset.
let playerInWorldSpaceOld = vec3.create();
let playerInWorldSpaceNew = vec3.create();
let playerOffsetInWorldSpaceOld = vec3.create();
let playerOffsetInWorldSpaceNew = vec3.create();
let rotationDeltaQuat = quat.create();
let invPosition = vec3.create();
let invOrientation = quat.create();
// If the user selected a point on the floor, teleport them to that
// position while keeping their orientation the same.
// Otherwise, check if one of the boxes was selected and update the
// user's orientation accordingly:
// left box: turn left by 30 degress
// center box: reset orientation
// right box: turn right by 30 degrees
function onSelect(ev) {
let session = ev.frame.session;
let refSpace = getRefSpace(session, true);
let headPose = ev.frame.getPose(xrViewerSpaces[session.mode], refSpace);
if (!headPose) {
console.error("No head pose, ignoring select");
return;
}
// Get the position offset in world space from the tracking space origin
// to the player's feet. The headPose position is the head position in world space.
// Subtract the tracking space origin position in world space to get a relative world space vector.
vec3.set(playerInWorldSpaceOld, headPose.transform.position.x, 0, headPose.transform.position.z);
vec3.sub(
playerOffsetInWorldSpaceOld,
playerInWorldSpaceOld,
trackingSpaceOriginInWorldSpace);
// based on https://github.com/immersive-web/webxr/blob/master/input-explainer.md#targeting-ray-pose
let inputSourcePose = ev.frame.getPose(ev.inputSource.targetRaySpace, refSpace);
if (!inputSourcePose) {
console.error("No Input source pose, ignoring select");
return;
}
vec3.copy(playerInWorldSpaceNew, playerInWorldSpaceOld);
let rotationDelta = 0;
// Hit test results can change teleport position and orientation.
let targetRay = new XRRay(inputSourcePose.transform);
let hitResult = scene.hitTest(targetRay)
if (hitResult) {
// Check to see if the hit result was one of our boxes.
for (let i = 0; i < boxes.length; ++i) {
let box = boxes[i];
if (hitResult.node == box.node) {
// Change the box color to something random.
let uniforms = box.renderPrimitive.uniforms;
uniforms.baseColorFactor.value = [Math.random(), Math.random(), Math.random(), 1.0];
if (i == 0) {
// turn left
rotationDelta = 30;
} else if (i == 1) {
// reset heading by undoing the current rotation
rotationDelta = -trackingSpaceHeadingDegrees;
} else if (i == 2) {
// turn right
rotationDelta = -30;
}
console.log('rotate by', rotationDelta);
}
}
if (hitResult.node == floorNode) {
// New position uses x/z values of the hit test result, keeping y at 0 (floor level)
playerInWorldSpaceNew[0] = hitResult.intersection[0];
playerInWorldSpaceNew[1] = 0;
playerInWorldSpaceNew[2] = hitResult.intersection[2];
console.log('teleport to', playerInWorldSpaceNew);
} else {
console.error("No hit");
}
}
// Get the new world space offset vector from tracking space origin
// to the player's feet, for the updated tracking space rotation.
// Formally, this is the old world-space player offset transformed
// into tracking space using the old originOffset's rotation component,
// then transformed back into world space using the inverse of the
// new originOffset. This simplifies to a rotation of the old player
// offset by (new angle - old angle):
// worldOffsetNew = inv(rot_of(originoffsetNew)) * rot_of(originoffsetOld) * worldOffsetOld
// = inv(rotY(-angleNew)) * rotY(-angleOld) * worldOffsetOld
// = rotY(angleNew) * rotY(-angleOld) * worldOffsetOld
// = rotY(angleNew - angleOld) * worldOffsetOld
quat.identity(rotationDeltaQuat);
quat.rotateY(rotationDeltaQuat, rotationDeltaQuat, rotationDelta * Math.PI / 180);
vec3.transformQuat(playerOffsetInWorldSpaceNew, playerOffsetInWorldSpaceOld, rotationDeltaQuat);
trackingSpaceHeadingDegrees += rotationDelta;
// Update tracking space origin so that origin + playerOffset == player location in world space
vec3.sub(
trackingSpaceOriginInWorldSpace,
playerInWorldSpaceNew,
playerOffsetInWorldSpaceNew);
updateOriginOffset(session);
}
function updateOriginOffset(session) {
// Compute the origin offset based on player position/orientation.
quat.identity(invOrientation);
quat.rotateY(invOrientation, invOrientation, -trackingSpaceHeadingDegrees * Math.PI / 180);
vec3.negate(invPosition, trackingSpaceOriginInWorldSpace);
vec3.transformQuat(invPosition, invPosition, invOrientation);
let xform = new XRRigidTransform(
{x: invPosition[0], y: invPosition[1], z: invPosition[2]},
{x: invOrientation[0], y: invOrientation[1], z: invOrientation[2], w: invOrientation[3]});
// Update offset reference to use a new originOffset with the teleported
// player position and orientation.
// This new offset needs to be applied to the base ref space.
let refSpace = getRefSpace(session, false).getOffsetReferenceSpace(xform);
setRefSpace(session, refSpace, true);
console.log('teleport to', trackingSpaceOriginInWorldSpace);
}
function onEndSession(session) {
session.end();
}
function onSessionEnded(event) {
if (event.session.mode.startsWith('immersive')) {
xrButton.setSession(null);
}
}
function getRefSpace(session, isOffset) {
return session.mode.startsWith('immersive') ?
(isOffset ? xrImmersiveRefSpaceOffset : xrImmersiveRefSpaceBase) :
(isOffset ? xrNonImmersiveRefSpaceOffset : xrNonImmersiveRefSpaceBase);
}
function setRefSpace(session, refSpace, isOffset) {
if (session.mode.startsWith('immersive')) {
if (isOffset) {
xrImmersiveRefSpaceOffset = refSpace;
} else {
xrImmersiveRefSpaceBase = refSpace;
}
} else {
if (isOffset) {
xrNonImmersiveRefSpaceOffset = refSpace;
} else {
xrNonImmersiveRefSpaceBase = refSpace;
}
}
}
function onXRFrame(time, frame) {
let session = frame.session;
let refSpace = getRefSpace(session, true);
let pose = frame.getViewerPose(refSpace);
scene.startFrame();
session.requestAnimationFrame(onXRFrame);
// Update the matrix for each box
// Only do this when the position is not emulated - this means one can
// tell if the viewer pose has an emulated position while still in VR.
if (!pose.emulatedPosition) {
for (let box of boxes) {
let node = box.node;
mat4.identity(node.matrix);
mat4.translate(node.matrix, node.matrix, box.position);
mat4.rotateX(node.matrix, node.matrix, time/1000);
mat4.rotateY(node.matrix, node.matrix, time/1500);
}
}
scene.updateInputSources(frame, refSpace);
scene.drawXRFrame(frame, pose);
scene.endFrame();
}
// Start the XR application.
initXR();
</script>
</body>
</html>
|
