scene.inputManager.ts 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887
  1. import { Observable, Observer } from '../Misc/observable';
  2. import { PointerInfoPre, PointerInfo, PointerEventTypes } from '../Events/pointerEvents';
  3. import { Nullable } from '../types';
  4. import { AbstractActionManager } from '../Actions/abstractActionManager';
  5. import { PickingInfo } from '../Collisions/pickingInfo';
  6. import { Vector2, Matrix } from '../Maths/math.vector';
  7. import { AbstractMesh } from '../Meshes/abstractMesh';
  8. import { Constants } from '../Engines/constants';
  9. import { ActionEvent } from '../Actions/actionEvent';
  10. import { Tools } from '../Misc/tools';
  11. import { Engine } from '../Engines/engine';
  12. import { KeyboardEventTypes, KeyboardInfoPre, KeyboardInfo } from '../Events/keyboardEvents';
  13. declare type Scene = import("../scene").Scene;
  14. /** @hidden */
  15. class _ClickInfo {
  16. private _singleClick = false;
  17. private _doubleClick = false;
  18. private _hasSwiped = false;
  19. private _ignore = false;
  20. public get singleClick(): boolean {
  21. return this._singleClick;
  22. }
  23. public get doubleClick(): boolean {
  24. return this._doubleClick;
  25. }
  26. public get hasSwiped(): boolean {
  27. return this._hasSwiped;
  28. }
  29. public get ignore(): boolean {
  30. return this._ignore;
  31. }
  32. public set singleClick(b: boolean) {
  33. this._singleClick = b;
  34. }
  35. public set doubleClick(b: boolean) {
  36. this._doubleClick = b;
  37. }
  38. public set hasSwiped(b: boolean) {
  39. this._hasSwiped = b;
  40. }
  41. public set ignore(b: boolean) {
  42. this._ignore = b;
  43. }
  44. }
  45. /**
  46. * Class used to manage all inputs for the scene.
  47. */
  48. export class InputManager {
  49. /** The distance in pixel that you have to move to prevent some events */
  50. public static DragMovementThreshold = 10; // in pixels
  51. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  52. public static LongPressDelay = 500; // in milliseconds
  53. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  54. public static DoubleClickDelay = 300; // in milliseconds
  55. /** If you need to check double click without raising a single click at first click, enable this flag */
  56. public static ExclusiveDoubleClickMode = false;
  57. // Pointers
  58. private _wheelEventName = "";
  59. private _onPointerMove: (evt: PointerEvent) => void;
  60. private _onPointerDown: (evt: PointerEvent) => void;
  61. private _onPointerUp: (evt: PointerEvent) => void;
  62. private _initClickEvent: (obs1: Observable<PointerInfoPre>, obs2: Observable<PointerInfo>, evt: PointerEvent, cb: (clickInfo: _ClickInfo, pickResult: Nullable<PickingInfo>) => void) => void;
  63. private _initActionManager: (act: Nullable<AbstractActionManager>, clickInfo: _ClickInfo) => Nullable<AbstractActionManager>;
  64. private _delayedSimpleClick: (btn: number, clickInfo: _ClickInfo, cb: (clickInfo: _ClickInfo, pickResult: Nullable<PickingInfo>) => void) => void;
  65. private _delayedSimpleClickTimeout: number;
  66. private _previousDelayedSimpleClickTimeout: number;
  67. private _meshPickProceed = false;
  68. private _previousButtonPressed: number;
  69. private _currentPickResult: Nullable<PickingInfo> = null;
  70. private _previousPickResult: Nullable<PickingInfo> = null;
  71. private _totalPointersPressed = 0;
  72. private _doubleClickOccured = false;
  73. private _pointerOverMesh: Nullable<AbstractMesh>;
  74. private _pickedDownMesh: Nullable<AbstractMesh>;
  75. private _pickedUpMesh: Nullable<AbstractMesh>;
  76. private _pointerX: number = 0;
  77. private _pointerY: number = 0;
  78. private _unTranslatedPointerX: number;
  79. private _unTranslatedPointerY: number;
  80. private _startingPointerPosition = new Vector2(0, 0);
  81. private _previousStartingPointerPosition = new Vector2(0, 0);
  82. private _startingPointerTime = 0;
  83. private _previousStartingPointerTime = 0;
  84. private _pointerCaptures: { [pointerId: number]: boolean } = {};
  85. // Keyboard
  86. private _onKeyDown: (evt: KeyboardEvent) => void;
  87. private _onKeyUp: (evt: KeyboardEvent) => void;
  88. private _onCanvasFocusObserver: Nullable<Observer<Engine>>;
  89. private _onCanvasBlurObserver: Nullable<Observer<Engine>>;
  90. private _scene: Scene;
  91. /**
  92. * Creates a new InputManager
  93. * @param scene defines the hosting scene
  94. */
  95. public constructor(scene: Scene) {
  96. this._scene = scene;
  97. }
  98. /**
  99. * Gets the mesh that is currently under the pointer
  100. */
  101. public get meshUnderPointer(): Nullable<AbstractMesh> {
  102. return this._pointerOverMesh;
  103. }
  104. /**
  105. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  106. */
  107. public get unTranslatedPointer(): Vector2 {
  108. return new Vector2(this._unTranslatedPointerX, this._unTranslatedPointerY);
  109. }
  110. /**
  111. * Gets or sets the current on-screen X position of the pointer
  112. */
  113. public get pointerX(): number {
  114. return this._pointerX;
  115. }
  116. public set pointerX(value: number) {
  117. this._pointerX = value;
  118. }
  119. /**
  120. * Gets or sets the current on-screen Y position of the pointer
  121. */
  122. public get pointerY(): number {
  123. return this._pointerY;
  124. }
  125. public set pointerY(value: number) {
  126. this._pointerY = value;
  127. }
  128. private _updatePointerPosition(evt: PointerEvent): void {
  129. var canvasRect = this._scene.getEngine().getInputElementClientRect();
  130. if (!canvasRect) {
  131. return;
  132. }
  133. this._pointerX = evt.clientX - canvasRect.left;
  134. this._pointerY = evt.clientY - canvasRect.top;
  135. this._unTranslatedPointerX = this._pointerX;
  136. this._unTranslatedPointerY = this._pointerY;
  137. }
  138. private _processPointerMove(pickResult: Nullable<PickingInfo>, evt: PointerEvent) {
  139. let scene = this._scene;
  140. var canvas = scene.getEngine().getInputElement();
  141. if (!canvas) {
  142. return;
  143. }
  144. canvas.tabIndex = 1;
  145. // Restore pointer
  146. if (!scene.doNotHandleCursors) {
  147. canvas.style.cursor = scene.defaultCursor;
  148. }
  149. var isMeshPicked = (pickResult && pickResult.hit && pickResult.pickedMesh) ? true : false;
  150. if (isMeshPicked) {
  151. scene.setPointerOverMesh(pickResult!.pickedMesh);
  152. if (this._pointerOverMesh && this._pointerOverMesh.actionManager && this._pointerOverMesh.actionManager.hasPointerTriggers) {
  153. if (!scene.doNotHandleCursors) {
  154. if (this._pointerOverMesh.actionManager.hoverCursor) {
  155. canvas.style.cursor = this._pointerOverMesh.actionManager.hoverCursor;
  156. } else {
  157. canvas.style.cursor = scene.hoverCursor;
  158. }
  159. }
  160. }
  161. } else {
  162. scene.setPointerOverMesh(null);
  163. }
  164. for (let step of scene._pointerMoveStage) {
  165. pickResult = step.action(this._unTranslatedPointerX, this._unTranslatedPointerY, pickResult, isMeshPicked, canvas);
  166. }
  167. if (pickResult) {
  168. let type = evt.type === this._wheelEventName ? PointerEventTypes.POINTERWHEEL : PointerEventTypes.POINTERMOVE;
  169. if (scene.onPointerMove) {
  170. scene.onPointerMove(evt, pickResult, type);
  171. }
  172. if (scene.onPointerObservable.hasObservers()) {
  173. let pi = new PointerInfo(type, evt, pickResult);
  174. this._setRayOnPointerInfo(pi);
  175. scene.onPointerObservable.notifyObservers(pi, type);
  176. }
  177. }
  178. }
  179. // Pointers handling
  180. private _setRayOnPointerInfo(pointerInfo: PointerInfo) {
  181. let scene = this._scene;
  182. if (pointerInfo.pickInfo && !pointerInfo.pickInfo._pickingUnavailable) {
  183. if (!pointerInfo.pickInfo.ray) {
  184. pointerInfo.pickInfo.ray = scene.createPickingRay(pointerInfo.event.offsetX, pointerInfo.event.offsetY, Matrix.Identity(), scene.activeCamera);
  185. }
  186. }
  187. }
  188. private _checkPrePointerObservable(pickResult: Nullable<PickingInfo>, evt: PointerEvent, type: number) {
  189. let scene = this._scene;
  190. let pi = new PointerInfoPre(type, evt, this._unTranslatedPointerX, this._unTranslatedPointerY);
  191. if (pickResult) {
  192. pi.ray = pickResult.ray;
  193. }
  194. scene.onPrePointerObservable.notifyObservers(pi, type);
  195. if (pi.skipOnPointerObservable) {
  196. return true;
  197. } else {
  198. return false;
  199. }
  200. }
  201. /**
  202. * Use this method to simulate a pointer move on a mesh
  203. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  204. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  205. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  206. */
  207. public simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void {
  208. let evt = new PointerEvent("pointermove", pointerEventInit);
  209. if (this._checkPrePointerObservable(pickResult, evt, PointerEventTypes.POINTERMOVE)) {
  210. return;
  211. }
  212. this._processPointerMove(pickResult, evt);
  213. }
  214. /**
  215. * Use this method to simulate a pointer down on a mesh
  216. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  217. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  218. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  219. */
  220. public simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void {
  221. let evt = new PointerEvent("pointerdown", pointerEventInit);
  222. if (this._checkPrePointerObservable(pickResult, evt, PointerEventTypes.POINTERDOWN)) {
  223. return;
  224. }
  225. this._processPointerDown(pickResult, evt);
  226. }
  227. private _processPointerDown(pickResult: Nullable<PickingInfo>, evt: PointerEvent): void {
  228. let scene = this._scene;
  229. if (pickResult && pickResult.hit && pickResult.pickedMesh) {
  230. this._pickedDownMesh = pickResult.pickedMesh;
  231. var actionManager = pickResult.pickedMesh._getActionManagerForTrigger();
  232. if (actionManager) {
  233. if (actionManager.hasPickTriggers) {
  234. actionManager.processTrigger(Constants.ACTION_OnPickDownTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  235. switch (evt.button) {
  236. case 0:
  237. actionManager.processTrigger(Constants.ACTION_OnLeftPickTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  238. break;
  239. case 1:
  240. actionManager.processTrigger(Constants.ACTION_OnCenterPickTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  241. break;
  242. case 2:
  243. actionManager.processTrigger(Constants.ACTION_OnRightPickTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  244. break;
  245. }
  246. }
  247. if (actionManager.hasSpecificTrigger(Constants.ACTION_OnLongPressTrigger)) {
  248. window.setTimeout(() => {
  249. var pickResult = scene.pick(this._unTranslatedPointerX, this._unTranslatedPointerY,
  250. (mesh: AbstractMesh): boolean => (<boolean>(mesh.isPickable && mesh.isVisible && mesh.isReady() && mesh.actionManager && mesh.actionManager.hasSpecificTrigger(Constants.ACTION_OnLongPressTrigger) && mesh == this._pickedDownMesh)),
  251. false, scene.cameraToUseForPointers);
  252. if (pickResult && pickResult.hit && pickResult.pickedMesh && actionManager) {
  253. if (this._totalPointersPressed !== 0 &&
  254. ((Date.now() - this._startingPointerTime) > InputManager.LongPressDelay) &&
  255. !this._isPointerSwiping()) {
  256. this._startingPointerTime = 0;
  257. actionManager.processTrigger(Constants.ACTION_OnLongPressTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  258. }
  259. }
  260. }, InputManager.LongPressDelay);
  261. }
  262. }
  263. }
  264. else {
  265. for (let step of scene._pointerDownStage) {
  266. pickResult = step.action(this._unTranslatedPointerX, this._unTranslatedPointerY, pickResult, evt);
  267. }
  268. }
  269. if (pickResult) {
  270. let type = PointerEventTypes.POINTERDOWN;
  271. if (scene.onPointerDown) {
  272. scene.onPointerDown(evt, pickResult, type);
  273. }
  274. if (scene.onPointerObservable.hasObservers()) {
  275. let pi = new PointerInfo(type, evt, pickResult);
  276. this._setRayOnPointerInfo(pi);
  277. scene.onPointerObservable.notifyObservers(pi, type);
  278. }
  279. }
  280. }
  281. /** @hidden */
  282. public _isPointerSwiping(): boolean {
  283. return Math.abs(this._startingPointerPosition.x - this._pointerX) > InputManager.DragMovementThreshold ||
  284. Math.abs(this._startingPointerPosition.y - this._pointerY) > InputManager.DragMovementThreshold;
  285. }
  286. /**
  287. * Use this method to simulate a pointer up on a mesh
  288. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  289. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  290. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  291. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  292. */
  293. public simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void {
  294. let evt = new PointerEvent("pointerup", pointerEventInit);
  295. let clickInfo = new _ClickInfo();
  296. if (doubleTap) {
  297. clickInfo.doubleClick = true;
  298. } else {
  299. clickInfo.singleClick = true;
  300. }
  301. if (this._checkPrePointerObservable(pickResult, evt, PointerEventTypes.POINTERUP)) {
  302. return;
  303. }
  304. this._processPointerUp(pickResult, evt, clickInfo);
  305. }
  306. private _processPointerUp(pickResult: Nullable<PickingInfo>, evt: PointerEvent, clickInfo: _ClickInfo): void {
  307. let scene = this._scene;
  308. if (pickResult && pickResult && pickResult.pickedMesh) {
  309. this._pickedUpMesh = pickResult.pickedMesh;
  310. if (this._pickedDownMesh === this._pickedUpMesh) {
  311. if (scene.onPointerPick) {
  312. scene.onPointerPick(evt, pickResult);
  313. }
  314. if (clickInfo.singleClick && !clickInfo.ignore && scene.onPointerObservable.hasObservers()) {
  315. let type = PointerEventTypes.POINTERPICK;
  316. let pi = new PointerInfo(type, evt, pickResult);
  317. this._setRayOnPointerInfo(pi);
  318. scene.onPointerObservable.notifyObservers(pi, type);
  319. }
  320. }
  321. let actionManager = pickResult.pickedMesh._getActionManagerForTrigger();
  322. if (actionManager && !clickInfo.ignore) {
  323. actionManager.processTrigger(Constants.ACTION_OnPickUpTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  324. if (!clickInfo.hasSwiped && clickInfo.singleClick) {
  325. actionManager.processTrigger(Constants.ACTION_OnPickTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  326. }
  327. let doubleClickActionManager = pickResult.pickedMesh._getActionManagerForTrigger(Constants.ACTION_OnDoublePickTrigger);
  328. if (clickInfo.doubleClick && doubleClickActionManager) {
  329. doubleClickActionManager.processTrigger(Constants.ACTION_OnDoublePickTrigger, ActionEvent.CreateNew(pickResult.pickedMesh, evt));
  330. }
  331. }
  332. }
  333. else {
  334. if (!clickInfo.ignore) {
  335. for (let step of scene._pointerUpStage) {
  336. pickResult = step.action(this._unTranslatedPointerX, this._unTranslatedPointerY, pickResult, evt);
  337. }
  338. }
  339. }
  340. if (this._pickedDownMesh && this._pickedDownMesh !== this._pickedUpMesh) {
  341. let pickedDownActionManager = this._pickedDownMesh._getActionManagerForTrigger(Constants.ACTION_OnPickOutTrigger);
  342. if (pickedDownActionManager) {
  343. pickedDownActionManager.processTrigger(Constants.ACTION_OnPickOutTrigger, ActionEvent.CreateNew(this._pickedDownMesh, evt));
  344. }
  345. }
  346. let type = 0;
  347. if (scene.onPointerObservable.hasObservers()) {
  348. if (!clickInfo.ignore && !clickInfo.hasSwiped) {
  349. if (clickInfo.singleClick && scene.onPointerObservable.hasSpecificMask(PointerEventTypes.POINTERTAP)) {
  350. type = PointerEventTypes.POINTERTAP;
  351. }
  352. else if (clickInfo.doubleClick && scene.onPointerObservable.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP)) {
  353. type = PointerEventTypes.POINTERDOUBLETAP;
  354. }
  355. if (type) {
  356. let pi = new PointerInfo(type, evt, pickResult);
  357. this._setRayOnPointerInfo(pi);
  358. scene.onPointerObservable.notifyObservers(pi, type);
  359. }
  360. }
  361. if (!clickInfo.ignore) {
  362. type = PointerEventTypes.POINTERUP;
  363. let pi = new PointerInfo(type, evt, pickResult);
  364. this._setRayOnPointerInfo(pi);
  365. scene.onPointerObservable.notifyObservers(pi, type);
  366. }
  367. }
  368. if (scene.onPointerUp && !clickInfo.ignore) {
  369. scene.onPointerUp(evt, pickResult, type);
  370. }
  371. }
  372. /**
  373. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  374. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  375. * @returns true if the pointer was captured
  376. */
  377. public isPointerCaptured(pointerId = 0): boolean {
  378. return this._pointerCaptures[pointerId];
  379. }
  380. /**
  381. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  382. * @param attachUp defines if you want to attach events to pointerup
  383. * @param attachDown defines if you want to attach events to pointerdown
  384. * @param attachMove defines if you want to attach events to pointermove
  385. */
  386. public attachControl(attachUp = true, attachDown = true, attachMove = true): void {
  387. let scene = this._scene;
  388. var canvas = scene.getEngine().getInputElement();
  389. if (!canvas) {
  390. return;
  391. }
  392. let engine = scene.getEngine();
  393. this._initActionManager = (act: Nullable<AbstractActionManager>, clickInfo: _ClickInfo): Nullable<AbstractActionManager> => {
  394. if (!this._meshPickProceed) {
  395. let pickResult = scene.pick(this._unTranslatedPointerX, this._unTranslatedPointerY, scene.pointerDownPredicate, false, scene.cameraToUseForPointers);
  396. this._currentPickResult = pickResult;
  397. if (pickResult) {
  398. act = (pickResult.hit && pickResult.pickedMesh) ? pickResult.pickedMesh._getActionManagerForTrigger() : null;
  399. }
  400. this._meshPickProceed = true;
  401. }
  402. return act;
  403. };
  404. this._delayedSimpleClick = (btn: number, clickInfo: _ClickInfo, cb: (clickInfo: _ClickInfo, pickResult: Nullable<PickingInfo>) => void) => {
  405. // double click delay is over and that no double click has been raised since, or the 2 consecutive keys pressed are different
  406. if ((Date.now() - this._previousStartingPointerTime > InputManager.DoubleClickDelay && !this._doubleClickOccured) ||
  407. btn !== this._previousButtonPressed) {
  408. this._doubleClickOccured = false;
  409. clickInfo.singleClick = true;
  410. clickInfo.ignore = false;
  411. cb(clickInfo, this._currentPickResult);
  412. }
  413. };
  414. this._initClickEvent = (obs1: Observable<PointerInfoPre>, obs2: Observable<PointerInfo>, evt: PointerEvent, cb: (clickInfo: _ClickInfo, pickResult: Nullable<PickingInfo>) => void): void => {
  415. let clickInfo = new _ClickInfo();
  416. this._currentPickResult = null;
  417. let act: Nullable<AbstractActionManager> = null;
  418. let checkPicking = obs1.hasSpecificMask(PointerEventTypes.POINTERPICK) || obs2.hasSpecificMask(PointerEventTypes.POINTERPICK)
  419. || obs1.hasSpecificMask(PointerEventTypes.POINTERTAP) || obs2.hasSpecificMask(PointerEventTypes.POINTERTAP)
  420. || obs1.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP) || obs2.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP);
  421. if (!checkPicking && AbstractActionManager) {
  422. act = this._initActionManager(act, clickInfo);
  423. if (act) {
  424. checkPicking = act.hasPickTriggers;
  425. }
  426. }
  427. let needToIgnoreNext = false;
  428. if (checkPicking) {
  429. let btn = evt.button;
  430. clickInfo.hasSwiped = this._isPointerSwiping();
  431. if (!clickInfo.hasSwiped) {
  432. let checkSingleClickImmediately = !InputManager.ExclusiveDoubleClickMode;
  433. if (!checkSingleClickImmediately) {
  434. checkSingleClickImmediately = !obs1.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP) &&
  435. !obs2.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP);
  436. if (checkSingleClickImmediately && !AbstractActionManager.HasSpecificTrigger(Constants.ACTION_OnDoublePickTrigger)) {
  437. act = this._initActionManager(act, clickInfo);
  438. if (act) {
  439. checkSingleClickImmediately = !act.hasSpecificTrigger(Constants.ACTION_OnDoublePickTrigger);
  440. }
  441. }
  442. }
  443. if (checkSingleClickImmediately) {
  444. // single click detected if double click delay is over or two different successive keys pressed without exclusive double click or no double click required
  445. if (Date.now() - this._previousStartingPointerTime > InputManager.DoubleClickDelay ||
  446. btn !== this._previousButtonPressed) {
  447. clickInfo.singleClick = true;
  448. cb(clickInfo, this._currentPickResult);
  449. needToIgnoreNext = true;
  450. }
  451. }
  452. // at least one double click is required to be check and exclusive double click is enabled
  453. else {
  454. // wait that no double click has been raised during the double click delay
  455. this._previousDelayedSimpleClickTimeout = this._delayedSimpleClickTimeout;
  456. this._delayedSimpleClickTimeout = window.setTimeout(this._delayedSimpleClick.bind(this, btn, clickInfo, cb), InputManager.DoubleClickDelay);
  457. }
  458. let checkDoubleClick = obs1.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP) ||
  459. obs2.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP);
  460. if (!checkDoubleClick && AbstractActionManager.HasSpecificTrigger(Constants.ACTION_OnDoublePickTrigger)) {
  461. act = this._initActionManager(act, clickInfo);
  462. if (act) {
  463. checkDoubleClick = act.hasSpecificTrigger(Constants.ACTION_OnDoublePickTrigger);
  464. }
  465. }
  466. if (checkDoubleClick) {
  467. // two successive keys pressed are equal, double click delay is not over and double click has not just occurred
  468. if (btn === this._previousButtonPressed &&
  469. Date.now() - this._previousStartingPointerTime < InputManager.DoubleClickDelay &&
  470. !this._doubleClickOccured
  471. ) {
  472. // pointer has not moved for 2 clicks, it's a double click
  473. if (!clickInfo.hasSwiped &&
  474. !this._isPointerSwiping()) {
  475. this._previousStartingPointerTime = 0;
  476. this._doubleClickOccured = true;
  477. clickInfo.doubleClick = true;
  478. clickInfo.ignore = false;
  479. if (InputManager.ExclusiveDoubleClickMode && this._previousDelayedSimpleClickTimeout) {
  480. clearTimeout(this._previousDelayedSimpleClickTimeout);
  481. }
  482. this._previousDelayedSimpleClickTimeout = this._delayedSimpleClickTimeout;
  483. cb(clickInfo, this._currentPickResult);
  484. }
  485. // if the two successive clicks are too far, it's just two simple clicks
  486. else {
  487. this._doubleClickOccured = false;
  488. this._previousStartingPointerTime = this._startingPointerTime;
  489. this._previousStartingPointerPosition.x = this._startingPointerPosition.x;
  490. this._previousStartingPointerPosition.y = this._startingPointerPosition.y;
  491. this._previousButtonPressed = btn;
  492. if (InputManager.ExclusiveDoubleClickMode) {
  493. if (this._previousDelayedSimpleClickTimeout) {
  494. clearTimeout(this._previousDelayedSimpleClickTimeout);
  495. }
  496. this._previousDelayedSimpleClickTimeout = this._delayedSimpleClickTimeout;
  497. cb(clickInfo, this._previousPickResult);
  498. }
  499. else {
  500. cb(clickInfo, this._currentPickResult);
  501. }
  502. }
  503. needToIgnoreNext = true;
  504. }
  505. // just the first click of the double has been raised
  506. else {
  507. this._doubleClickOccured = false;
  508. this._previousStartingPointerTime = this._startingPointerTime;
  509. this._previousStartingPointerPosition.x = this._startingPointerPosition.x;
  510. this._previousStartingPointerPosition.y = this._startingPointerPosition.y;
  511. this._previousButtonPressed = btn;
  512. }
  513. }
  514. }
  515. }
  516. if (!needToIgnoreNext) {
  517. cb(clickInfo, this._currentPickResult);
  518. }
  519. };
  520. this._onPointerMove = (evt: PointerEvent) => {
  521. this._updatePointerPosition(evt);
  522. // PreObservable support
  523. if (this._checkPrePointerObservable(null, evt, evt.type === this._wheelEventName ? PointerEventTypes.POINTERWHEEL : PointerEventTypes.POINTERMOVE)) {
  524. return;
  525. }
  526. if (!scene.cameraToUseForPointers && !scene.activeCamera) {
  527. return;
  528. }
  529. if (!scene.pointerMovePredicate) {
  530. scene.pointerMovePredicate = (mesh: AbstractMesh): boolean => (mesh.isPickable && mesh.isVisible && mesh.isReady() && mesh.isEnabled() && (mesh.enablePointerMoveEvents || scene.constantlyUpdateMeshUnderPointer || (mesh._getActionManagerForTrigger() != null)) && (!scene.cameraToUseForPointers || (scene.cameraToUseForPointers.layerMask & mesh.layerMask) !== 0));
  531. }
  532. // Meshes
  533. var pickResult = scene.pick(this._unTranslatedPointerX, this._unTranslatedPointerY, scene.pointerMovePredicate, false, scene.cameraToUseForPointers);
  534. this._processPointerMove(pickResult, evt);
  535. };
  536. this._onPointerDown = (evt: PointerEvent) => {
  537. this._totalPointersPressed++;
  538. this._pickedDownMesh = null;
  539. this._meshPickProceed = false;
  540. this._updatePointerPosition(evt);
  541. if (scene.preventDefaultOnPointerDown && canvas) {
  542. evt.preventDefault();
  543. canvas.focus();
  544. }
  545. this._startingPointerPosition.x = this._pointerX;
  546. this._startingPointerPosition.y = this._pointerY;
  547. this._startingPointerTime = Date.now();
  548. // PreObservable support
  549. if (this._checkPrePointerObservable(null, evt, PointerEventTypes.POINTERDOWN)) {
  550. return;
  551. }
  552. if (!scene.cameraToUseForPointers && !scene.activeCamera) {
  553. return;
  554. }
  555. this._pointerCaptures[evt.pointerId] = true;
  556. if (!scene.pointerDownPredicate) {
  557. scene.pointerDownPredicate = (mesh: AbstractMesh): boolean => {
  558. return mesh.isPickable && mesh.isVisible && mesh.isReady() && mesh.isEnabled() && (!scene.cameraToUseForPointers || (scene.cameraToUseForPointers.layerMask & mesh.layerMask) !== 0);
  559. };
  560. }
  561. // Meshes
  562. this._pickedDownMesh = null;
  563. var pickResult = scene.pick(this._unTranslatedPointerX, this._unTranslatedPointerY, scene.pointerDownPredicate, false, scene.cameraToUseForPointers);
  564. this._processPointerDown(pickResult, evt);
  565. };
  566. this._onPointerUp = (evt: PointerEvent) => {
  567. if (this._totalPointersPressed === 0) { // We are attaching the pointer up to windows because of a bug in FF
  568. return; // So we need to test it the pointer down was pressed before.
  569. }
  570. this._totalPointersPressed--;
  571. this._pickedUpMesh = null;
  572. this._meshPickProceed = false;
  573. this._updatePointerPosition(evt);
  574. if (scene.preventDefaultOnPointerUp && canvas) {
  575. evt.preventDefault();
  576. canvas.focus();
  577. }
  578. this._initClickEvent(scene.onPrePointerObservable, scene.onPointerObservable, evt, (clickInfo: _ClickInfo, pickResult: Nullable<PickingInfo>) => {
  579. // PreObservable support
  580. if (scene.onPrePointerObservable.hasObservers()) {
  581. if (!clickInfo.ignore) {
  582. if (!clickInfo.hasSwiped) {
  583. if (clickInfo.singleClick && scene.onPrePointerObservable.hasSpecificMask(PointerEventTypes.POINTERTAP)) {
  584. if (this._checkPrePointerObservable(null, evt, PointerEventTypes.POINTERTAP)) {
  585. return;
  586. }
  587. }
  588. if (clickInfo.doubleClick && scene.onPrePointerObservable.hasSpecificMask(PointerEventTypes.POINTERDOUBLETAP)) {
  589. if (this._checkPrePointerObservable(null, evt, PointerEventTypes.POINTERDOUBLETAP)) {
  590. return;
  591. }
  592. }
  593. }
  594. if (this._checkPrePointerObservable(null, evt, PointerEventTypes.POINTERUP)) {
  595. return;
  596. }
  597. }
  598. }
  599. if (!this._pointerCaptures[evt.pointerId]) {
  600. return;
  601. }
  602. this._pointerCaptures[evt.pointerId] = false;
  603. if (!scene.cameraToUseForPointers && !scene.activeCamera) {
  604. return;
  605. }
  606. if (!scene.pointerUpPredicate) {
  607. scene.pointerUpPredicate = (mesh: AbstractMesh): boolean => {
  608. return mesh.isPickable && mesh.isVisible && mesh.isReady() && mesh.isEnabled() && (!scene.cameraToUseForPointers || (scene.cameraToUseForPointers.layerMask & mesh.layerMask) !== 0);
  609. };
  610. }
  611. // Meshes
  612. if (!this._meshPickProceed && (AbstractActionManager && AbstractActionManager.HasTriggers || scene.onPointerObservable.hasObservers())) {
  613. this._initActionManager(null, clickInfo);
  614. }
  615. if (!pickResult) {
  616. pickResult = this._currentPickResult;
  617. }
  618. this._processPointerUp(pickResult, evt, clickInfo);
  619. this._previousPickResult = this._currentPickResult;
  620. });
  621. };
  622. this._onKeyDown = (evt: KeyboardEvent) => {
  623. let type = KeyboardEventTypes.KEYDOWN;
  624. if (scene.onPreKeyboardObservable.hasObservers()) {
  625. let pi = new KeyboardInfoPre(type, evt);
  626. scene.onPreKeyboardObservable.notifyObservers(pi, type);
  627. if (pi.skipOnPointerObservable) {
  628. return;
  629. }
  630. }
  631. if (scene.onKeyboardObservable.hasObservers()) {
  632. let pi = new KeyboardInfo(type, evt);
  633. scene.onKeyboardObservable.notifyObservers(pi, type);
  634. }
  635. if (scene.actionManager) {
  636. scene.actionManager.processTrigger(Constants.ACTION_OnKeyDownTrigger, ActionEvent.CreateNewFromScene(scene, evt));
  637. }
  638. };
  639. this._onKeyUp = (evt: KeyboardEvent) => {
  640. let type = KeyboardEventTypes.KEYUP;
  641. if (scene.onPreKeyboardObservable.hasObservers()) {
  642. let pi = new KeyboardInfoPre(type, evt);
  643. scene.onPreKeyboardObservable.notifyObservers(pi, type);
  644. if (pi.skipOnPointerObservable) {
  645. return;
  646. }
  647. }
  648. if (scene.onKeyboardObservable.hasObservers()) {
  649. let pi = new KeyboardInfo(type, evt);
  650. scene.onKeyboardObservable.notifyObservers(pi, type);
  651. }
  652. if (scene.actionManager) {
  653. scene.actionManager.processTrigger(Constants.ACTION_OnKeyUpTrigger, ActionEvent.CreateNewFromScene(scene, evt));
  654. }
  655. };
  656. // Keyboard events
  657. this._onCanvasFocusObserver = engine.onCanvasFocusObservable.add((() => {
  658. let fn = () => {
  659. if (!canvas) {
  660. return;
  661. }
  662. canvas.addEventListener("keydown", this._onKeyDown, false);
  663. canvas.addEventListener("keyup", this._onKeyUp, false);
  664. };
  665. if (document.activeElement === canvas) {
  666. fn();
  667. }
  668. return fn;
  669. })());
  670. this._onCanvasBlurObserver = engine.onCanvasBlurObservable.add(() => {
  671. if (!canvas) {
  672. return;
  673. }
  674. canvas.removeEventListener("keydown", this._onKeyDown);
  675. canvas.removeEventListener("keyup", this._onKeyUp);
  676. });
  677. // Pointer events
  678. var eventPrefix = Tools.GetPointerPrefix();
  679. if (attachMove) {
  680. canvas.addEventListener(eventPrefix + "move", <any>this._onPointerMove, false);
  681. // Wheel
  682. this._wheelEventName = "onwheel" in document.createElement("div") ? "wheel" : // Modern browsers support "wheel"
  683. (<any>document).onmousewheel !== undefined ? "mousewheel" : // Webkit and IE support at least "mousewheel"
  684. "DOMMouseScroll"; // let's assume that remaining browsers are older Firefox
  685. canvas.addEventListener(this._wheelEventName, <any>this._onPointerMove, false);
  686. }
  687. if (attachDown) {
  688. canvas.addEventListener(eventPrefix + "down", <any>this._onPointerDown, false);
  689. }
  690. if (attachUp) {
  691. let hostWindow = scene.getEngine().getHostWindow();
  692. if (hostWindow) {
  693. hostWindow.addEventListener(eventPrefix + "up", <any>this._onPointerUp, false);
  694. }
  695. }
  696. }
  697. /**
  698. * Detaches all event handlers
  699. */
  700. public detachControl() {
  701. const eventPrefix = Tools.GetPointerPrefix();
  702. const canvas = this._scene.getEngine().getInputElement();
  703. const engine = this._scene.getEngine();
  704. if (!canvas) {
  705. return;
  706. }
  707. // Pointer
  708. canvas.removeEventListener(eventPrefix + "move", <any>this._onPointerMove);
  709. canvas.removeEventListener(this._wheelEventName, <any>this._onPointerMove);
  710. canvas.removeEventListener(eventPrefix + "down", <any>this._onPointerDown);
  711. window.removeEventListener(eventPrefix + "up", <any>this._onPointerUp);
  712. // Blur / Focus
  713. if (this._onCanvasBlurObserver) {
  714. engine.onCanvasBlurObservable.remove(this._onCanvasBlurObserver);
  715. }
  716. if (this._onCanvasFocusObserver) {
  717. engine.onCanvasFocusObservable.remove(this._onCanvasFocusObserver);
  718. }
  719. // Keyboard
  720. canvas.removeEventListener("keydown", this._onKeyDown);
  721. canvas.removeEventListener("keyup", this._onKeyUp);
  722. // Cursor
  723. if (!this._scene.doNotHandleCursors) {
  724. canvas.style.cursor = this._scene.defaultCursor;
  725. }
  726. }
  727. /**
  728. * Force the value of meshUnderPointer
  729. * @param mesh defines the mesh to use
  730. */
  731. public setPointerOverMesh(mesh: Nullable<AbstractMesh>): void {
  732. if (this._pointerOverMesh === mesh) {
  733. return;
  734. }
  735. let actionManager: Nullable<AbstractActionManager>;
  736. if (this._pointerOverMesh) {
  737. actionManager = this._pointerOverMesh._getActionManagerForTrigger(Constants.ACTION_OnPointerOutTrigger);
  738. if (actionManager) {
  739. actionManager.processTrigger(Constants.ACTION_OnPointerOutTrigger, ActionEvent.CreateNew(this._pointerOverMesh));
  740. }
  741. }
  742. this._pointerOverMesh = mesh;
  743. if (this._pointerOverMesh) {
  744. actionManager = this._pointerOverMesh._getActionManagerForTrigger(Constants.ACTION_OnPointerOverTrigger);
  745. if (actionManager) {
  746. actionManager.processTrigger(Constants.ACTION_OnPointerOverTrigger, ActionEvent.CreateNew(this._pointerOverMesh));
  747. }
  748. }
  749. }
  750. /**
  751. * Gets the mesh under the pointer
  752. * @returns a Mesh or null if no mesh is under the pointer
  753. */
  754. public getPointerOverMesh(): Nullable<AbstractMesh> {
  755. return this._pointerOverMesh;
  756. }
  757. }