OrbitControls.js 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405
  1. import {
  2. EventDispatcher,
  3. MOUSE,
  4. Quaternion,
  5. Spherical,
  6. TOUCH,
  7. Vector2,
  8. Vector3,
  9. Plane,
  10. Ray,
  11. MathUtils
  12. } from 'three';
  13. // OrbitControls performs orbiting, dollying (zooming), and panning.
  14. // Unlike TrackballControls, it maintains the "up" direction object.up (+Y by default).
  15. //
  16. // Orbit - left mouse / touch: one-finger move
  17. // Zoom - middle mouse, or mousewheel / touch: two-finger spread or squish
  18. // Pan - right mouse, or left mouse + ctrl/meta/shiftKey, or arrow keys / touch: two-finger move
  19. const _changeEvent = { type: 'change' };
  20. const _startEvent = { type: 'start' };
  21. const _endEvent = { type: 'end' };
  22. const _ray = new Ray();
  23. const _plane = new Plane();
  24. const TILT_LIMIT = Math.cos( 70 * MathUtils.DEG2RAD );
  25. class OrbitControls extends EventDispatcher {
  26. constructor( object, domElement ) {
  27. super();
  28. this.object = object;
  29. this.domElement = domElement;
  30. this.domElement.style.touchAction = 'none'; // disable touch scroll
  31. // Set to false to disable this control
  32. this.enabled = true;
  33. // "target" sets the location of focus, where the object orbits around
  34. this.target = new Vector3();
  35. // Sets the 3D cursor (similar to Blender), from which the maxTargetRadius takes effect
  36. this.cursor = new Vector3();
  37. // How far you can dolly in and out ( PerspectiveCamera only )
  38. this.minDistance = 0;
  39. this.maxDistance = Infinity;
  40. // How far you can zoom in and out ( OrthographicCamera only )
  41. this.minZoom = 0;
  42. this.maxZoom = Infinity;
  43. // Limit camera target within a spherical area around the cursor
  44. this.minTargetRadius = 0;
  45. this.maxTargetRadius = Infinity;
  46. // How far you can orbit vertically, upper and lower limits.
  47. // Range is 0 to Math.PI radians.
  48. this.minPolarAngle = 0; // radians
  49. this.maxPolarAngle = Math.PI; // radians
  50. // How far you can orbit horizontally, upper and lower limits.
  51. // If set, the interval [ min, max ] must be a sub-interval of [ - 2 PI, 2 PI ], with ( max - min < 2 PI )
  52. this.minAzimuthAngle = - Infinity; // radians
  53. this.maxAzimuthAngle = Infinity; // radians
  54. // Set to true to enable damping (inertia)
  55. // If damping is enabled, you must call controls.update() in your animation loop
  56. this.enableDamping = false;
  57. this.dampingFactor = 0.05;
  58. // This option actually enables dollying in and out; left as "zoom" for backwards compatibility.
  59. // Set to false to disable zooming
  60. this.enableZoom = true;
  61. this.zoomSpeed = 1.0;
  62. // Set to false to disable rotating
  63. this.enableRotate = true;
  64. this.rotateSpeed = 1.0;
  65. // Set to false to disable panning
  66. this.enablePan = true;
  67. this.panSpeed = 1.0;
  68. this.screenSpacePanning = true; // if false, pan orthogonal to world-space direction camera.up
  69. this.keyPanSpeed = 7.0; // pixels moved per arrow key push
  70. this.zoomToCursor = false;
  71. // Set to true to automatically rotate around the target
  72. // If auto-rotate is enabled, you must call controls.update() in your animation loop
  73. this.autoRotate = false;
  74. this.autoRotateSpeed = 2.0; // 30 seconds per orbit when fps is 60
  75. // The four arrow keys
  76. this.keys = { LEFT: 'ArrowLeft', UP: 'ArrowUp', RIGHT: 'ArrowRight', BOTTOM: 'ArrowDown' };
  77. // Mouse buttons
  78. this.mouseButtons = { LEFT: MOUSE.ROTATE, MIDDLE: MOUSE.DOLLY, RIGHT: MOUSE.PAN };
  79. // Touch fingers
  80. this.touches = { ONE: TOUCH.ROTATE, TWO: TOUCH.DOLLY_PAN };
  81. // for reset
  82. this.target0 = this.target.clone();
  83. this.position0 = this.object.position.clone();
  84. this.zoom0 = this.object.zoom;
  85. // the target DOM element for key events
  86. this._domElementKeyEvents = null;
  87. //
  88. // public methods
  89. //
  90. this.getPolarAngle = function () {
  91. return spherical.phi;
  92. };
  93. this.getAzimuthalAngle = function () {
  94. return spherical.theta;
  95. };
  96. this.getDistance = function () {
  97. return this.object.position.distanceTo( this.target );
  98. };
  99. this.listenToKeyEvents = function ( domElement ) {
  100. domElement.addEventListener( 'keydown', onKeyDown );
  101. this._domElementKeyEvents = domElement;
  102. };
  103. this.stopListenToKeyEvents = function () {
  104. this._domElementKeyEvents.removeEventListener( 'keydown', onKeyDown );
  105. this._domElementKeyEvents = null;
  106. };
  107. this.saveState = function () {
  108. scope.target0.copy( scope.target );
  109. scope.position0.copy( scope.object.position );
  110. scope.zoom0 = scope.object.zoom;
  111. };
  112. this.reset = function () {
  113. scope.target.copy( scope.target0 );
  114. scope.object.position.copy( scope.position0 );
  115. scope.object.zoom = scope.zoom0;
  116. scope.object.updateProjectionMatrix();
  117. scope.dispatchEvent( _changeEvent );
  118. scope.update();
  119. state = STATE.NONE;
  120. };
  121. // this method is exposed, but perhaps it would be better if we can make it private...
  122. this.update = function () {
  123. const offset = new Vector3();
  124. // so camera.up is the orbit axis
  125. const quat = new Quaternion().setFromUnitVectors( object.up, new Vector3( 0, 1, 0 ) );
  126. const quatInverse = quat.clone().invert();
  127. const lastPosition = new Vector3();
  128. const lastQuaternion = new Quaternion();
  129. const lastTargetPosition = new Vector3();
  130. const twoPI = 2 * Math.PI;
  131. return function update( deltaTime = null ) {
  132. const position = scope.object.position;
  133. offset.copy( position ).sub( scope.target );
  134. // rotate offset to "y-axis-is-up" space
  135. offset.applyQuaternion( quat );
  136. // angle from z-axis around y-axis
  137. spherical.setFromVector3( offset );
  138. if ( scope.autoRotate && state === STATE.NONE ) {
  139. rotateLeft( getAutoRotationAngle( deltaTime ) );
  140. }
  141. if ( scope.enableDamping ) {
  142. spherical.theta += sphericalDelta.theta * scope.dampingFactor;
  143. spherical.phi += sphericalDelta.phi * scope.dampingFactor;
  144. } else {
  145. spherical.theta += sphericalDelta.theta;
  146. spherical.phi += sphericalDelta.phi;
  147. }
  148. // restrict theta to be between desired limits
  149. let min = scope.minAzimuthAngle;
  150. let max = scope.maxAzimuthAngle;
  151. if ( isFinite( min ) && isFinite( max ) ) {
  152. if ( min < - Math.PI ) min += twoPI; else if ( min > Math.PI ) min -= twoPI;
  153. if ( max < - Math.PI ) max += twoPI; else if ( max > Math.PI ) max -= twoPI;
  154. if ( min <= max ) {
  155. spherical.theta = Math.max( min, Math.min( max, spherical.theta ) );
  156. } else {
  157. spherical.theta = ( spherical.theta > ( min + max ) / 2 ) ?
  158. Math.max( min, spherical.theta ) :
  159. Math.min( max, spherical.theta );
  160. }
  161. }
  162. // restrict phi to be between desired limits
  163. spherical.phi = Math.max( scope.minPolarAngle, Math.min( scope.maxPolarAngle, spherical.phi ) );
  164. spherical.makeSafe();
  165. // move target to panned location
  166. if ( scope.enableDamping === true ) {
  167. scope.target.addScaledVector( panOffset, scope.dampingFactor );
  168. } else {
  169. scope.target.add( panOffset );
  170. }
  171. // Limit the target distance from the cursor to create a sphere around the center of interest
  172. scope.target.sub( scope.cursor );
  173. scope.target.clampLength( scope.minTargetRadius, scope.maxTargetRadius );
  174. scope.target.add( scope.cursor );
  175. // adjust the camera position based on zoom only if we're not zooming to the cursor or if it's an ortho camera
  176. // we adjust zoom later in these cases
  177. if ( scope.zoomToCursor && performCursorZoom || scope.object.isOrthographicCamera ) {
  178. spherical.radius = clampDistance( spherical.radius );
  179. } else {
  180. spherical.radius = clampDistance( spherical.radius * scale );
  181. }
  182. offset.setFromSpherical( spherical );
  183. // rotate offset back to "camera-up-vector-is-up" space
  184. offset.applyQuaternion( quatInverse );
  185. position.copy( scope.target ).add( offset );
  186. scope.object.lookAt( scope.target );
  187. if ( scope.enableDamping === true ) {
  188. sphericalDelta.theta *= ( 1 - scope.dampingFactor );
  189. sphericalDelta.phi *= ( 1 - scope.dampingFactor );
  190. panOffset.multiplyScalar( 1 - scope.dampingFactor );
  191. } else {
  192. sphericalDelta.set( 0, 0, 0 );
  193. panOffset.set( 0, 0, 0 );
  194. }
  195. // adjust camera position
  196. let zoomChanged = false;
  197. if ( scope.zoomToCursor && performCursorZoom ) {
  198. let newRadius = null;
  199. if ( scope.object.isPerspectiveCamera ) {
  200. // move the camera down the pointer ray
  201. // this method avoids floating point error
  202. const prevRadius = offset.length();
  203. newRadius = clampDistance( prevRadius * scale );
  204. const radiusDelta = prevRadius - newRadius;
  205. scope.object.position.addScaledVector( dollyDirection, radiusDelta );
  206. scope.object.updateMatrixWorld();
  207. } else if ( scope.object.isOrthographicCamera ) {
  208. // adjust the ortho camera position based on zoom changes
  209. const mouseBefore = new Vector3( mouse.x, mouse.y, 0 );
  210. mouseBefore.unproject( scope.object );
  211. scope.object.zoom = Math.max( scope.minZoom, Math.min( scope.maxZoom, scope.object.zoom / scale ) );
  212. scope.object.updateProjectionMatrix();
  213. zoomChanged = true;
  214. const mouseAfter = new Vector3( mouse.x, mouse.y, 0 );
  215. mouseAfter.unproject( scope.object );
  216. scope.object.position.sub( mouseAfter ).add( mouseBefore );
  217. scope.object.updateMatrixWorld();
  218. newRadius = offset.length();
  219. } else {
  220. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - zoom to cursor disabled.' );
  221. scope.zoomToCursor = false;
  222. }
  223. // handle the placement of the target
  224. if ( newRadius !== null ) {
  225. if ( this.screenSpacePanning ) {
  226. // position the orbit target in front of the new camera position
  227. scope.target.set( 0, 0, - 1 )
  228. .transformDirection( scope.object.matrix )
  229. .multiplyScalar( newRadius )
  230. .add( scope.object.position );
  231. } else {
  232. // get the ray and translation plane to compute target
  233. _ray.origin.copy( scope.object.position );
  234. _ray.direction.set( 0, 0, - 1 ).transformDirection( scope.object.matrix );
  235. // if the camera is 20 degrees above the horizon then don't adjust the focus target to avoid
  236. // extremely large values
  237. if ( Math.abs( scope.object.up.dot( _ray.direction ) ) < TILT_LIMIT ) {
  238. object.lookAt( scope.target );
  239. } else {
  240. _plane.setFromNormalAndCoplanarPoint( scope.object.up, scope.target );
  241. _ray.intersectPlane( _plane, scope.target );
  242. }
  243. }
  244. }
  245. } else if ( scope.object.isOrthographicCamera ) {
  246. scope.object.zoom = Math.max( scope.minZoom, Math.min( scope.maxZoom, scope.object.zoom / scale ) );
  247. scope.object.updateProjectionMatrix();
  248. zoomChanged = true;
  249. }
  250. scale = 1;
  251. performCursorZoom = false;
  252. // update condition is:
  253. // min(camera displacement, camera rotation in radians)^2 > EPS
  254. // using small-angle approximation cos(x/2) = 1 - x^2 / 8
  255. if ( zoomChanged ||
  256. lastPosition.distanceToSquared( scope.object.position ) > EPS ||
  257. 8 * ( 1 - lastQuaternion.dot( scope.object.quaternion ) ) > EPS ||
  258. lastTargetPosition.distanceToSquared( scope.target ) > 0 ) {
  259. scope.dispatchEvent( _changeEvent );
  260. lastPosition.copy( scope.object.position );
  261. lastQuaternion.copy( scope.object.quaternion );
  262. lastTargetPosition.copy( scope.target );
  263. return true;
  264. }
  265. return false;
  266. };
  267. }();
  268. this.dispose = function () {
  269. scope.domElement.removeEventListener( 'contextmenu', onContextMenu );
  270. scope.domElement.removeEventListener( 'pointerdown', onPointerDown );
  271. scope.domElement.removeEventListener( 'pointercancel', onPointerUp );
  272. scope.domElement.removeEventListener( 'wheel', onMouseWheel );
  273. scope.domElement.removeEventListener( 'pointermove', onPointerMove );
  274. scope.domElement.removeEventListener( 'pointerup', onPointerUp );
  275. if ( scope._domElementKeyEvents !== null ) {
  276. scope._domElementKeyEvents.removeEventListener( 'keydown', onKeyDown );
  277. scope._domElementKeyEvents = null;
  278. }
  279. //scope.dispatchEvent( { type: 'dispose' } ); // should this be added here?
  280. };
  281. //
  282. // internals
  283. //
  284. const scope = this;
  285. const STATE = {
  286. NONE: - 1,
  287. ROTATE: 0,
  288. DOLLY: 1,
  289. PAN: 2,
  290. TOUCH_ROTATE: 3,
  291. TOUCH_PAN: 4,
  292. TOUCH_DOLLY_PAN: 5,
  293. TOUCH_DOLLY_ROTATE: 6
  294. };
  295. let state = STATE.NONE;
  296. const EPS = 0.000001;
  297. // current position in spherical coordinates
  298. const spherical = new Spherical();
  299. const sphericalDelta = new Spherical();
  300. let scale = 1;
  301. const panOffset = new Vector3();
  302. const rotateStart = new Vector2();
  303. const rotateEnd = new Vector2();
  304. const rotateDelta = new Vector2();
  305. const panStart = new Vector2();
  306. const panEnd = new Vector2();
  307. const panDelta = new Vector2();
  308. const dollyStart = new Vector2();
  309. const dollyEnd = new Vector2();
  310. const dollyDelta = new Vector2();
  311. const dollyDirection = new Vector3();
  312. const mouse = new Vector2();
  313. let performCursorZoom = false;
  314. const pointers = [];
  315. const pointerPositions = {};
  316. function getAutoRotationAngle( deltaTime ) {
  317. if ( deltaTime !== null ) {
  318. return ( 2 * Math.PI / 60 * scope.autoRotateSpeed ) * deltaTime;
  319. } else {
  320. return 2 * Math.PI / 60 / 60 * scope.autoRotateSpeed;
  321. }
  322. }
  323. function getZoomScale() {
  324. return Math.pow( 0.95, scope.zoomSpeed );
  325. }
  326. function rotateLeft( angle ) {
  327. sphericalDelta.theta -= angle;
  328. }
  329. function rotateUp( angle ) {
  330. sphericalDelta.phi -= angle;
  331. }
  332. const panLeft = function () {
  333. const v = new Vector3();
  334. return function panLeft( distance, objectMatrix ) {
  335. v.setFromMatrixColumn( objectMatrix, 0 ); // get X column of objectMatrix
  336. v.multiplyScalar( - distance );
  337. panOffset.add( v );
  338. };
  339. }();
  340. const panUp = function () {
  341. const v = new Vector3();
  342. return function panUp( distance, objectMatrix ) {
  343. if ( scope.screenSpacePanning === true ) {
  344. v.setFromMatrixColumn( objectMatrix, 1 );
  345. } else {
  346. v.setFromMatrixColumn( objectMatrix, 0 );
  347. v.crossVectors( scope.object.up, v );
  348. }
  349. v.multiplyScalar( distance );
  350. panOffset.add( v );
  351. };
  352. }();
  353. // deltaX and deltaY are in pixels; right and down are positive
  354. const pan = function () {
  355. const offset = new Vector3();
  356. return function pan( deltaX, deltaY ) {
  357. const element = scope.domElement;
  358. if ( scope.object.isPerspectiveCamera ) {
  359. // perspective
  360. const position = scope.object.position;
  361. offset.copy( position ).sub( scope.target );
  362. let targetDistance = offset.length();
  363. // half of the fov is center to top of screen
  364. targetDistance *= Math.tan( ( scope.object.fov / 2 ) * Math.PI / 180.0 );
  365. // we use only clientHeight here so aspect ratio does not distort speed
  366. panLeft( 2 * deltaX * targetDistance / element.clientHeight, scope.object.matrix );
  367. panUp( 2 * deltaY * targetDistance / element.clientHeight, scope.object.matrix );
  368. } else if ( scope.object.isOrthographicCamera ) {
  369. // orthographic
  370. panLeft( deltaX * ( scope.object.right - scope.object.left ) / scope.object.zoom / element.clientWidth, scope.object.matrix );
  371. panUp( deltaY * ( scope.object.top - scope.object.bottom ) / scope.object.zoom / element.clientHeight, scope.object.matrix );
  372. } else {
  373. // camera neither orthographic nor perspective
  374. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - pan disabled.' );
  375. scope.enablePan = false;
  376. }
  377. };
  378. }();
  379. function dollyOut( dollyScale ) {
  380. if ( scope.object.isPerspectiveCamera || scope.object.isOrthographicCamera ) {
  381. scale /= dollyScale;
  382. } else {
  383. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - dolly/zoom disabled.' );
  384. scope.enableZoom = false;
  385. }
  386. }
  387. function dollyIn( dollyScale ) {
  388. if ( scope.object.isPerspectiveCamera || scope.object.isOrthographicCamera ) {
  389. scale *= dollyScale;
  390. } else {
  391. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - dolly/zoom disabled.' );
  392. scope.enableZoom = false;
  393. }
  394. }
  395. function updateMouseParameters( event ) {
  396. if ( ! scope.zoomToCursor ) {
  397. return;
  398. }
  399. performCursorZoom = true;
  400. const rect = scope.domElement.getBoundingClientRect();
  401. const x = event.clientX - rect.left;
  402. const y = event.clientY - rect.top;
  403. const w = rect.width;
  404. const h = rect.height;
  405. mouse.x = ( x / w ) * 2 - 1;
  406. mouse.y = - ( y / h ) * 2 + 1;
  407. dollyDirection.set( mouse.x, mouse.y, 1 ).unproject( scope.object ).sub( scope.object.position ).normalize();
  408. }
  409. function clampDistance( dist ) {
  410. return Math.max( scope.minDistance, Math.min( scope.maxDistance, dist ) );
  411. }
  412. //
  413. // event callbacks - update the object state
  414. //
  415. function handleMouseDownRotate( event ) {
  416. rotateStart.set( event.clientX, event.clientY );
  417. }
  418. function handleMouseDownDolly( event ) {
  419. updateMouseParameters( event );
  420. dollyStart.set( event.clientX, event.clientY );
  421. }
  422. function handleMouseDownPan( event ) {
  423. panStart.set( event.clientX, event.clientY );
  424. }
  425. function handleMouseMoveRotate( event ) {
  426. rotateEnd.set( event.clientX, event.clientY );
  427. rotateDelta.subVectors( rotateEnd, rotateStart ).multiplyScalar( scope.rotateSpeed );
  428. const element = scope.domElement;
  429. rotateLeft( 2 * Math.PI * rotateDelta.x / element.clientHeight ); // yes, height
  430. rotateUp( 2 * Math.PI * rotateDelta.y / element.clientHeight );
  431. rotateStart.copy( rotateEnd );
  432. scope.update();
  433. }
  434. function handleMouseMoveDolly( event ) {
  435. dollyEnd.set( event.clientX, event.clientY );
  436. dollyDelta.subVectors( dollyEnd, dollyStart );
  437. if ( dollyDelta.y > 0 ) {
  438. dollyOut( getZoomScale() );
  439. } else if ( dollyDelta.y < 0 ) {
  440. dollyIn( getZoomScale() );
  441. }
  442. dollyStart.copy( dollyEnd );
  443. scope.update();
  444. }
  445. function handleMouseMovePan( event ) {
  446. panEnd.set( event.clientX, event.clientY );
  447. panDelta.subVectors( panEnd, panStart ).multiplyScalar( scope.panSpeed );
  448. pan( panDelta.x, panDelta.y );
  449. panStart.copy( panEnd );
  450. scope.update();
  451. }
  452. function handleMouseWheel( event ) {
  453. updateMouseParameters( event );
  454. if ( event.deltaY < 0 ) {
  455. dollyIn( getZoomScale() );
  456. } else if ( event.deltaY > 0 ) {
  457. dollyOut( getZoomScale() );
  458. }
  459. scope.update();
  460. }
  461. function handleKeyDown( event ) {
  462. let needsUpdate = false;
  463. switch ( event.code ) {
  464. case scope.keys.UP:
  465. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  466. rotateUp( 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  467. } else {
  468. pan( 0, scope.keyPanSpeed );
  469. }
  470. needsUpdate = true;
  471. break;
  472. case scope.keys.BOTTOM:
  473. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  474. rotateUp( - 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  475. } else {
  476. pan( 0, - scope.keyPanSpeed );
  477. }
  478. needsUpdate = true;
  479. break;
  480. case scope.keys.LEFT:
  481. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  482. rotateLeft( 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  483. } else {
  484. pan( scope.keyPanSpeed, 0 );
  485. }
  486. needsUpdate = true;
  487. break;
  488. case scope.keys.RIGHT:
  489. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  490. rotateLeft( - 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  491. } else {
  492. pan( - scope.keyPanSpeed, 0 );
  493. }
  494. needsUpdate = true;
  495. break;
  496. }
  497. if ( needsUpdate ) {
  498. // prevent the browser from scrolling on cursor keys
  499. event.preventDefault();
  500. scope.update();
  501. }
  502. }
  503. function handleTouchStartRotate() {
  504. if ( pointers.length === 1 ) {
  505. rotateStart.set( pointers[ 0 ].pageX, pointers[ 0 ].pageY );
  506. } else {
  507. const x = 0.5 * ( pointers[ 0 ].pageX + pointers[ 1 ].pageX );
  508. const y = 0.5 * ( pointers[ 0 ].pageY + pointers[ 1 ].pageY );
  509. rotateStart.set( x, y );
  510. }
  511. }
  512. function handleTouchStartPan() {
  513. if ( pointers.length === 1 ) {
  514. panStart.set( pointers[ 0 ].pageX, pointers[ 0 ].pageY );
  515. } else {
  516. const x = 0.5 * ( pointers[ 0 ].pageX + pointers[ 1 ].pageX );
  517. const y = 0.5 * ( pointers[ 0 ].pageY + pointers[ 1 ].pageY );
  518. panStart.set( x, y );
  519. }
  520. }
  521. function handleTouchStartDolly() {
  522. const dx = pointers[ 0 ].pageX - pointers[ 1 ].pageX;
  523. const dy = pointers[ 0 ].pageY - pointers[ 1 ].pageY;
  524. const distance = Math.sqrt( dx * dx + dy * dy );
  525. dollyStart.set( 0, distance );
  526. }
  527. function handleTouchStartDollyPan() {
  528. if ( scope.enableZoom ) handleTouchStartDolly();
  529. if ( scope.enablePan ) handleTouchStartPan();
  530. }
  531. function handleTouchStartDollyRotate() {
  532. if ( scope.enableZoom ) handleTouchStartDolly();
  533. if ( scope.enableRotate ) handleTouchStartRotate();
  534. }
  535. function handleTouchMoveRotate( event ) {
  536. if ( pointers.length == 1 ) {
  537. rotateEnd.set( event.pageX, event.pageY );
  538. } else {
  539. const position = getSecondPointerPosition( event );
  540. const x = 0.5 * ( event.pageX + position.x );
  541. const y = 0.5 * ( event.pageY + position.y );
  542. rotateEnd.set( x, y );
  543. }
  544. rotateDelta.subVectors( rotateEnd, rotateStart ).multiplyScalar( scope.rotateSpeed );
  545. const element = scope.domElement;
  546. rotateLeft( 2 * Math.PI * rotateDelta.x / element.clientHeight ); // yes, height
  547. rotateUp( 2 * Math.PI * rotateDelta.y / element.clientHeight );
  548. rotateStart.copy( rotateEnd );
  549. }
  550. function handleTouchMovePan( event ) {
  551. if ( pointers.length === 1 ) {
  552. panEnd.set( event.pageX, event.pageY );
  553. } else {
  554. const position = getSecondPointerPosition( event );
  555. const x = 0.5 * ( event.pageX + position.x );
  556. const y = 0.5 * ( event.pageY + position.y );
  557. panEnd.set( x, y );
  558. }
  559. panDelta.subVectors( panEnd, panStart ).multiplyScalar( scope.panSpeed );
  560. pan( panDelta.x, panDelta.y );
  561. panStart.copy( panEnd );
  562. }
  563. function handleTouchMoveDolly( event ) {
  564. const position = getSecondPointerPosition( event );
  565. const dx = event.pageX - position.x;
  566. const dy = event.pageY - position.y;
  567. const distance = Math.sqrt( dx * dx + dy * dy );
  568. dollyEnd.set( 0, distance );
  569. dollyDelta.set( 0, Math.pow( dollyEnd.y / dollyStart.y, scope.zoomSpeed ) );
  570. dollyOut( dollyDelta.y );
  571. dollyStart.copy( dollyEnd );
  572. }
  573. function handleTouchMoveDollyPan( event ) {
  574. if ( scope.enableZoom ) handleTouchMoveDolly( event );
  575. if ( scope.enablePan ) handleTouchMovePan( event );
  576. }
  577. function handleTouchMoveDollyRotate( event ) {
  578. if ( scope.enableZoom ) handleTouchMoveDolly( event );
  579. if ( scope.enableRotate ) handleTouchMoveRotate( event );
  580. }
  581. //
  582. // event handlers - FSM: listen for events and reset state
  583. //
  584. function onPointerDown( event ) {
  585. if ( scope.enabled === false ) return;
  586. if ( pointers.length === 0 ) {
  587. scope.domElement.setPointerCapture( event.pointerId );
  588. scope.domElement.addEventListener( 'pointermove', onPointerMove );
  589. scope.domElement.addEventListener( 'pointerup', onPointerUp );
  590. }
  591. //
  592. addPointer( event );
  593. if ( event.pointerType === 'touch' ) {
  594. onTouchStart( event );
  595. } else {
  596. onMouseDown( event );
  597. }
  598. }
  599. function onPointerMove( event ) {
  600. if ( scope.enabled === false ) return;
  601. if ( event.pointerType === 'touch' ) {
  602. onTouchMove( event );
  603. } else {
  604. onMouseMove( event );
  605. }
  606. }
  607. function onPointerUp( event ) {
  608. removePointer( event );
  609. if ( pointers.length === 0 ) {
  610. scope.domElement.releasePointerCapture( event.pointerId );
  611. scope.domElement.removeEventListener( 'pointermove', onPointerMove );
  612. scope.domElement.removeEventListener( 'pointerup', onPointerUp );
  613. }
  614. scope.dispatchEvent( _endEvent );
  615. state = STATE.NONE;
  616. }
  617. function onMouseDown( event ) {
  618. let mouseAction;
  619. switch ( event.button ) {
  620. case 0:
  621. mouseAction = scope.mouseButtons.LEFT;
  622. break;
  623. case 1:
  624. mouseAction = scope.mouseButtons.MIDDLE;
  625. break;
  626. case 2:
  627. mouseAction = scope.mouseButtons.RIGHT;
  628. break;
  629. default:
  630. mouseAction = - 1;
  631. }
  632. switch ( mouseAction ) {
  633. case MOUSE.DOLLY:
  634. if ( scope.enableZoom === false ) return;
  635. handleMouseDownDolly( event );
  636. state = STATE.DOLLY;
  637. break;
  638. case MOUSE.ROTATE:
  639. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  640. if ( scope.enablePan === false ) return;
  641. handleMouseDownPan( event );
  642. state = STATE.PAN;
  643. } else {
  644. if ( scope.enableRotate === false ) return;
  645. handleMouseDownRotate( event );
  646. state = STATE.ROTATE;
  647. }
  648. break;
  649. case MOUSE.PAN:
  650. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  651. if ( scope.enableRotate === false ) return;
  652. handleMouseDownRotate( event );
  653. state = STATE.ROTATE;
  654. } else {
  655. if ( scope.enablePan === false ) return;
  656. handleMouseDownPan( event );
  657. state = STATE.PAN;
  658. }
  659. break;
  660. default:
  661. state = STATE.NONE;
  662. }
  663. if ( state !== STATE.NONE ) {
  664. scope.dispatchEvent( _startEvent );
  665. }
  666. }
  667. function onMouseMove( event ) {
  668. switch ( state ) {
  669. case STATE.ROTATE:
  670. if ( scope.enableRotate === false ) return;
  671. handleMouseMoveRotate( event );
  672. break;
  673. case STATE.DOLLY:
  674. if ( scope.enableZoom === false ) return;
  675. handleMouseMoveDolly( event );
  676. break;
  677. case STATE.PAN:
  678. if ( scope.enablePan === false ) return;
  679. handleMouseMovePan( event );
  680. break;
  681. }
  682. }
  683. function onMouseWheel( event ) {
  684. if ( scope.enabled === false || scope.enableZoom === false || state !== STATE.NONE ) return;
  685. event.preventDefault();
  686. scope.dispatchEvent( _startEvent );
  687. handleMouseWheel( event );
  688. scope.dispatchEvent( _endEvent );
  689. }
  690. function onKeyDown( event ) {
  691. if ( scope.enabled === false || scope.enablePan === false ) return;
  692. handleKeyDown( event );
  693. }
  694. function onTouchStart( event ) {
  695. trackPointer( event );
  696. switch ( pointers.length ) {
  697. case 1:
  698. switch ( scope.touches.ONE ) {
  699. case TOUCH.ROTATE:
  700. if ( scope.enableRotate === false ) return;
  701. handleTouchStartRotate();
  702. state = STATE.TOUCH_ROTATE;
  703. break;
  704. case TOUCH.PAN:
  705. if ( scope.enablePan === false ) return;
  706. handleTouchStartPan();
  707. state = STATE.TOUCH_PAN;
  708. break;
  709. default:
  710. state = STATE.NONE;
  711. }
  712. break;
  713. case 2:
  714. switch ( scope.touches.TWO ) {
  715. case TOUCH.DOLLY_PAN:
  716. if ( scope.enableZoom === false && scope.enablePan === false ) return;
  717. handleTouchStartDollyPan();
  718. state = STATE.TOUCH_DOLLY_PAN;
  719. break;
  720. case TOUCH.DOLLY_ROTATE:
  721. if ( scope.enableZoom === false && scope.enableRotate === false ) return;
  722. handleTouchStartDollyRotate();
  723. state = STATE.TOUCH_DOLLY_ROTATE;
  724. break;
  725. default:
  726. state = STATE.NONE;
  727. }
  728. break;
  729. default:
  730. state = STATE.NONE;
  731. }
  732. if ( state !== STATE.NONE ) {
  733. scope.dispatchEvent( _startEvent );
  734. }
  735. }
  736. function onTouchMove( event ) {
  737. trackPointer( event );
  738. switch ( state ) {
  739. case STATE.TOUCH_ROTATE:
  740. if ( scope.enableRotate === false ) return;
  741. handleTouchMoveRotate( event );
  742. scope.update();
  743. break;
  744. case STATE.TOUCH_PAN:
  745. if ( scope.enablePan === false ) return;
  746. handleTouchMovePan( event );
  747. scope.update();
  748. break;
  749. case STATE.TOUCH_DOLLY_PAN:
  750. if ( scope.enableZoom === false && scope.enablePan === false ) return;
  751. handleTouchMoveDollyPan( event );
  752. scope.update();
  753. break;
  754. case STATE.TOUCH_DOLLY_ROTATE:
  755. if ( scope.enableZoom === false && scope.enableRotate === false ) return;
  756. handleTouchMoveDollyRotate( event );
  757. scope.update();
  758. break;
  759. default:
  760. state = STATE.NONE;
  761. }
  762. }
  763. function onContextMenu( event ) {
  764. if ( scope.enabled === false ) return;
  765. event.preventDefault();
  766. }
  767. function addPointer( event ) {
  768. pointers.push( event );
  769. }
  770. function removePointer( event ) {
  771. delete pointerPositions[ event.pointerId ];
  772. for ( let i = 0; i < pointers.length; i ++ ) {
  773. if ( pointers[ i ].pointerId == event.pointerId ) {
  774. pointers.splice( i, 1 );
  775. return;
  776. }
  777. }
  778. }
  779. function trackPointer( event ) {
  780. let position = pointerPositions[ event.pointerId ];
  781. if ( position === undefined ) {
  782. position = new Vector2();
  783. pointerPositions[ event.pointerId ] = position;
  784. }
  785. position.set( event.pageX, event.pageY );
  786. }
  787. function getSecondPointerPosition( event ) {
  788. const pointer = ( event.pointerId === pointers[ 0 ].pointerId ) ? pointers[ 1 ] : pointers[ 0 ];
  789. return pointerPositions[ pointer.pointerId ];
  790. }
  791. //
  792. scope.domElement.addEventListener( 'contextmenu', onContextMenu );
  793. scope.domElement.addEventListener( 'pointerdown', onPointerDown );
  794. scope.domElement.addEventListener( 'pointercancel', onPointerUp );
  795. scope.domElement.addEventListener( 'wheel', onMouseWheel, { passive: false } );
  796. // force an update at start
  797. this.update();
  798. }
  799. }
  800. export { OrbitControls };