keyboardEvents.js 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. /**
  2. * Gather the list of keyboard event types as constants.
  3. */
  4. export class KeyboardEventTypes {
  5. }
  6. /**
  7. * The keydown event is fired when a key becomes active (pressed).
  8. */
  9. KeyboardEventTypes.KEYDOWN = 0x01;
  10. /**
  11. * The keyup event is fired when a key has been released.
  12. */
  13. KeyboardEventTypes.KEYUP = 0x02;
  14. /**
  15. * This class is used to store keyboard related info for the onKeyboardObservable event.
  16. */
  17. export class KeyboardInfo {
  18. /**
  19. * Instantiates a new keyboard info.
  20. * This class is used to store keyboard related info for the onKeyboardObservable event.
  21. * @param type Defines the type of event (KeyboardEventTypes)
  22. * @param event Defines the related dom event
  23. */
  24. constructor(
  25. /**
  26. * Defines the type of event (KeyboardEventTypes)
  27. */
  28. type,
  29. /**
  30. * Defines the related dom event
  31. */
  32. event) {
  33. this.type = type;
  34. this.event = event;
  35. }
  36. }
  37. /**
  38. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  39. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  40. */
  41. export class KeyboardInfoPre extends KeyboardInfo {
  42. /**
  43. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  44. * @deprecated use skipOnKeyboardObservable property instead
  45. */
  46. get skipOnPointerObservable() {
  47. return this.skipOnKeyboardObservable;
  48. }
  49. set skipOnPointerObservable(value) {
  50. this.skipOnKeyboardObservable = value;
  51. }
  52. /**
  53. * Instantiates a new keyboard pre info.
  54. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  55. * @param type Defines the type of event (KeyboardEventTypes)
  56. * @param event Defines the related dom event
  57. */
  58. constructor(
  59. /**
  60. * Defines the type of event (KeyboardEventTypes)
  61. */
  62. type,
  63. /**
  64. * Defines the related dom event
  65. */
  66. event) {
  67. super(type, event);
  68. this.type = type;
  69. this.event = event;
  70. this.skipOnKeyboardObservable = false;
  71. }
  72. }
  73. //# sourceMappingURL=keyboardEvents.js.map