aframe
Version:
A web framework for building virtual reality experiences.
181 lines (156 loc) • 7.81 kB
JavaScript
import debug from './debug.js';
var error = debug('device:error');
var supportsVRSession = false;
var supportsARSession = false;
export var isWebXRAvailable = navigator.xr !== undefined;
// Support both WebVR and WebXR APIs.
if (isWebXRAvailable) {
var updateEnterInterfaces = function () {
var sceneEl = document.querySelector('a-scene');
if (!sceneEl) {
window.addEventListener('DOMContentLoaded', updateEnterInterfaces);
return;
}
if (sceneEl.hasLoaded) {
sceneEl.components['xr-mode-ui'].updateEnterInterfaces();
} else {
sceneEl.addEventListener('loaded', updateEnterInterfaces);
}
};
var errorHandler = function (err) {
error('WebXR session support error: ' + err.message);
};
if (navigator.xr.isSessionSupported) {
// Current WebXR spec uses a boolean-returning isSessionSupported promise
navigator.xr.isSessionSupported('immersive-vr').then(function (supported) {
supportsVRSession = supported;
updateEnterInterfaces();
}).catch(errorHandler);
navigator.xr.isSessionSupported('immersive-ar').then(function (supported) {
supportsARSession = supported;
updateEnterInterfaces();
}).catch(function () {});
} else if (navigator.xr.supportsSession) {
// Fallback for implementations that haven't updated to the new spec yet,
// the old version used supportsSession which is rejected for missing
// support.
navigator.xr.supportsSession('immersive-vr').then(function () {
supportsVRSession = true;
updateEnterInterfaces();
}).catch(errorHandler);
navigator.xr.supportsSession('immersive-ar').then(function () {
supportsARSession = true;
updateEnterInterfaces();
}).catch(function () {});
} else {
error('WebXR has neither isSessionSupported or supportsSession?!');
}
}
/**
* Determine if a headset is connected.
*/
export function checkHeadsetConnected () {
return supportsVRSession || supportsARSession;
}
export function checkARSupport () { return supportsARSession; }
export function checkVRSupport () { return supportsVRSession; }
/**
* Checks if browser is mobile and not stand-alone dedicated vr device.
* @returns {boolean} True if mobile browser detected.
*/
export var isMobile = (function () {
var _isMobile = false;
(function (a) {
// eslint-disable-next-line no-useless-escape
if (/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(a) || /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0, 4))) {
_isMobile = true;
}
if (isIOS() || isTablet() || isR7()) {
_isMobile = true;
}
if (isMobileVR()) {
_isMobile = false;
}
})(window.navigator.userAgent || window.navigator.vendor || window.opera);
return function () { return _isMobile; };
})();
/**
* Detect tablet devices.
* @param {string} mockUserAgent - Allow passing a mock user agent for testing.
*/
export function isTablet (mockUserAgent) {
var userAgent = mockUserAgent || window.navigator.userAgent;
var isTablet = /Nexus (7|9)|xoom|sch-i800|playbook|tablet|kindle/i.test(userAgent);
// Additional check for iPad or MacIntel with touch capabilities and not an MSStream device
return isTablet || isIpad();
}
/**
* Detect ipad devices.
* @param {string} mockUserAgent - Allow passing a mock user agent for testing.
* @param {string} mockDevicePlatform - Allow passing a mock device platform for testing.
* @param {string} mockDeviceTouchPoints - Allow passing a mock device touch points for testing.
*/
export function isIpad (mockUserAgent, mockDevicePlatform, mockDeviceTouchPoints) {
var userAgent = mockUserAgent || window.navigator.userAgent;
var platform = mockDevicePlatform || window.navigator.platform;
var maxTouchPoints = mockDeviceTouchPoints || window.navigator.maxTouchPoints || 0;
return ((platform === 'iPad' || platform === 'MacIntel') && maxTouchPoints > 0 && /Macintosh|Intel|iPad|ipad/i.test(userAgent) && !window.MSStream);
}
/**
* Detect Apple Vision Pro devices.
*/
export function isAppleVisionPro () {
// Safari for Apple Vision Pro presents itself as a desktop browser.
var isMacintosh = navigator.userAgent.includes('Macintosh');
// Discriminates between a "real" desktop browser and Safari for Vision Pro.
var hasFiveTouchPoints = navigator.maxTouchPoints === 5;
// isWebXRAvailable discriminates between Vision Pro and iPad / iPhone.
// This will no longer work once WebXR ships in iOS / iPad OS.
return isMacintosh && hasFiveTouchPoints && isWebXRAvailable;
}
export function isIOS () {
return /iPad|iPhone|iPod/.test(window.navigator.platform);
}
export function isMobileDeviceRequestingDesktopSite () {
return !isMobile() && !isMobileVR() && window.orientation !== undefined;
}
/**
* Detect Oculus Browser (standalone headset)
*/
export function isOculusBrowser () {
return /(OculusBrowser)/i.test(window.navigator.userAgent);
}
/**
* Detect Firefox Reality (standalone headset)
*/
export function isFirefoxReality () {
return /(Mobile VR)/i.test(window.navigator.userAgent);
}
/**
* Detect browsers in Stand-Alone headsets
*/
export function isMobileVR () {
return isOculusBrowser() || isFirefoxReality() || isAppleVisionPro();
}
export function isR7 () {
return /R7 Build/.test(window.navigator.userAgent);
}
/**
* Checks mobile device orientation.
* @returns {boolean} True if landscape orientation.
*/
export function isLandscape () {
var orientation = window.orientation;
if (isR7()) { orientation += 90; }
return orientation === 90 || orientation === -90;
}
/**
* Check if running in a browser or spoofed browser (bundler).
* We need to check a node api that isn't mocked on either side.
* `require` and `module.exports` are mocked in browser by bundlers.
*/
export var isBrowserEnvironment = typeof process === 'undefined';
/**
* Check if running in node on the server.
*/
export var isNodeEnvironment = !isBrowserEnvironment;