VREffect.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  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://webvr.info/get-chrome
  9. */
  10. THREE.VREffect = function ( renderer, onError ) {
  11. var vrDisplay, vrDisplays;
  12. var eyeTranslationL = new THREE.Vector3();
  13. var eyeTranslationR = new THREE.Vector3();
  14. var renderRectL, renderRectR;
  15. var frameData = null;
  16. if ( 'VRFrameData' in window ) {
  17. frameData = new window.VRFrameData();
  18. }
  19. function gotVRDisplays( displays ) {
  20. vrDisplays = displays;
  21. if ( displays.length > 0 ) {
  22. vrDisplay = displays[ 0 ];
  23. } else {
  24. if ( onError ) onError( 'HMD not available' );
  25. }
  26. }
  27. if ( navigator.getVRDisplays ) {
  28. navigator.getVRDisplays().then( gotVRDisplays ).catch( function () {
  29. console.warn( 'THREE.VREffect: Unable to get VR Displays' );
  30. } );
  31. }
  32. //
  33. this.isPresenting = false;
  34. var scope = this;
  35. var rendererSize = renderer.getSize();
  36. var rendererUpdateStyle = false;
  37. var rendererPixelRatio = renderer.getPixelRatio();
  38. this.getVRDisplay = function () {
  39. return vrDisplay;
  40. };
  41. this.setVRDisplay = function ( value ) {
  42. vrDisplay = value;
  43. };
  44. this.getVRDisplays = function () {
  45. console.warn( 'THREE.VREffect: getVRDisplays() is being deprecated.' );
  46. return vrDisplays;
  47. };
  48. this.setSize = function ( width, height, updateStyle ) {
  49. rendererSize = { width: width, height: height };
  50. rendererUpdateStyle = updateStyle;
  51. if ( scope.isPresenting ) {
  52. var eyeParamsL = vrDisplay.getEyeParameters( 'left' );
  53. renderer.setPixelRatio( 1 );
  54. renderer.setSize( eyeParamsL.renderWidth * 2, eyeParamsL.renderHeight, false );
  55. } else {
  56. renderer.setPixelRatio( rendererPixelRatio );
  57. renderer.setSize( width, height, updateStyle );
  58. }
  59. };
  60. // VR presentation
  61. var canvas = renderer.domElement;
  62. var defaultLeftBounds = [ 0.0, 0.0, 0.5, 1.0 ];
  63. var defaultRightBounds = [ 0.5, 0.0, 0.5, 1.0 ];
  64. function onVRDisplayPresentChange() {
  65. var wasPresenting = scope.isPresenting;
  66. scope.isPresenting = vrDisplay !== undefined && vrDisplay.isPresenting;
  67. if ( scope.isPresenting ) {
  68. var eyeParamsL = vrDisplay.getEyeParameters( 'left' );
  69. var eyeWidth = eyeParamsL.renderWidth;
  70. var eyeHeight = eyeParamsL.renderHeight;
  71. if ( ! wasPresenting ) {
  72. rendererPixelRatio = renderer.getPixelRatio();
  73. rendererSize = renderer.getSize();
  74. renderer.setPixelRatio( 1 );
  75. renderer.setSize( eyeWidth * 2, eyeHeight, false );
  76. }
  77. } else if ( wasPresenting ) {
  78. renderer.setPixelRatio( rendererPixelRatio );
  79. renderer.setSize( rendererSize.width, rendererSize.height, rendererUpdateStyle );
  80. }
  81. }
  82. window.addEventListener( 'vrdisplaypresentchange', onVRDisplayPresentChange, false );
  83. this.setFullScreen = function ( boolean ) {
  84. return new Promise( function ( resolve, reject ) {
  85. if ( vrDisplay === undefined ) {
  86. reject( new Error( 'No VR hardware found.' ) );
  87. return;
  88. }
  89. if ( scope.isPresenting === boolean ) {
  90. resolve();
  91. return;
  92. }
  93. if ( boolean ) {
  94. resolve( vrDisplay.requestPresent( [ { source: canvas } ] ) );
  95. } else {
  96. resolve( vrDisplay.exitPresent() );
  97. }
  98. } );
  99. };
  100. this.requestPresent = function () {
  101. return this.setFullScreen( true );
  102. };
  103. this.exitPresent = function () {
  104. return this.setFullScreen( false );
  105. };
  106. this.requestAnimationFrame = function ( f ) {
  107. if ( vrDisplay !== undefined ) {
  108. return vrDisplay.requestAnimationFrame( f );
  109. } else {
  110. return window.requestAnimationFrame( f );
  111. }
  112. };
  113. this.cancelAnimationFrame = function ( h ) {
  114. if ( vrDisplay !== undefined ) {
  115. vrDisplay.cancelAnimationFrame( h );
  116. } else {
  117. window.cancelAnimationFrame( h );
  118. }
  119. };
  120. this.submitFrame = function () {
  121. if ( vrDisplay !== undefined && scope.isPresenting ) {
  122. vrDisplay.submitFrame();
  123. }
  124. };
  125. this.autoSubmitFrame = true;
  126. // render
  127. var cameraL = new THREE.PerspectiveCamera();
  128. cameraL.layers.enable( 1 );
  129. var cameraR = new THREE.PerspectiveCamera();
  130. cameraR.layers.enable( 2 );
  131. this.render = function ( scene, camera, renderTarget, forceClear ) {
  132. if ( vrDisplay && scope.isPresenting ) {
  133. var autoUpdate = scene.autoUpdate;
  134. if ( autoUpdate ) {
  135. scene.updateMatrixWorld();
  136. scene.autoUpdate = false;
  137. }
  138. var eyeParamsL = vrDisplay.getEyeParameters( 'left' );
  139. var eyeParamsR = vrDisplay.getEyeParameters( 'right' );
  140. eyeTranslationL.fromArray( eyeParamsL.offset );
  141. eyeTranslationR.fromArray( eyeParamsR.offset );
  142. if ( Array.isArray( scene ) ) {
  143. console.warn( 'THREE.VREffect.render() no longer supports arrays. Use object.layers instead.' );
  144. scene = scene[ 0 ];
  145. }
  146. // When rendering we don't care what the recommended size is, only what the actual size
  147. // of the backbuffer is.
  148. var size = renderer.getSize();
  149. var layers = vrDisplay.getLayers();
  150. var leftBounds;
  151. var rightBounds;
  152. if ( layers.length ) {
  153. var layer = layers[ 0 ];
  154. leftBounds = layer.leftBounds !== null && layer.leftBounds.length === 4 ? layer.leftBounds : defaultLeftBounds;
  155. rightBounds = layer.rightBounds !== null && layer.rightBounds.length === 4 ? layer.rightBounds : defaultRightBounds;
  156. } else {
  157. leftBounds = defaultLeftBounds;
  158. rightBounds = defaultRightBounds;
  159. }
  160. renderRectL = {
  161. x: Math.round( size.width * leftBounds[ 0 ] ),
  162. y: Math.round( size.height * leftBounds[ 1 ] ),
  163. width: Math.round( size.width * leftBounds[ 2 ] ),
  164. height: Math.round( size.height * leftBounds[ 3 ] )
  165. };
  166. renderRectR = {
  167. x: Math.round( size.width * rightBounds[ 0 ] ),
  168. y: Math.round( size.height * rightBounds[ 1 ] ),
  169. width: Math.round( size.width * rightBounds[ 2 ] ),
  170. height: Math.round( size.height * rightBounds[ 3 ] )
  171. };
  172. if ( renderTarget ) {
  173. renderer.setRenderTarget( renderTarget );
  174. renderTarget.scissorTest = true;
  175. } else {
  176. renderer.setRenderTarget( null );
  177. renderer.setScissorTest( true );
  178. }
  179. if ( renderer.autoClear || forceClear ) renderer.clear();
  180. if ( camera.parent === null ) camera.updateMatrixWorld();
  181. camera.matrixWorld.decompose( cameraL.position, cameraL.quaternion, cameraL.scale );
  182. cameraR.position.copy( cameraL.position );
  183. cameraR.quaternion.copy( cameraL.quaternion );
  184. cameraR.scale.copy( cameraL.scale );
  185. cameraL.translateOnAxis( eyeTranslationL, cameraL.scale.x );
  186. cameraR.translateOnAxis( eyeTranslationR, cameraR.scale.x );
  187. if ( vrDisplay.getFrameData ) {
  188. vrDisplay.depthNear = camera.near;
  189. vrDisplay.depthFar = camera.far;
  190. vrDisplay.getFrameData( frameData );
  191. cameraL.projectionMatrix.elements = frameData.leftProjectionMatrix;
  192. cameraR.projectionMatrix.elements = frameData.rightProjectionMatrix;
  193. } else {
  194. cameraL.projectionMatrix = fovToProjection( eyeParamsL.fieldOfView, true, camera.near, camera.far );
  195. cameraR.projectionMatrix = fovToProjection( eyeParamsR.fieldOfView, true, camera.near, camera.far );
  196. }
  197. // render left eye
  198. if ( renderTarget ) {
  199. renderTarget.viewport.set( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  200. renderTarget.scissor.set( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  201. } else {
  202. renderer.setViewport( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  203. renderer.setScissor( renderRectL.x, renderRectL.y, renderRectL.width, renderRectL.height );
  204. }
  205. renderer.render( scene, cameraL, renderTarget, forceClear );
  206. // render right eye
  207. if ( renderTarget ) {
  208. renderTarget.viewport.set( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  209. renderTarget.scissor.set( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  210. } else {
  211. renderer.setViewport( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  212. renderer.setScissor( renderRectR.x, renderRectR.y, renderRectR.width, renderRectR.height );
  213. }
  214. renderer.render( scene, cameraR, renderTarget, forceClear );
  215. if ( renderTarget ) {
  216. renderTarget.viewport.set( 0, 0, size.width, size.height );
  217. renderTarget.scissor.set( 0, 0, size.width, size.height );
  218. renderTarget.scissorTest = false;
  219. renderer.setRenderTarget( null );
  220. } else {
  221. renderer.setViewport( 0, 0, size.width, size.height );
  222. renderer.setScissorTest( false );
  223. }
  224. if ( autoUpdate ) {
  225. scene.autoUpdate = true;
  226. }
  227. if ( scope.autoSubmitFrame ) {
  228. scope.submitFrame();
  229. }
  230. return;
  231. }
  232. // Regular render mode if not HMD
  233. renderer.render( scene, camera, renderTarget, forceClear );
  234. };
  235. this.dispose = function () {
  236. window.removeEventListener( 'vrdisplaypresentchange', onVRDisplayPresentChange, false );
  237. };
  238. //
  239. function fovToNDCScaleOffset( fov ) {
  240. var pxscale = 2.0 / ( fov.leftTan + fov.rightTan );
  241. var pxoffset = ( fov.leftTan - fov.rightTan ) * pxscale * 0.5;
  242. var pyscale = 2.0 / ( fov.upTan + fov.downTan );
  243. var pyoffset = ( fov.upTan - fov.downTan ) * pyscale * 0.5;
  244. return { scale: [ pxscale, pyscale ], offset: [ pxoffset, pyoffset ] };
  245. }
  246. function fovPortToProjection( fov, rightHanded, zNear, zFar ) {
  247. rightHanded = rightHanded === undefined ? true : rightHanded;
  248. zNear = zNear === undefined ? 0.01 : zNear;
  249. zFar = zFar === undefined ? 10000.0 : zFar;
  250. var handednessScale = rightHanded ? - 1.0 : 1.0;
  251. // start with an identity matrix
  252. var mobj = new THREE.Matrix4();
  253. var m = mobj.elements;
  254. // and with scale/offset info for normalized device coords
  255. var scaleAndOffset = fovToNDCScaleOffset( fov );
  256. // X result, map clip edges to [-w,+w]
  257. m[ 0 * 4 + 0 ] = scaleAndOffset.scale[ 0 ];
  258. m[ 0 * 4 + 1 ] = 0.0;
  259. m[ 0 * 4 + 2 ] = scaleAndOffset.offset[ 0 ] * handednessScale;
  260. m[ 0 * 4 + 3 ] = 0.0;
  261. // Y result, map clip edges to [-w,+w]
  262. // Y offset is negated because this proj matrix transforms from world coords with Y=up,
  263. // but the NDC scaling has Y=down (thanks D3D?)
  264. m[ 1 * 4 + 0 ] = 0.0;
  265. m[ 1 * 4 + 1 ] = scaleAndOffset.scale[ 1 ];
  266. m[ 1 * 4 + 2 ] = - scaleAndOffset.offset[ 1 ] * handednessScale;
  267. m[ 1 * 4 + 3 ] = 0.0;
  268. // Z result (up to the app)
  269. m[ 2 * 4 + 0 ] = 0.0;
  270. m[ 2 * 4 + 1 ] = 0.0;
  271. m[ 2 * 4 + 2 ] = zFar / ( zNear - zFar ) * - handednessScale;
  272. m[ 2 * 4 + 3 ] = ( zFar * zNear ) / ( zNear - zFar );
  273. // W result (= Z in)
  274. m[ 3 * 4 + 0 ] = 0.0;
  275. m[ 3 * 4 + 1 ] = 0.0;
  276. m[ 3 * 4 + 2 ] = handednessScale;
  277. m[ 3 * 4 + 3 ] = 0.0;
  278. mobj.transpose();
  279. return mobj;
  280. }
  281. function fovToProjection( fov, rightHanded, zNear, zFar ) {
  282. var DEG2RAD = Math.PI / 180.0;
  283. var fovPort = {
  284. upTan: Math.tan( fov.upDegrees * DEG2RAD ),
  285. downTan: Math.tan( fov.downDegrees * DEG2RAD ),
  286. leftTan: Math.tan( fov.leftDegrees * DEG2RAD ),
  287. rightTan: Math.tan( fov.rightDegrees * DEG2RAD )
  288. };
  289. return fovPortToProjection( fovPort, rightHanded, zNear, zFar );
  290. }
  291. };