OrbitControls.js 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506
  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. zoomChanged = scale !== 1;
  247. if ( zoomChanged ) {
  248. scope.object.zoom = Math.max( scope.minZoom, Math.min( scope.maxZoom, scope.object.zoom / scale ) );
  249. scope.object.updateProjectionMatrix();
  250. }
  251. }
  252. scale = 1;
  253. performCursorZoom = false;
  254. // update condition is:
  255. // min(camera displacement, camera rotation in radians)^2 > EPS
  256. // using small-angle approximation cos(x/2) = 1 - x^2 / 8
  257. if ( zoomChanged ||
  258. lastPosition.distanceToSquared( scope.object.position ) > EPS ||
  259. 8 * ( 1 - lastQuaternion.dot( scope.object.quaternion ) ) > EPS ||
  260. lastTargetPosition.distanceToSquared( scope.target ) > 0 ) {
  261. scope.dispatchEvent( _changeEvent );
  262. lastPosition.copy( scope.object.position );
  263. lastQuaternion.copy( scope.object.quaternion );
  264. lastTargetPosition.copy( scope.target );
  265. return true;
  266. }
  267. return false;
  268. };
  269. }();
  270. this.dispose = function () {
  271. scope.domElement.removeEventListener( 'contextmenu', onContextMenu );
  272. scope.domElement.removeEventListener( 'pointerdown', onPointerDown );
  273. scope.domElement.removeEventListener( 'pointercancel', onPointerUp );
  274. scope.domElement.removeEventListener( 'wheel', onMouseWheel );
  275. scope.domElement.removeEventListener( 'pointermove', onPointerMove );
  276. scope.domElement.removeEventListener( 'pointerup', onPointerUp );
  277. if ( scope._domElementKeyEvents !== null ) {
  278. scope._domElementKeyEvents.removeEventListener( 'keydown', onKeyDown );
  279. scope._domElementKeyEvents = null;
  280. }
  281. //scope.dispatchEvent( { type: 'dispose' } ); // should this be added here?
  282. };
  283. //
  284. // internals
  285. //
  286. const scope = this;
  287. const STATE = {
  288. NONE: - 1,
  289. ROTATE: 0,
  290. DOLLY: 1,
  291. PAN: 2,
  292. TOUCH_ROTATE: 3,
  293. TOUCH_PAN: 4,
  294. TOUCH_DOLLY_PAN: 5,
  295. TOUCH_DOLLY_ROTATE: 6
  296. };
  297. let state = STATE.NONE;
  298. const EPS = 0.000001;
  299. // current position in spherical coordinates
  300. const spherical = new Spherical();
  301. const sphericalDelta = new Spherical();
  302. let scale = 1;
  303. const panOffset = new Vector3();
  304. const rotateStart = new Vector2();
  305. const rotateEnd = new Vector2();
  306. const rotateDelta = new Vector2();
  307. const panStart = new Vector2();
  308. const panEnd = new Vector2();
  309. const panDelta = new Vector2();
  310. const dollyStart = new Vector2();
  311. const dollyEnd = new Vector2();
  312. const dollyDelta = new Vector2();
  313. const dollyDirection = new Vector3();
  314. const mouse = new Vector2();
  315. let performCursorZoom = false;
  316. const pointers = [];
  317. const pointerPositions = {};
  318. let controlActive = false;
  319. function getAutoRotationAngle( deltaTime ) {
  320. if ( deltaTime !== null ) {
  321. return ( 2 * Math.PI / 60 * scope.autoRotateSpeed ) * deltaTime;
  322. } else {
  323. return 2 * Math.PI / 60 / 60 * scope.autoRotateSpeed;
  324. }
  325. }
  326. function getZoomScale( delta ) {
  327. const normalizedDelta = Math.abs( delta * 0.01 );
  328. return Math.pow( 0.95, scope.zoomSpeed * normalizedDelta );
  329. }
  330. function rotateLeft( angle ) {
  331. sphericalDelta.theta -= angle;
  332. }
  333. function rotateUp( angle ) {
  334. sphericalDelta.phi -= angle;
  335. }
  336. const panLeft = function () {
  337. const v = new Vector3();
  338. return function panLeft( distance, objectMatrix ) {
  339. v.setFromMatrixColumn( objectMatrix, 0 ); // get X column of objectMatrix
  340. v.multiplyScalar( - distance );
  341. panOffset.add( v );
  342. };
  343. }();
  344. const panUp = function () {
  345. const v = new Vector3();
  346. return function panUp( distance, objectMatrix ) {
  347. if ( scope.screenSpacePanning === true ) {
  348. v.setFromMatrixColumn( objectMatrix, 1 );
  349. } else {
  350. v.setFromMatrixColumn( objectMatrix, 0 );
  351. v.crossVectors( scope.object.up, v );
  352. }
  353. v.multiplyScalar( distance );
  354. panOffset.add( v );
  355. };
  356. }();
  357. // deltaX and deltaY are in pixels; right and down are positive
  358. const pan = function () {
  359. const offset = new Vector3();
  360. return function pan( deltaX, deltaY ) {
  361. const element = scope.domElement;
  362. if ( scope.object.isPerspectiveCamera ) {
  363. // perspective
  364. const position = scope.object.position;
  365. offset.copy( position ).sub( scope.target );
  366. let targetDistance = offset.length();
  367. // half of the fov is center to top of screen
  368. targetDistance *= Math.tan( ( scope.object.fov / 2 ) * Math.PI / 180.0 );
  369. // we use only clientHeight here so aspect ratio does not distort speed
  370. panLeft( 2 * deltaX * targetDistance / element.clientHeight, scope.object.matrix );
  371. panUp( 2 * deltaY * targetDistance / element.clientHeight, scope.object.matrix );
  372. } else if ( scope.object.isOrthographicCamera ) {
  373. // orthographic
  374. panLeft( deltaX * ( scope.object.right - scope.object.left ) / scope.object.zoom / element.clientWidth, scope.object.matrix );
  375. panUp( deltaY * ( scope.object.top - scope.object.bottom ) / scope.object.zoom / element.clientHeight, scope.object.matrix );
  376. } else {
  377. // camera neither orthographic nor perspective
  378. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - pan disabled.' );
  379. scope.enablePan = false;
  380. }
  381. };
  382. }();
  383. function dollyOut( dollyScale ) {
  384. if ( scope.object.isPerspectiveCamera || scope.object.isOrthographicCamera ) {
  385. scale /= dollyScale;
  386. } else {
  387. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - dolly/zoom disabled.' );
  388. scope.enableZoom = false;
  389. }
  390. }
  391. function dollyIn( dollyScale ) {
  392. if ( scope.object.isPerspectiveCamera || scope.object.isOrthographicCamera ) {
  393. scale *= dollyScale;
  394. } else {
  395. console.warn( 'WARNING: OrbitControls.js encountered an unknown camera type - dolly/zoom disabled.' );
  396. scope.enableZoom = false;
  397. }
  398. }
  399. function updateZoomParameters( x, y ) {
  400. if ( ! scope.zoomToCursor ) {
  401. return;
  402. }
  403. performCursorZoom = true;
  404. const rect = scope.domElement.getBoundingClientRect();
  405. const dx = x - rect.left;
  406. const dy = y - rect.top;
  407. const w = rect.width;
  408. const h = rect.height;
  409. mouse.x = ( dx / w ) * 2 - 1;
  410. mouse.y = - ( dy / h ) * 2 + 1;
  411. dollyDirection.set( mouse.x, mouse.y, 1 ).unproject( scope.object ).sub( scope.object.position ).normalize();
  412. }
  413. function clampDistance( dist ) {
  414. return Math.max( scope.minDistance, Math.min( scope.maxDistance, dist ) );
  415. }
  416. //
  417. // event callbacks - update the object state
  418. //
  419. function handleMouseDownRotate( event ) {
  420. rotateStart.set( event.clientX, event.clientY );
  421. }
  422. function handleMouseDownDolly( event ) {
  423. updateZoomParameters( event.clientX, event.clientX );
  424. dollyStart.set( event.clientX, event.clientY );
  425. }
  426. function handleMouseDownPan( event ) {
  427. panStart.set( event.clientX, event.clientY );
  428. }
  429. function handleMouseMoveRotate( event ) {
  430. rotateEnd.set( event.clientX, event.clientY );
  431. rotateDelta.subVectors( rotateEnd, rotateStart ).multiplyScalar( scope.rotateSpeed );
  432. const element = scope.domElement;
  433. rotateLeft( 2 * Math.PI * rotateDelta.x / element.clientHeight ); // yes, height
  434. rotateUp( 2 * Math.PI * rotateDelta.y / element.clientHeight );
  435. rotateStart.copy( rotateEnd );
  436. scope.update();
  437. }
  438. function handleMouseMoveDolly( event ) {
  439. dollyEnd.set( event.clientX, event.clientY );
  440. dollyDelta.subVectors( dollyEnd, dollyStart );
  441. if ( dollyDelta.y > 0 ) {
  442. dollyOut( getZoomScale( dollyDelta.y ) );
  443. } else if ( dollyDelta.y < 0 ) {
  444. dollyIn( getZoomScale( dollyDelta.y ) );
  445. }
  446. dollyStart.copy( dollyEnd );
  447. scope.update();
  448. }
  449. function handleMouseMovePan( event ) {
  450. panEnd.set( event.clientX, event.clientY );
  451. panDelta.subVectors( panEnd, panStart ).multiplyScalar( scope.panSpeed );
  452. pan( panDelta.x, panDelta.y );
  453. panStart.copy( panEnd );
  454. scope.update();
  455. }
  456. function handleMouseWheel( event ) {
  457. updateZoomParameters( event.clientX, event.clientY );
  458. if ( event.deltaY < 0 ) {
  459. dollyIn( getZoomScale( event.deltaY ) );
  460. } else if ( event.deltaY > 0 ) {
  461. dollyOut( getZoomScale( event.deltaY ) );
  462. }
  463. scope.update();
  464. }
  465. function handleKeyDown( event ) {
  466. let needsUpdate = false;
  467. switch ( event.code ) {
  468. case scope.keys.UP:
  469. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  470. rotateUp( 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  471. } else {
  472. pan( 0, scope.keyPanSpeed );
  473. }
  474. needsUpdate = true;
  475. break;
  476. case scope.keys.BOTTOM:
  477. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  478. rotateUp( - 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  479. } else {
  480. pan( 0, - scope.keyPanSpeed );
  481. }
  482. needsUpdate = true;
  483. break;
  484. case scope.keys.LEFT:
  485. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  486. rotateLeft( 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  487. } else {
  488. pan( scope.keyPanSpeed, 0 );
  489. }
  490. needsUpdate = true;
  491. break;
  492. case scope.keys.RIGHT:
  493. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  494. rotateLeft( - 2 * Math.PI * scope.rotateSpeed / scope.domElement.clientHeight );
  495. } else {
  496. pan( - scope.keyPanSpeed, 0 );
  497. }
  498. needsUpdate = true;
  499. break;
  500. }
  501. if ( needsUpdate ) {
  502. // prevent the browser from scrolling on cursor keys
  503. event.preventDefault();
  504. scope.update();
  505. }
  506. }
  507. function handleTouchStartRotate( event ) {
  508. if ( pointers.length === 1 ) {
  509. rotateStart.set( event.pageX, event.pageY );
  510. } else {
  511. const position = getSecondPointerPosition( event );
  512. const x = 0.5 * ( event.pageX + position.x );
  513. const y = 0.5 * ( event.pageY + position.y );
  514. rotateStart.set( x, y );
  515. }
  516. }
  517. function handleTouchStartPan( event ) {
  518. if ( pointers.length === 1 ) {
  519. panStart.set( event.pageX, event.pageY );
  520. } else {
  521. const position = getSecondPointerPosition( event );
  522. const x = 0.5 * ( event.pageX + position.x );
  523. const y = 0.5 * ( event.pageY + position.y );
  524. panStart.set( x, y );
  525. }
  526. }
  527. function handleTouchStartDolly( event ) {
  528. const position = getSecondPointerPosition( event );
  529. const dx = event.pageX - position.x;
  530. const dy = event.pageY - position.y;
  531. const distance = Math.sqrt( dx * dx + dy * dy );
  532. dollyStart.set( 0, distance );
  533. }
  534. function handleTouchStartDollyPan( event ) {
  535. if ( scope.enableZoom ) handleTouchStartDolly( event );
  536. if ( scope.enablePan ) handleTouchStartPan( event );
  537. }
  538. function handleTouchStartDollyRotate( event ) {
  539. if ( scope.enableZoom ) handleTouchStartDolly( event );
  540. if ( scope.enableRotate ) handleTouchStartRotate( event );
  541. }
  542. function handleTouchMoveRotate( event ) {
  543. if ( pointers.length == 1 ) {
  544. rotateEnd.set( event.pageX, event.pageY );
  545. } else {
  546. const position = getSecondPointerPosition( event );
  547. const x = 0.5 * ( event.pageX + position.x );
  548. const y = 0.5 * ( event.pageY + position.y );
  549. rotateEnd.set( x, y );
  550. }
  551. rotateDelta.subVectors( rotateEnd, rotateStart ).multiplyScalar( scope.rotateSpeed );
  552. const element = scope.domElement;
  553. rotateLeft( 2 * Math.PI * rotateDelta.x / element.clientHeight ); // yes, height
  554. rotateUp( 2 * Math.PI * rotateDelta.y / element.clientHeight );
  555. rotateStart.copy( rotateEnd );
  556. }
  557. function handleTouchMovePan( event ) {
  558. if ( pointers.length === 1 ) {
  559. panEnd.set( event.pageX, event.pageY );
  560. } else {
  561. const position = getSecondPointerPosition( event );
  562. const x = 0.5 * ( event.pageX + position.x );
  563. const y = 0.5 * ( event.pageY + position.y );
  564. panEnd.set( x, y );
  565. }
  566. panDelta.subVectors( panEnd, panStart ).multiplyScalar( scope.panSpeed );
  567. pan( panDelta.x, panDelta.y );
  568. panStart.copy( panEnd );
  569. }
  570. function handleTouchMoveDolly( event ) {
  571. const position = getSecondPointerPosition( event );
  572. const dx = event.pageX - position.x;
  573. const dy = event.pageY - position.y;
  574. const distance = Math.sqrt( dx * dx + dy * dy );
  575. dollyEnd.set( 0, distance );
  576. dollyDelta.set( 0, Math.pow( dollyEnd.y / dollyStart.y, scope.zoomSpeed ) );
  577. dollyOut( dollyDelta.y );
  578. dollyStart.copy( dollyEnd );
  579. const centerX = ( event.pageX + position.x ) * 0.5;
  580. const centerY = ( event.pageY + position.y ) * 0.5;
  581. updateZoomParameters( centerX, centerY );
  582. }
  583. function handleTouchMoveDollyPan( event ) {
  584. if ( scope.enableZoom ) handleTouchMoveDolly( event );
  585. if ( scope.enablePan ) handleTouchMovePan( event );
  586. }
  587. function handleTouchMoveDollyRotate( event ) {
  588. if ( scope.enableZoom ) handleTouchMoveDolly( event );
  589. if ( scope.enableRotate ) handleTouchMoveRotate( event );
  590. }
  591. //
  592. // event handlers - FSM: listen for events and reset state
  593. //
  594. function onPointerDown( event ) {
  595. if ( scope.enabled === false ) return;
  596. if ( pointers.length === 0 ) {
  597. scope.domElement.setPointerCapture( event.pointerId );
  598. scope.domElement.addEventListener( 'pointermove', onPointerMove );
  599. scope.domElement.addEventListener( 'pointerup', onPointerUp );
  600. }
  601. //
  602. addPointer( event );
  603. if ( event.pointerType === 'touch' ) {
  604. onTouchStart( event );
  605. } else {
  606. onMouseDown( event );
  607. }
  608. }
  609. function onPointerMove( event ) {
  610. if ( scope.enabled === false ) return;
  611. if ( event.pointerType === 'touch' ) {
  612. onTouchMove( event );
  613. } else {
  614. onMouseMove( event );
  615. }
  616. }
  617. function onPointerUp( event ) {
  618. removePointer( event );
  619. switch ( pointers.length ) {
  620. case 0:
  621. scope.domElement.releasePointerCapture( event.pointerId );
  622. scope.domElement.removeEventListener( 'pointermove', onPointerMove );
  623. scope.domElement.removeEventListener( 'pointerup', onPointerUp );
  624. scope.dispatchEvent( _endEvent );
  625. state = STATE.NONE;
  626. break;
  627. case 1:
  628. const pointerId = pointers[ 0 ];
  629. const position = pointerPositions[ pointerId ];
  630. // minimal placeholder event - allows state correction on pointer-up
  631. onTouchStart( { pointerId: pointerId, pageX: position.x, pageY: position.y } );
  632. break;
  633. }
  634. }
  635. function onMouseDown( event ) {
  636. let mouseAction;
  637. switch ( event.button ) {
  638. case 0:
  639. mouseAction = scope.mouseButtons.LEFT;
  640. break;
  641. case 1:
  642. mouseAction = scope.mouseButtons.MIDDLE;
  643. break;
  644. case 2:
  645. mouseAction = scope.mouseButtons.RIGHT;
  646. break;
  647. default:
  648. mouseAction = - 1;
  649. }
  650. switch ( mouseAction ) {
  651. case MOUSE.DOLLY:
  652. if ( scope.enableZoom === false ) return;
  653. handleMouseDownDolly( event );
  654. state = STATE.DOLLY;
  655. break;
  656. case MOUSE.ROTATE:
  657. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  658. if ( scope.enablePan === false ) return;
  659. handleMouseDownPan( event );
  660. state = STATE.PAN;
  661. } else {
  662. if ( scope.enableRotate === false ) return;
  663. handleMouseDownRotate( event );
  664. state = STATE.ROTATE;
  665. }
  666. break;
  667. case MOUSE.PAN:
  668. if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
  669. if ( scope.enableRotate === false ) return;
  670. handleMouseDownRotate( event );
  671. state = STATE.ROTATE;
  672. } else {
  673. if ( scope.enablePan === false ) return;
  674. handleMouseDownPan( event );
  675. state = STATE.PAN;
  676. }
  677. break;
  678. default:
  679. state = STATE.NONE;
  680. }
  681. if ( state !== STATE.NONE ) {
  682. scope.dispatchEvent( _startEvent );
  683. }
  684. }
  685. function onMouseMove( event ) {
  686. switch ( state ) {
  687. case STATE.ROTATE:
  688. if ( scope.enableRotate === false ) return;
  689. handleMouseMoveRotate( event );
  690. break;
  691. case STATE.DOLLY:
  692. if ( scope.enableZoom === false ) return;
  693. handleMouseMoveDolly( event );
  694. break;
  695. case STATE.PAN:
  696. if ( scope.enablePan === false ) return;
  697. handleMouseMovePan( event );
  698. break;
  699. }
  700. }
  701. function onMouseWheel( event ) {
  702. if ( scope.enabled === false || scope.enableZoom === false || state !== STATE.NONE ) return;
  703. event.preventDefault();
  704. scope.dispatchEvent( _startEvent );
  705. handleMouseWheel( customWheelEvent( event ) );
  706. scope.dispatchEvent( _endEvent );
  707. }
  708. function customWheelEvent( event ) {
  709. const mode = event.deltaMode;
  710. // minimal wheel event altered to meet delta-zoom demand
  711. const newEvent = {
  712. clientX: event.clientX,
  713. clientY: event.clientY,
  714. deltaY: event.deltaY,
  715. };
  716. switch ( mode ) {
  717. case 1: // LINE_MODE
  718. newEvent.deltaY *= 16;
  719. break;
  720. case 2: // PAGE_MODE
  721. newEvent.deltaY *= 100;
  722. break;
  723. }
  724. // detect if event was triggered by pinching
  725. if ( event.ctrlKey && ! controlActive ) {
  726. newEvent.deltaY *= 10;
  727. }
  728. return newEvent;
  729. }
  730. function interceptControlDown( event ) {
  731. if ( event.key === 'Control' ) {
  732. controlActive = true;
  733. const document = scope.domElement.getRootNode(); // offscreen canvas compatibility
  734. document.addEventListener( 'keyup', interceptControlUp, { passive: true, capture: true } );
  735. }
  736. }
  737. function interceptControlUp( event ) {
  738. if ( event.key === 'Control' ) {
  739. controlActive = false;
  740. const document = scope.domElement.getRootNode(); // offscreen canvas compatibility
  741. document.removeEventListener( 'keyup', interceptControlUp, { passive: true, capture: true } );
  742. }
  743. }
  744. function onKeyDown( event ) {
  745. if ( scope.enabled === false || scope.enablePan === false ) return;
  746. handleKeyDown( event );
  747. }
  748. function onTouchStart( event ) {
  749. trackPointer( event );
  750. switch ( pointers.length ) {
  751. case 1:
  752. switch ( scope.touches.ONE ) {
  753. case TOUCH.ROTATE:
  754. if ( scope.enableRotate === false ) return;
  755. handleTouchStartRotate( event );
  756. state = STATE.TOUCH_ROTATE;
  757. break;
  758. case TOUCH.PAN:
  759. if ( scope.enablePan === false ) return;
  760. handleTouchStartPan( event );
  761. state = STATE.TOUCH_PAN;
  762. break;
  763. default:
  764. state = STATE.NONE;
  765. }
  766. break;
  767. case 2:
  768. switch ( scope.touches.TWO ) {
  769. case TOUCH.DOLLY_PAN:
  770. if ( scope.enableZoom === false && scope.enablePan === false ) return;
  771. handleTouchStartDollyPan( event );
  772. state = STATE.TOUCH_DOLLY_PAN;
  773. break;
  774. case TOUCH.DOLLY_ROTATE:
  775. if ( scope.enableZoom === false && scope.enableRotate === false ) return;
  776. handleTouchStartDollyRotate( event );
  777. state = STATE.TOUCH_DOLLY_ROTATE;
  778. break;
  779. default:
  780. state = STATE.NONE;
  781. }
  782. break;
  783. default:
  784. state = STATE.NONE;
  785. }
  786. if ( state !== STATE.NONE ) {
  787. scope.dispatchEvent( _startEvent );
  788. }
  789. }
  790. function onTouchMove( event ) {
  791. trackPointer( event );
  792. switch ( state ) {
  793. case STATE.TOUCH_ROTATE:
  794. if ( scope.enableRotate === false ) return;
  795. handleTouchMoveRotate( event );
  796. scope.update();
  797. break;
  798. case STATE.TOUCH_PAN:
  799. if ( scope.enablePan === false ) return;
  800. handleTouchMovePan( event );
  801. scope.update();
  802. break;
  803. case STATE.TOUCH_DOLLY_PAN:
  804. if ( scope.enableZoom === false && scope.enablePan === false ) return;
  805. handleTouchMoveDollyPan( event );
  806. scope.update();
  807. break;
  808. case STATE.TOUCH_DOLLY_ROTATE:
  809. if ( scope.enableZoom === false && scope.enableRotate === false ) return;
  810. handleTouchMoveDollyRotate( event );
  811. scope.update();
  812. break;
  813. default:
  814. state = STATE.NONE;
  815. }
  816. }
  817. function onContextMenu( event ) {
  818. if ( scope.enabled === false ) return;
  819. event.preventDefault();
  820. }
  821. function addPointer( event ) {
  822. pointers.push( event.pointerId );
  823. }
  824. function removePointer( event ) {
  825. delete pointerPositions[ event.pointerId ];
  826. for ( let i = 0; i < pointers.length; i ++ ) {
  827. if ( pointers[ i ] == event.pointerId ) {
  828. pointers.splice( i, 1 );
  829. return;
  830. }
  831. }
  832. }
  833. function trackPointer( event ) {
  834. let position = pointerPositions[ event.pointerId ];
  835. if ( position === undefined ) {
  836. position = new Vector2();
  837. pointerPositions[ event.pointerId ] = position;
  838. }
  839. position.set( event.pageX, event.pageY );
  840. }
  841. function getSecondPointerPosition( event ) {
  842. const pointerId = ( event.pointerId === pointers[ 0 ] ) ? pointers[ 1 ] : pointers[ 0 ];
  843. return pointerPositions[ pointerId ];
  844. }
  845. //
  846. scope.domElement.addEventListener( 'contextmenu', onContextMenu );
  847. scope.domElement.addEventListener( 'pointerdown', onPointerDown );
  848. scope.domElement.addEventListener( 'pointercancel', onPointerUp );
  849. scope.domElement.addEventListener( 'wheel', onMouseWheel, { passive: false } );
  850. const document = scope.domElement.getRootNode(); // offscreen canvas compatibility
  851. document.addEventListener( 'keydown', interceptControlDown, { passive: true, capture: true } );
  852. // force an update at start
  853. this.update();
  854. }
  855. }
  856. export { OrbitControls };