VREffect.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  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.scale = 1;
  42. var isPresenting = false;
  43. var rendererSize = renderer.getSize();
  44. var rendererPixelRatio = renderer.getPixelRatio();
  45. this.setSize = function ( width, height ) {
  46. renderSize = { width: width, height: height };
  47. if ( isPresenting ) {
  48. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  49. renderer.setPixelRatio( 1 );
  50. if ( isDeprecatedAPI ) {
  51. renderer.setSize( eyeParamsL.renderRect.width * 2, eyeParamsL.renderRect.height, false );
  52. } else {
  53. renderer.setSize( eyeParamsL.renderWidth * 2, eyeParamsL.renderHeight, false );
  54. }
  55. } else {
  56. renderer.setPixelRatio( rendererPixelRatio );
  57. renderer.setSize( width, height );
  58. }
  59. };
  60. // fullscreen
  61. var canvas = renderer.domElement;
  62. var fullscreenchange = canvas.mozRequestFullScreen ? 'mozfullscreenchange' : 'webkitfullscreenchange';
  63. document.addEventListener( fullscreenchange, function () {
  64. isPresenting = isDeprecatedAPI && vrHMD && ( document.mozFullScreenElement || document.webkitFullscreenElement ) !== undefined;
  65. if ( isPresenting ) {
  66. rendererPixelRatio = renderer.getPixelRatio();
  67. rendererSize = renderer.getSize();
  68. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  69. renderer.setPixelRatio( 1 );
  70. renderer.setSize( eyeParamsL.renderRect.width * 2, eyeParamsL.renderRect.height, false );
  71. } else {
  72. renderer.setPixelRatio( rendererPixelRatio );
  73. renderer.setSize( rendererSize.width, rendererSize.height );
  74. }
  75. }, false );
  76. window.addEventListener( 'vrdisplaypresentchange', function () {
  77. isPresenting = vrHMD && vrHMD.isPresenting;
  78. if ( isPresenting ) {
  79. rendererPixelRatio = renderer.getPixelRatio();
  80. rendererSize = renderer.getSize();
  81. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  82. renderer.setPixelRatio( 1 );
  83. renderer.setSize( eyeParamsL.renderWidth * 2, eyeParamsL.renderHeight, false );
  84. } else {
  85. renderer.setPixelRatio( rendererPixelRatio );
  86. renderer.setSize( rendererSize.width, rendererSize.height );
  87. }
  88. }, false );
  89. this.setFullScreen = function ( boolean ) {
  90. return new Promise( function ( resolve, reject ) {
  91. if ( vrHMD === undefined ) {
  92. reject( new Error( 'No VR hardware found.' ) );
  93. return;
  94. }
  95. if ( isPresenting === boolean ) {
  96. resolve();
  97. return;
  98. }
  99. if ( ! isDeprecatedAPI ) {
  100. if ( boolean ) {
  101. resolve( vrHMD.requestPresent( [ { source: canvas } ] ) );
  102. } else {
  103. resolve( vrHMD.exitPresent() );
  104. }
  105. } else {
  106. if ( canvas.mozRequestFullScreen ) {
  107. canvas.mozRequestFullScreen( { vrDisplay: vrHMD } );
  108. resolve();
  109. } else if ( canvas.webkitRequestFullscreen ) {
  110. canvas.webkitRequestFullscreen( { vrDisplay: vrHMD } );
  111. resolve();
  112. } else {
  113. console.error( 'No compatible requestFullscreen method found.' );
  114. reject( new Error( 'No compatible requestFullscreen method found.' ) );
  115. }
  116. }
  117. } );
  118. };
  119. this.requestPresent = function () {
  120. return this.setFullScreen( true );
  121. };
  122. this.exitPresent = function () {
  123. return this.setFullScreen( false );
  124. };
  125. // render
  126. var cameraL = new THREE.PerspectiveCamera();
  127. cameraL.layers.enable( 1 );
  128. var cameraR = new THREE.PerspectiveCamera();
  129. cameraR.layers.enable( 2 );
  130. this.render = function ( scene, camera ) {
  131. if ( vrHMD && isPresenting ) {
  132. var autoUpdate = scene.autoUpdate;
  133. if ( autoUpdate ) {
  134. scene.updateMatrixWorld();
  135. scene.autoUpdate = false;
  136. }
  137. var eyeParamsL = vrHMD.getEyeParameters( 'left' );
  138. var eyeParamsR = vrHMD.getEyeParameters( 'right' );
  139. if ( ! isDeprecatedAPI ) {
  140. eyeTranslationL.fromArray( eyeParamsL.offset );
  141. eyeTranslationR.fromArray( eyeParamsR.offset );
  142. eyeFOVL = eyeParamsL.fieldOfView;
  143. eyeFOVR = eyeParamsR.fieldOfView;
  144. } else {
  145. eyeTranslationL.copy( eyeParamsL.eyeTranslation );
  146. eyeTranslationR.copy( eyeParamsR.eyeTranslation );
  147. eyeFOVL = eyeParamsL.recommendedFieldOfView;
  148. eyeFOVR = eyeParamsR.recommendedFieldOfView;
  149. }
  150. if ( Array.isArray( scene ) ) {
  151. console.warn( 'THREE.VREffect.render() no longer supports arrays. Use object.layers instead.' );
  152. scene = scene[ 0 ];
  153. }
  154. // When rendering we don't care what the recommended size is, only what the actual size
  155. // of the backbuffer is.
  156. var size = renderer.getSize();
  157. renderRectL = { x: 0, y: 0, width: size.width / 2, height: size.height };
  158. renderRectR = { x: size.width / 2, y: 0, width: size.width / 2, height: size.height };
  159. renderer.setScissorTest( true );
  160. renderer.clear();
  161. if ( camera.parent === null ) camera.updateMatrixWorld();
  162. cameraL.projectionMatrix = fovToProjection( eyeFOVL, true, camera.near, camera.far );
  163. cameraR.projectionMatrix = fovToProjection( eyeFOVR, true, camera.near, camera.far );
  164. camera.matrixWorld.decompose( cameraL.position, cameraL.quaternion, cameraL.scale );
  165. camera.matrixWorld.decompose( cameraR.position, cameraR.quaternion, cameraR.scale );
  166. var scale = this.scale;
  167. cameraL.translateOnAxis( eyeTranslationL, scale );
  168. cameraR.translateOnAxis( eyeTranslationR, scale );
  169. // render left eye
  170. renderer.setViewport( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  171. renderer.setScissor( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  172. renderer.render( scene, cameraL );
  173. // render right eye
  174. renderer.setViewport( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  175. renderer.setScissor( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  176. renderer.render( scene, cameraR );
  177. renderer.setScissorTest( false );
  178. if ( autoUpdate ) {
  179. scene.autoUpdate = true;
  180. }
  181. if ( ! isDeprecatedAPI ) {
  182. vrHMD.submitFrame();
  183. }
  184. return;
  185. }
  186. // Regular render mode if not HMD
  187. renderer.render( scene, camera );
  188. };
  189. //
  190. function fovToNDCScaleOffset( fov ) {
  191. var pxscale = 2.0 / ( fov.leftTan + fov.rightTan );
  192. var pxoffset = ( fov.leftTan - fov.rightTan ) * pxscale * 0.5;
  193. var pyscale = 2.0 / ( fov.upTan + fov.downTan );
  194. var pyoffset = ( fov.upTan - fov.downTan ) * pyscale * 0.5;
  195. return { scale: [ pxscale, pyscale ], offset: [ pxoffset, pyoffset ] };
  196. }
  197. function fovPortToProjection( fov, rightHanded, zNear, zFar ) {
  198. rightHanded = rightHanded === undefined ? true : rightHanded;
  199. zNear = zNear === undefined ? 0.01 : zNear;
  200. zFar = zFar === undefined ? 10000.0 : zFar;
  201. var handednessScale = rightHanded ? - 1.0 : 1.0;
  202. // start with an identity matrix
  203. var mobj = new THREE.Matrix4();
  204. var m = mobj.elements;
  205. // and with scale/offset info for normalized device coords
  206. var scaleAndOffset = fovToNDCScaleOffset( fov );
  207. // X result, map clip edges to [-w,+w]
  208. m[ 0 * 4 + 0 ] = scaleAndOffset.scale[ 0 ];
  209. m[ 0 * 4 + 1 ] = 0.0;
  210. m[ 0 * 4 + 2 ] = scaleAndOffset.offset[ 0 ] * handednessScale;
  211. m[ 0 * 4 + 3 ] = 0.0;
  212. // Y result, map clip edges to [-w,+w]
  213. // Y offset is negated because this proj matrix transforms from world coords with Y=up,
  214. // but the NDC scaling has Y=down (thanks D3D?)
  215. m[ 1 * 4 + 0 ] = 0.0;
  216. m[ 1 * 4 + 1 ] = scaleAndOffset.scale[ 1 ];
  217. m[ 1 * 4 + 2 ] = - scaleAndOffset.offset[ 1 ] * handednessScale;
  218. m[ 1 * 4 + 3 ] = 0.0;
  219. // Z result (up to the app)
  220. m[ 2 * 4 + 0 ] = 0.0;
  221. m[ 2 * 4 + 1 ] = 0.0;
  222. m[ 2 * 4 + 2 ] = zFar / ( zNear - zFar ) * - handednessScale;
  223. m[ 2 * 4 + 3 ] = ( zFar * zNear ) / ( zNear - zFar );
  224. // W result (= Z in)
  225. m[ 3 * 4 + 0 ] = 0.0;
  226. m[ 3 * 4 + 1 ] = 0.0;
  227. m[ 3 * 4 + 2 ] = handednessScale;
  228. m[ 3 * 4 + 3 ] = 0.0;
  229. mobj.transpose();
  230. return mobj;
  231. }
  232. function fovToProjection( fov, rightHanded, zNear, zFar ) {
  233. var DEG2RAD = Math.PI / 180.0;
  234. var fovPort = {
  235. upTan: Math.tan( fov.upDegrees * DEG2RAD ),
  236. downTan: Math.tan( fov.downDegrees * DEG2RAD ),
  237. leftTan: Math.tan( fov.leftDegrees * DEG2RAD ),
  238. rightTan: Math.tan( fov.rightDegrees * DEG2RAD )
  239. };
  240. return fovPortToProjection( fovPort, rightHanded, zNear, zFar );
  241. }
  242. };