Implement screenX/screenY properties on the PointerEvent interface

Summary:
Changelog: [iOS][Internal] - Implement screenX/screenY properties on the PointerEvent interface

This diff implements the screenX/screenY properties which report the position of a pointer in the device's physical screen coordinates.

Reviewed By: lunaleaps

Differential Revision: D37794415

fbshipit-source-id: 6c39c3651812f99e66b93647579a2935598ef6f2

Author: vincentriemer

React/Fabric/RCTSurfaceTouchHandler.mm

@@ -156,8 +156,10 @@ static void UpdateActiveTouchWithUITouch(
     CGPoint rootViewOriginOffset)
 {
   CGPoint offsetPoint = [uiTouch locationInView:activeTouch.componentView];
-  CGPoint screenPoint = [uiTouch locationInView:uiTouch.window];
   CGPoint pagePoint = [uiTouch locationInView:rootComponentView];
+  CGPoint screenPoint = [rootComponentView convertPoint:pagePoint
+                                      toCoordinateSpace:rootComponentView.window.screen.coordinateSpace];
+
   pagePoint = CGPointMake(pagePoint.x + rootViewOriginOffset.x, pagePoint.y + rootViewOriginOffset.y);
 
   activeTouch.touch.offsetPoint = RCTPointFromCGPoint(offsetPoint);
@@ -255,6 +257,7 @@ static PointerEvent CreatePointerEventFromActiveTouch(ActiveTouch activeTouch, R
   event.pressure = touch.force;
   event.pointerType = PointerTypeCStringFromUITouchType(activeTouch.touchType);
   event.clientPoint = touch.pagePoint;
+  event.screenPoint = touch.screenPoint;
 
   CGFloat pointerSize = activeTouch.majorRadius * 2.0;
   if (@available(iOS 13.4, *)) {
@@ -285,8 +288,11 @@ static PointerEvent CreatePointerEventFromActiveTouch(ActiveTouch activeTouch, R
   return event;
 }
 
-static PointerEvent
-CreatePointerEventFromIncompleteHoverData(UIView *view, CGPoint clientLocation, NSTimeInterval timestamp)
+static PointerEvent CreatePointerEventFromIncompleteHoverData(
+    UIView *view,
+    CGPoint clientLocation,
+    CGPoint screenLocation,
+    NSTimeInterval timestamp)
 {
   PointerEvent event = {};
   // "touch" events produced from a mouse cursor on iOS always have the ID 0 so
@@ -296,6 +302,7 @@ static PointerEvent CreatePointerEventFromActiveTouch(ActiveTouch activeTouch, R
   event.pressure = 0.0;
   event.pointerType = "mouse";
   event.clientPoint = RCTPointFromCGPoint(clientLocation);
+  event.screenPoint = RCTPointFromCGPoint(screenLocation);
   event.width = 1.0;
   event.height = 1.0;
   event.tiltX = 0;
@@ -676,6 +683,8 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
 {
   UIView *listenerView = recognizer.view;
   CGPoint clientLocation = [recognizer locationInView:listenerView];
+  CGPoint screenLocation = [listenerView convertPoint:clientLocation
+                                    toCoordinateSpace:listenerView.window.screen.coordinateSpace];
 
   UIView *targetView = [listenerView hitTest:clientLocation withEvent:nil];
   targetView = FindClosestFabricManagedTouchableView(targetView);
@@ -692,7 +701,8 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
     BOOL shouldEmitOverEvent = IsAnyViewInPathListeningToEvent(eventPathViews, ViewEvents::Offset::PointerOver);
     SharedTouchEventEmitter eventEmitter = GetTouchEmitterFromView(targetView, [recognizer locationInView:targetView]);
     if (shouldEmitOverEvent && eventEmitter != nil) {
-      PointerEvent event = CreatePointerEventFromIncompleteHoverData(targetView, clientLocation, timestamp);
+      PointerEvent event =
+          CreatePointerEventFromIncompleteHoverData(targetView, clientLocation, screenLocation, timestamp);
       eventEmitter->onPointerOver(event);
     }
   }
@@ -714,7 +724,8 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
       SharedTouchEventEmitter eventEmitter =
           GetTouchEmitterFromView(componentView, [recognizer locationInView:componentView]);
       if (eventEmitter != nil) {
-        PointerEvent event = CreatePointerEventFromIncompleteHoverData(componentView, clientLocation, timestamp);
+        PointerEvent event =
+            CreatePointerEventFromIncompleteHoverData(componentView, clientLocation, screenLocation, timestamp);
         eventEmitter->onPointerEnter(event);
       }
     }
@@ -732,7 +743,8 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
   if (hasMoveListenerInEventPath) {
     SharedTouchEventEmitter eventEmitter = GetTouchEmitterFromView(targetView, [recognizer locationInView:targetView]);
     if (eventEmitter != nil) {
-      PointerEvent event = CreatePointerEventFromIncompleteHoverData(targetView, clientLocation, timestamp);
+      PointerEvent event =
+          CreatePointerEventFromIncompleteHoverData(targetView, clientLocation, screenLocation, timestamp);
       eventEmitter->onPointerMove(event);
     }
   }
@@ -743,7 +755,8 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
     SharedTouchEventEmitter eventEmitter =
         GetTouchEmitterFromView(prevTargetView, [recognizer locationInView:prevTargetView]);
     if (shouldEmitOutEvent && eventEmitter != nil) {
-      PointerEvent event = CreatePointerEventFromIncompleteHoverData(prevTargetView, clientLocation, timestamp);
+      PointerEvent event =
+          CreatePointerEventFromIncompleteHoverData(prevTargetView, clientLocation, screenLocation, timestamp);
       eventEmitter->onPointerOut(event);
     }
   }
@@ -774,7 +787,8 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
     SharedTouchEventEmitter eventEmitter =
         GetTouchEmitterFromView(componentView, [recognizer locationInView:componentView]);
     if (eventEmitter != nil) {
-      PointerEvent event = CreatePointerEventFromIncompleteHoverData(componentView, clientLocation, timestamp);
+      PointerEvent event =
+          CreatePointerEventFromIncompleteHoverData(componentView, clientLocation, screenLocation, timestamp);
       eventEmitter->onPointerLeave(event);
     }
   }

ReactCommon/react/renderer/components/view/PointerEvent.cpp

@@ -24,6 +24,7 @@ std::vector<DebugStringConvertibleObject> getDebugProps(
       {"pressure", getDebugDescription(pointerEvent.pressure, options)},
       {"pointerType", getDebugDescription(pointerEvent.pointerType, options)},
       {"clientPoint", getDebugDescription(pointerEvent.clientPoint, options)},
+      {"screenPoint", getDebugDescription(pointerEvent.screenPoint, options)},
       {"width", getDebugDescription(pointerEvent.width, options)},
       {"height", getDebugDescription(pointerEvent.height, options)},
       {"tiltX", getDebugDescription(pointerEvent.tiltX, options)},

ReactCommon/react/renderer/components/view/PointerEvent.h

@@ -34,6 +34,10 @@ struct PointerEvent {
    * opposed to the coordinate within the page).
    */
   Point clientPoint;
+  /*
+   * The X/Y coordinate of the pointer in global (screen) coordinates.
+   */
+  Point screenPoint;
   /*
    * The width (magnitude on the X axis), in CSS pixels, of the contact geometry
    * of the pointer

ReactCommon/react/renderer/components/view/TouchEventEmitter.cpp

@@ -75,6 +75,8 @@ static jsi::Value pointerEventPayload(
   // clientX/Y
   object.setProperty(runtime, "pageX", event.clientPoint.x);
   object.setProperty(runtime, "pageY", event.clientPoint.y);
+  object.setProperty(runtime, "screenX", event.screenPoint.x);
+  object.setProperty(runtime, "screenY", event.screenPoint.y);
   object.setProperty(runtime, "width", event.width);
   object.setProperty(runtime, "height", event.height);
   object.setProperty(runtime, "tiltX", event.tiltX);