FederatedMouseEvent.d.ts 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. import type { DisplayObject } from '../display-objects/DisplayObject';
  2. import { Point } from '../shapes/Point';
  3. import { FederatedEvent } from './FederatedEvent';
  4. export declare class FederatedMouseEvent extends FederatedEvent<MouseEvent | PointerEvent | TouchEvent> implements MouseEvent {
  5. /** Whether the "alt" key was pressed when this mouse event occurred. */
  6. altKey: boolean;
  7. /** The specific button that was pressed in this mouse event. */
  8. button: number;
  9. /** The button depressed when this event occurred. */
  10. buttons: number;
  11. /** Whether the "control" key was pressed when this mouse event occurred. */
  12. ctrlKey: boolean;
  13. /** Whether the "meta" key was pressed when this mouse event occurred. */
  14. metaKey: boolean;
  15. /** This is currently not implemented in the Federated Events API. */
  16. relatedTarget: DisplayObject | null;
  17. /** Whether the "shift" key was pressed when this mouse event occurred. */
  18. shiftKey: boolean;
  19. /**
  20. * The coordinates of the mouse event relative to the canvas.
  21. */
  22. client: Point;
  23. get clientX(): number;
  24. get clientY(): number;
  25. /**
  26. * The movement in this pointer relative to the last `mousemove` event.
  27. */
  28. movement: Point;
  29. get movementX(): number;
  30. get movementY(): number;
  31. /**
  32. * The offset of the pointer coordinates w.r.t. target DisplayObject in world space. This is
  33. * not supported at the moment.
  34. */
  35. offset: Point;
  36. get offsetX(): number;
  37. get offsetY(): number;
  38. /**
  39. * The pointer coordinates in world space.
  40. */
  41. global: Point;
  42. get globalX(): number;
  43. get globalY(): number;
  44. /**
  45. * The pointer coordinates in sceen space.
  46. */
  47. screen: Point;
  48. get screenX(): number;
  49. get screenY(): number;
  50. getModifierState(key: string): boolean;
  51. initMouseEvent(): void;
  52. }
  53. //# sourceMappingURL=FederatedMouseEvent.d.ts.map