VREffect.js 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. /**
  2. * @author dmarcos / https://github.com/dmarcos
  3. * @author mrdoob / http://mrdoob.com
  4. *
  5. * WebVR Spec: http://mozvr.github.io/webvr-spec/webvr.html
  6. *
  7. * Firefox: http://mozvr.com/downloads/
  8. * Chromium: https://drive.google.com/folderview?id=0BzudLt22BqGRbW9WTHMtOWMzNjQ&usp=sharing#list
  9. *
  10. */
  11. THREE.VREffect = function ( renderer, onError ) {
  12. var vrHMD;
  13. var isDeprecatedAPI = false;
  14. var eyeTranslationL = new THREE.Vector3();
  15. var eyeTranslationR = new THREE.Vector3();
  16. var renderRectL, renderRectR;
  17. var eyeFOVL, eyeFOVR;
  18. function gotVRDevices( devices ) {
  19. for ( var i = 0; i < devices.length; i ++ ) {
  20. if ( 'VRDisplay' in window && devices[ i ] instanceof VRDisplay ) {
  21. vrHMD = devices[ i ];
  22. isDeprecatedAPI = false;
  23. break; // We keep the first we encounter
  24. } else if ( 'HMDVRDevice' in window && devices[ i ] instanceof HMDVRDevice ) {
  25. vrHMD = devices[ i ];
  26. isDeprecatedAPI = true;
  27. break; // We keep the first we encounter
  28. }
  29. }
  30. if ( vrHMD === undefined ) {
  31. if ( onError ) onError( 'HMD not available' );
  32. }
  33. }
  34. if ( navigator.getVRDisplays ) {
  35. navigator.getVRDisplays().then( gotVRDevices );
  36. } else if ( navigator.getVRDevices ) {
  37. // Deprecated API.
  38. navigator.getVRDevices().then( gotVRDevices );
  39. }
  40. //
  41. this.isPresenting = false;
  42. this.scale = 1;
  43. var scope = this;
  44. var rendererSize = renderer.getSize();
  45. var rendererPixelRatio = renderer.getPixelRatio();
  46. this.setSize = function ( width, height ) {
  47. rendererSize = { width: width, height: height };
  48. if ( scope.isPresenting ) {
  49. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  50. renderer.setPixelRatio( 1 );
  51. if ( isDeprecatedAPI ) {
  52. renderer.setSize( eyeParamsL.renderRect.width * 2, eyeParamsL.renderRect.height, false );
  53. } else {
  54. renderer.setSize( eyeParamsL.renderWidth * 2, eyeParamsL.renderHeight, false );
  55. }
  56. } else {
  57. renderer.setPixelRatio( rendererPixelRatio );
  58. renderer.setSize( width, height );
  59. }
  60. };
  61. // fullscreen
  62. var canvas = renderer.domElement;
  63. var requestFullscreen;
  64. var exitFullscreen;
  65. var fullscreenElement;
  66. function onFullscreenChange () {
  67. var wasPresenting = scope.isPresenting;
  68. scope.isPresenting = vrHMD !== undefined && ( vrHMD.isPresenting || ( isDeprecatedAPI && document[ fullscreenElement ] instanceof window.HTMLElement ) );
  69. if ( wasPresenting === scope.isPresenting ) {
  70. return;
  71. }
  72. if ( scope.isPresenting ) {
  73. rendererPixelRatio = renderer.getPixelRatio();
  74. rendererSize = renderer.getSize();
  75. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  76. var eyeWidth, eyeHeight;
  77. if ( isDeprecatedAPI ) {
  78. eyeWidth = eyeParamsL.renderRect.width;
  79. eyeHeight = eyeParamsL.renderRect.height;
  80. } else {
  81. eyeWidth = eyeParamsL.renderWidth;
  82. eyeHeight = eyeParamsL.renderHeight;
  83. }
  84. renderer.setPixelRatio( 1 );
  85. renderer.setSize( eyeWidth * 2, eyeHeight, false );
  86. } else {
  87. renderer.setPixelRatio( rendererPixelRatio );
  88. renderer.setSize( rendererSize.width, rendererSize.height );
  89. }
  90. }
  91. if ( canvas.requestFullscreen ) {
  92. requestFullscreen = 'requestFullscreen';
  93. fullscreenElement = 'fullscreenElement';
  94. exitFullscreen = 'exitFullscreen';
  95. document.addEventListener( 'fullscreenchange', onFullscreenChange, false );
  96. } else if ( canvas.mozRequestFullScreen ) {
  97. requestFullscreen = 'mozRequestFullScreen';
  98. fullscreenElement = 'mozFullScreenElement';
  99. exitFullscreen = 'mozCancelFullScreen';
  100. document.addEventListener( 'mozfullscreenchange', onFullscreenChange, false );
  101. } else {
  102. requestFullscreen = 'webkitRequestFullscreen';
  103. fullscreenElement = 'webkitFullscreenElement';
  104. exitFullscreen = 'webkitExitFullscreen';
  105. document.addEventListener( 'webkitfullscreenchange', onFullscreenChange, false );
  106. }
  107. window.addEventListener( 'vrdisplaypresentchange', onFullscreenChange, false );
  108. this.setFullScreen = function ( boolean ) {
  109. return new Promise( function ( resolve, reject ) {
  110. if ( vrHMD === undefined ) {
  111. reject( new Error( 'No VR hardware found.' ) );
  112. return;
  113. }
  114. if ( scope.isPresenting === boolean ) {
  115. resolve();
  116. return;
  117. }
  118. if ( ! isDeprecatedAPI ) {
  119. if ( boolean ) {
  120. resolve( vrHMD.requestPresent( [ { source: canvas } ] ) );
  121. } else {
  122. resolve( vrHMD.exitPresent() );
  123. }
  124. } else {
  125. if ( canvas[ requestFullscreen ] ) {
  126. canvas[ boolean ? requestFullscreen : exitFullscreen ]( { vrDisplay: vrHMD } );
  127. resolve();
  128. } else {
  129. console.error( 'No compatible requestFullscreen method found.' );
  130. reject( new Error( 'No compatible requestFullscreen method found.' ) );
  131. }
  132. }
  133. } );
  134. };
  135. this.requestPresent = function () {
  136. return this.setFullScreen( true );
  137. };
  138. this.exitPresent = function () {
  139. return this.setFullScreen( false );
  140. };
  141. // render
  142. var cameraL = new THREE.PerspectiveCamera();
  143. cameraL.layers.enable( 1 );
  144. var cameraR = new THREE.PerspectiveCamera();
  145. cameraR.layers.enable( 2 );
  146. this.render = function ( scene, camera ) {
  147. if ( vrHMD && scope.isPresenting ) {
  148. var autoUpdate = scene.autoUpdate;
  149. if ( autoUpdate ) {
  150. scene.updateMatrixWorld();
  151. scene.autoUpdate = false;
  152. }
  153. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  154. var eyeParamsR = vrHMD.getEyeParameters( 'right' );
  155. if ( ! isDeprecatedAPI ) {
  156. eyeTranslationL.fromArray( eyeParamsL.offset );
  157. eyeTranslationR.fromArray( eyeParamsR.offset );
  158. eyeFOVL = eyeParamsL.fieldOfView;
  159. eyeFOVR = eyeParamsR.fieldOfView;
  160. } else {
  161. eyeTranslationL.copy( eyeParamsL.eyeTranslation );
  162. eyeTranslationR.copy( eyeParamsR.eyeTranslation );
  163. eyeFOVL = eyeParamsL.recommendedFieldOfView;
  164. eyeFOVR = eyeParamsR.recommendedFieldOfView;
  165. }
  166. if ( Array.isArray( scene ) ) {
  167. console.warn( 'THREE.VREffect.render() no longer supports arrays. Use object.layers instead.' );
  168. scene = scene[ 0 ];
  169. }
  170. // When rendering we don't care what the recommended size is, only what the actual size
  171. // of the backbuffer is.
  172. var size = renderer.getSize();
  173. renderRectL = { x: 0, y: 0, width: size.width / 2, height: size.height };
  174. renderRectR = { x: size.width / 2, y: 0, width: size.width / 2, height: size.height };
  175. renderer.setScissorTest( true );
  176. renderer.clear();
  177. if ( camera.parent === null ) camera.updateMatrixWorld();
  178. cameraL.projectionMatrix = fovToProjection( eyeFOVL, true, camera.near, camera.far );
  179. cameraR.projectionMatrix = fovToProjection( eyeFOVR, true, camera.near, camera.far );
  180. camera.matrixWorld.decompose( cameraL.position, cameraL.quaternion, cameraL.scale );
  181. camera.matrixWorld.decompose( cameraR.position, cameraR.quaternion, cameraR.scale );
  182. var scale = this.scale;
  183. cameraL.translateOnAxis( eyeTranslationL, scale );
  184. cameraR.translateOnAxis( eyeTranslationR, scale );
  185. // render left eye
  186. renderer.setViewport( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  187. renderer.setScissor( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  188. renderer.render( scene, cameraL );
  189. // render right eye
  190. renderer.setViewport( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  191. renderer.setScissor( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  192. renderer.render( scene, cameraR );
  193. renderer.setScissorTest( false );
  194. if ( autoUpdate ) {
  195. scene.autoUpdate = true;
  196. }
  197. if ( ! isDeprecatedAPI ) {
  198. vrHMD.submitFrame();
  199. }
  200. return;
  201. }
  202. // Regular render mode if not HMD
  203. renderer.render( scene, camera );
  204. };
  205. //
  206. function fovToNDCScaleOffset( fov ) {
  207. var pxscale = 2.0 / ( fov.leftTan + fov.rightTan );
  208. var pxoffset = ( fov.leftTan - fov.rightTan ) * pxscale * 0.5;
  209. var pyscale = 2.0 / ( fov.upTan + fov.downTan );
  210. var pyoffset = ( fov.upTan - fov.downTan ) * pyscale * 0.5;
  211. return { scale: [ pxscale, pyscale ], offset: [ pxoffset, pyoffset ] };
  212. }
  213. function fovPortToProjection( fov, rightHanded, zNear, zFar ) {
  214. rightHanded = rightHanded === undefined ? true : rightHanded;
  215. zNear = zNear === undefined ? 0.01 : zNear;
  216. zFar = zFar === undefined ? 10000.0 : zFar;
  217. var handednessScale = rightHanded ? - 1.0 : 1.0;
  218. // start with an identity matrix
  219. var mobj = new THREE.Matrix4();
  220. var m = mobj.elements;
  221. // and with scale/offset info for normalized device coords
  222. var scaleAndOffset = fovToNDCScaleOffset( fov );
  223. // X result, map clip edges to [-w,+w]
  224. m[ 0 * 4 + 0 ] = scaleAndOffset.scale[ 0 ];
  225. m[ 0 * 4 + 1 ] = 0.0;
  226. m[ 0 * 4 + 2 ] = scaleAndOffset.offset[ 0 ] * handednessScale;
  227. m[ 0 * 4 + 3 ] = 0.0;
  228. // Y result, map clip edges to [-w,+w]
  229. // Y offset is negated because this proj matrix transforms from world coords with Y=up,
  230. // but the NDC scaling has Y=down (thanks D3D?)
  231. m[ 1 * 4 + 0 ] = 0.0;
  232. m[ 1 * 4 + 1 ] = scaleAndOffset.scale[ 1 ];
  233. m[ 1 * 4 + 2 ] = - scaleAndOffset.offset[ 1 ] * handednessScale;
  234. m[ 1 * 4 + 3 ] = 0.0;
  235. // Z result (up to the app)
  236. m[ 2 * 4 + 0 ] = 0.0;
  237. m[ 2 * 4 + 1 ] = 0.0;
  238. m[ 2 * 4 + 2 ] = zFar / ( zNear - zFar ) * - handednessScale;
  239. m[ 2 * 4 + 3 ] = ( zFar * zNear ) / ( zNear - zFar );
  240. // W result (= Z in)
  241. m[ 3 * 4 + 0 ] = 0.0;
  242. m[ 3 * 4 + 1 ] = 0.0;
  243. m[ 3 * 4 + 2 ] = handednessScale;
  244. m[ 3 * 4 + 3 ] = 0.0;
  245. mobj.transpose();
  246. return mobj;
  247. }
  248. function fovToProjection( fov, rightHanded, zNear, zFar ) {
  249. var DEG2RAD = Math.PI / 180.0;
  250. var fovPort = {
  251. upTan: Math.tan( fov.upDegrees * DEG2RAD ),
  252. downTan: Math.tan( fov.downDegrees * DEG2RAD ),
  253. leftTan: Math.tan( fov.leftDegrees * DEG2RAD ),
  254. rightTan: Math.tan( fov.rightDegrees * DEG2RAD )
  255. };
  256. return fovPortToProjection( fovPort, rightHanded, zNear, zFar );
  257. }
  258. };