Skip to content

[look-controls] Support Pointer Lock API. #3341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 20, 2018
Merged

[look-controls] Support Pointer Lock API. #3341

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50d627e
[look-controls] Support Pointer Lock API.
donmccurdy Jan 17, 2018
a4a3734
[look-controls] Document pointerLockEnabled.
donmccurdy Jan 20, 2018
da3035f
[look-controls] Test pointerLockEnabled.
donmccurdy Jan 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 53 additions & 6 deletions src/components/look-controls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ module.exports.Component = registerComponent('look-controls', {
enabled: {default: true},
touchEnabled: {default: true},
hmdEnabled: {default: true},
pointerLockEnabled: {default: true},
reverseMouseDrag: {default: false},
userHeight: {default: 1.6}
},
Expand All @@ -38,6 +39,7 @@ module.exports.Component = registerComponent('look-controls', {
this.rotation = {};
this.deltaRotation = {};
this.savedPose = null;
this.pointerLocked = false;
this.setupMouseControls();
this.bindMethods();

Expand All @@ -61,6 +63,12 @@ module.exports.Component = registerComponent('look-controls', {
this.pitchObject.rotation.set(0, 0, 0);
this.yawObject.rotation.set(0, 0, 0);
}

if (oldData && !data.pointerLockEnabled !== oldData.pointerLockEnabled) {
this.removeEventListeners();
this.addEventListeners();
if (this.pointerLocked) { document.exitPointerLock(); }
}
},

tick: function (t) {
Expand Down Expand Up @@ -91,6 +99,8 @@ module.exports.Component = registerComponent('look-controls', {
this.onTouchEnd = bind(this.onTouchEnd, this);
this.onEnterVR = bind(this.onEnterVR, this);
this.onExitVR = bind(this.onExitVR, this);
this.onPointerLockChange = bind(this.onPointerLockChange, this);
this.onPointerLockError = bind(this.onPointerLockError, this);
},

/**
Expand Down Expand Up @@ -130,6 +140,13 @@ module.exports.Component = registerComponent('look-controls', {
// sceneEl events.
sceneEl.addEventListener('enter-vr', this.onEnterVR);
sceneEl.addEventListener('exit-vr', this.onExitVR);

// Pointer Lock events.
if (this.data.pointerLockEnabled) {
document.addEventListener('pointerlockchange', this.onPointerLockChange, false);
document.addEventListener('mozpointerlockchange', this.onPointerLockChange, false);
document.addEventListener('pointerlockerror', this.onPointerLockError, false);
}
},

/**
Expand All @@ -143,18 +160,22 @@ module.exports.Component = registerComponent('look-controls', {

// Mouse events.
canvasEl.removeEventListener('mousedown', this.onMouseDown);
canvasEl.removeEventListener('mousemove', this.onMouseMove);
canvasEl.removeEventListener('mouseup', this.onMouseUp);
canvasEl.removeEventListener('mouseout', this.onMouseUp);
window.removeEventListener('mousemove', this.onMouseMove);
window.removeEventListener('mouseup', this.onMouseUp);

// Touch events.
canvasEl.removeEventListener('touchstart', this.onTouchStart);
canvasEl.removeEventListener('touchmove', this.onTouchMove);
canvasEl.removeEventListener('touchend', this.onTouchEnd);
window.removeEventListener('touchmove', this.onTouchMove);
window.removeEventListener('touchend', this.onTouchEnd);

// sceneEl events.
sceneEl.removeEventListener('enter-vr', this.onEnterVR);
sceneEl.removeEventListener('exit-vr', this.onExitVR);

// Pointer Lock events.
document.removeEventListener('pointerlockchange', this.onPointerLockChange, false);
document.removeEventListener('mozpointerlockchange', this.onPointerLockChange, false);
document.removeEventListener('pointerlockerror', this.onPointerLockError, false);
},

/**
Expand Down Expand Up @@ -242,7 +263,7 @@ module.exports.Component = registerComponent('look-controls', {
var movementY;

// Not dragging or not enabled.
if (!this.mouseDown || !this.data.enabled) { return; }
if (!this.data.enabled || (!this.mouseDown && !this.pointerLocked)) { return; }

// Calculate delta.
movementX = event.movementX || event.mozMovementX;
Expand All @@ -266,9 +287,21 @@ module.exports.Component = registerComponent('look-controls', {
if (!this.data.enabled) { return; }
// Handle only primary button.
if (evt.button !== 0) { return; }

var sceneEl = this.el.sceneEl;
var canvasEl = sceneEl && sceneEl.canvas;

this.mouseDown = true;
this.previousMouseEvent = evt;
document.body.classList.add(GRABBING_CLASS);

if (this.data.pointerLockEnabled && !this.pointerLocked) {
if (canvasEl.requestPointerLock) {
canvasEl.requestPointerLock();
} else if (canvasEl.mozRequestPointerLock) {
canvasEl.mozRequestPointerLock();
}
}
},

/**
Expand Down Expand Up @@ -334,6 +367,20 @@ module.exports.Component = registerComponent('look-controls', {
this.previousHMDPosition.set(0, 0, 0);
},

/**
* Update Pointer Lock state.
*/
onPointerLockChange: function () {
this.pointerLocked = !!(document.pointerLockElement || document.mozPointerLockElement);
},

/**
* Recover from Pointer Lock error.
*/
onPointerLockError: function () {
this.pointerLocked = false;
},

/**
* Toggle the feature of showing/hiding the grab cursor.
*/
Expand Down