FlyOrbitControls.js 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. import { Clock, Vector3, Vector4 } from 'three';
  2. import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls.js';
  3. const changeEvent = { type: 'fly-change' };
  4. const startEvent = { type: 'fly-start' };
  5. const endEvent = { type: 'fly-end' };
  6. const tempVector = new Vector4( 0, 0, 0, 0 );
  7. export class FlyOrbitControls extends OrbitControls {
  8. constructor( camera, domElement ) {
  9. // Disable use of shift key so we can use it for acceleration
  10. const disableShiftKeyCallback = e => {
  11. if ( this.enabled ) {
  12. Object.defineProperty( e, 'shiftKey', { get() { return false } } );
  13. }
  14. };
  15. domElement.addEventListener( 'pointerdown', disableShiftKeyCallback );
  16. super( camera, domElement );
  17. this.enableKeys = false;
  18. this.enableFlight = true;
  19. this.baseSpeed = 1;
  20. this.fastSpeed = 4;
  21. this.forwardKey = 'w';
  22. this.backKey = 's';
  23. this.leftKey = 'a';
  24. this.rightKey = 'd';
  25. this.upKey = 'q';
  26. this.downKey = 'e';
  27. this.fastKey = 'shift';
  28. let fastHeld = false;
  29. let forwardHeld = false;
  30. let backHeld = false;
  31. let leftHeld = false;
  32. let rightHeld = false;
  33. let upHeld = false;
  34. let downHeld = false;
  35. let originalDistance = 0;
  36. let originalMinDistance = 0;
  37. let originalMaxDistance = 0;
  38. let rafHandle = - 1;
  39. const originalTarget = new Vector3();
  40. const clock = new Clock();
  41. const endFlight = () => {
  42. if ( rafHandle !== - 1 ) {
  43. // cancel the animation playing
  44. cancelAnimationFrame( rafHandle );
  45. rafHandle = - 1;
  46. // store the original distances for the controls
  47. this.minDistance = originalMinDistance;
  48. this.maxDistance = originalMaxDistance;
  49. const targetDistance = Math.min( originalDistance, camera.position.distanceTo( originalTarget ) );
  50. tempVector
  51. .set( 0, 0, - 1, 0 )
  52. .applyMatrix4( camera.matrixWorld );
  53. this
  54. .target
  55. .copy( camera.position )
  56. .addScaledVector( tempVector, targetDistance );
  57. this.dispatchEvent( endEvent );
  58. }
  59. };
  60. const updateFlight = () => {
  61. if ( ! this.enabled || ! this.enableFlight ) {
  62. return;
  63. }
  64. rafHandle = requestAnimationFrame( updateFlight );
  65. // get the direction
  66. tempVector.set( 0, 0, 0, 0 );
  67. if ( forwardHeld ) tempVector.z -= 1;
  68. if ( backHeld ) tempVector.z += 1;
  69. if ( leftHeld ) tempVector.x -= 1;
  70. if ( rightHeld ) tempVector.x += 1;
  71. if ( upHeld ) tempVector.y += 1;
  72. if ( downHeld ) tempVector.y -= 1;
  73. tempVector.applyMatrix4( camera.matrixWorld );
  74. // apply the movement
  75. const delta = 60 * clock.getDelta();
  76. const speed = fastHeld ? this.fastSpeed : this.baseSpeed;
  77. camera
  78. .position
  79. .addScaledVector( tempVector, speed * delta );
  80. this
  81. .target
  82. .addScaledVector( tempVector, speed * delta );
  83. this.dispatchEvent( changeEvent );
  84. };
  85. const keyDownCallback = e => {
  86. const key = e.key.toLowerCase();
  87. if ( rafHandle === - 1 ) {
  88. originalMaxDistance = this.maxDistance;
  89. originalMinDistance = this.minDistance;
  90. originalDistance = camera.position.distanceTo( this.target );
  91. originalTarget.copy( this.target );
  92. }
  93. switch ( key ) {
  94. case this.forwardKey:
  95. forwardHeld = true;
  96. break;
  97. case this.backKey:
  98. backHeld = true;
  99. break;
  100. case this.leftKey:
  101. leftHeld = true;
  102. break;
  103. case this.rightKey:
  104. rightHeld = true;
  105. break;
  106. case this.upKey:
  107. upHeld = true;
  108. break;
  109. case this.downKey:
  110. downHeld = true;
  111. break;
  112. case this.fastKey:
  113. fastHeld = true;
  114. break;
  115. }
  116. switch ( key ) {
  117. case this.fastKey:
  118. case this.forwardKey:
  119. case this.backKey:
  120. case this.leftKey:
  121. case this.rightKey:
  122. case this.upKey:
  123. case this.downKey:
  124. e.stopPropagation();
  125. e.preventDefault();
  126. }
  127. if ( forwardHeld || backHeld || leftHeld || rightHeld || upHeld || downHeld || fastHeld ) {
  128. this.minDistance = 0.01;
  129. this.maxDistance = 0.01;
  130. // Move the orbit target out to just in front of the camera
  131. tempVector
  132. .set( 0, 0, - 1, 0 )
  133. .applyMatrix4( camera.matrixWorld );
  134. this
  135. .target
  136. .copy( camera.position )
  137. .addScaledVector( tempVector, 0.01 );
  138. if ( rafHandle === - 1 ) {
  139. // start the flight and reset the clock
  140. this.dispatchEvent( startEvent );
  141. clock.getDelta();
  142. updateFlight();
  143. }
  144. }
  145. };
  146. const keyUpCallback = e => {
  147. const key = e.key.toLowerCase();
  148. switch ( key ) {
  149. case this.fastKey:
  150. case this.forwardKey:
  151. case this.backKey:
  152. case this.leftKey:
  153. case this.rightKey:
  154. case this.upKey:
  155. case this.downKey:
  156. e.stopPropagation();
  157. e.preventDefault();
  158. }
  159. switch( key ) {
  160. case this.forwardKey:
  161. forwardHeld = false;
  162. break;
  163. case this.backKey:
  164. backHeld = false;
  165. break;
  166. case this.leftKey:
  167. leftHeld = false;
  168. break;
  169. case this.rightKey:
  170. rightHeld = false;
  171. break;
  172. case this.upKey:
  173. upHeld = false;
  174. break;
  175. case this.downKey:
  176. downHeld = false;
  177. break;
  178. case this.fastKey:
  179. fastHeld = false;
  180. break;
  181. }
  182. if ( ! ( forwardHeld || backHeld || leftHeld || rightHeld || upHeld || downHeld || fastHeld ) ) {
  183. endFlight();
  184. }
  185. };
  186. const blurCallback = () => {
  187. endFlight();
  188. };
  189. this.blurCallback = blurCallback;
  190. this.keyDownCallback = keyDownCallback;
  191. this.keyUpCallback = keyUpCallback;
  192. this.disableShiftKeyCallback = disableShiftKeyCallback;
  193. this.domElement.addEventListener( 'blur', blurCallback );
  194. this.domElement.addEventListener( 'keydown', keyDownCallback );
  195. this.domElement.addEventListener( 'keyup', keyUpCallback );
  196. }
  197. dispose() {
  198. super.dispose();
  199. this.domElement.removeEventListener( 'blur', this.blurCallback );
  200. this.domElement.removeEventListener( 'keydown', this.keyDownCallback );
  201. this.domElement.removeEventListener( 'keyup', this.keyUpCallback );
  202. this.domElement.removeEventListener( 'pointerdown', this.disableShiftKeyCallback );
  203. }
  204. }