[Android] Stylus support #3111

m-bert · 2024-09-17T16:43:15Z

Description

This PR adds stylus support on Android.

Note

You can read more about this feature in #3107

Test plan

Tested on StylusData example

…ndroid

j-piasecki · 2024-09-19T12:00:06Z

android/src/main/java/com/swmansion/gesturehandler/core/GestureUtils.kt

+    // To get azimuth angle, we need to use orientation property. Orientation value range is [-PI, PI] (https://developer.android.com/develop/ui/compose/touch-input/stylus-input/advanced-stylus-features#orientation)
+    // To shift range into [0, 2PI], we add 2PI if orientation is less than 0.
+    if (orientation < 0) {
+      orientation += 2 * PI


Wouldn't that shift it to [PI, 3PI]?

It's possible that I missed something, but that is why there's an if expression. I'm only shifting angles from [-PI, 0] - that should result in new range being [PI, 2PI]. Combined with second half we get range [0, 2PI] - a full circle.

Also, it doesn't matter since now we use formula with modulo (mentioned in the comment below)

j-piasecki · 2024-09-19T12:08:54Z

android/src/main/java/com/swmansion/gesturehandler/core/GestureUtils.kt

+    val azimuthAngle = if (orientation >= 3 * PI / 2) {
+      orientation - 3 * PI / 2
+    } else {
+      orientation + PI / 2
+    }


Shouldn't it simply be orientation - 3PI/2 (mod 2PI)?

Almost, as discussed it should be

$$(orientation + \frac{\pi}{2})\mod{2\pi}$$

Changed in 560c28a.

j-piasecki · 2024-09-19T12:13:16Z

android/src/main/java/com/swmansion/gesturehandler/core/GestureUtils.kt

+    stylusData.tiltX = tilts.first
+    stylusData.tiltY = tilts.second
+    stylusData.altitudeAngle = altitudeAngle
+    stylusData.azimuthAngle = azimuthAngle
+    stylusData.pressure = pressure


I think it would be better to assign a new object here. Since it's passed referentially to the EventDataBuilder, changes like that may modify an already scheduled but not yet sent event. (This would also warrant a name change)

I thought that it will be too expensive, but we can get back to it.

Done in 29d2d67

j-piasecki · 2024-09-19T12:17:48Z

android/src/main/java/com/swmansion/gesturehandler/core/GestureUtils.kt

+  fun createStylusDataObject(stylusData: StylusData): WritableMap {
+    val stylusDataObject = Arguments.createMap()
+
+    stylusDataObject.putDouble("tiltX", stylusData.tiltX)
+    stylusDataObject.putDouble("tiltY", stylusData.tiltY)
+    stylusDataObject.putDouble("altitudeAngle", stylusData.altitudeAngle)
+    stylusDataObject.putDouble("azimuthAngle", stylusData.azimuthAngle)
+    stylusDataObject.putDouble("pressure", stylusData.pressure)
+
+    return stylusDataObject
+  }


Suggested change

fun createStylusDataObject(stylusData: StylusData): WritableMap {

val stylusDataObject = Arguments.createMap()

stylusDataObject.putDouble("tiltX", stylusData.tiltX)

stylusDataObject.putDouble("tiltY", stylusData.tiltY)

stylusDataObject.putDouble("altitudeAngle", stylusData.altitudeAngle)

stylusDataObject.putDouble("azimuthAngle", stylusData.azimuthAngle)

stylusDataObject.putDouble("pressure", stylusData.pressure)

return stylusDataObject

}

fun createStylusDataObject(stylusData: StylusData) = Arguments.createMap().apply {

putDouble("tiltX", stylusData.tiltX)

putDouble("tiltY", stylusData.tiltY)

putDouble("altitudeAngle", stylusData.altitudeAngle)

putDouble("azimuthAngle", stylusData.azimuthAngle)

putDouble("pressure", stylusData.pressure)

}

This can also be moved to a method on StylusData as toReadableMap. I think WritableMap can be assigned to ReadableMap and it makes it clear that it shouldn't be modified.

Done in 1ab4c37

j-piasecki · 2024-09-19T12:18:39Z

android/src/main/java/com/swmansion/gesturehandler/core/HoverGestureHandler.kt

@@ -11,6 +11,7 @@ import com.swmansion.gesturehandler.react.RNViewConfigurationHelper
 class HoverGestureHandler : GestureHandler<HoverGestureHandler>() {
  private var handler: Handler? = null
  private var finishRunnable = Runnable { finish() }
+  var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)


Suggested change

var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)

var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)

private set

And please move the magic numbers to be the default values in the constructor.

Done in b8203f2 and 4034348

j-piasecki · 2024-09-19T12:19:45Z

...java/com/swmansion/gesturehandler/react/eventbuilders/HoverGestureHandlerEventDataBuilder.kt

+      if (stylusData.pressure != -1.0) {
+        putMap("stylusData", GestureUtils.createStylusDataObject(stylusData))
+      }


What's the pressure when hovering?

j-piasecki · 2024-09-19T12:20:44Z

android/src/main/java/com/swmansion/gesturehandler/core/PanGestureHandler.kt

+    if (state == STATE_UNDETERMINED) {
+      stylusData.pressure = -1.0
+    }


Shouldn't this be inside onReset? And please make a new object.

Done in b896f2e

j-piasecki · 2024-09-19T12:21:08Z

android/src/main/java/com/swmansion/gesturehandler/core/StylusData.kt

+  var tiltX: Double,
+  var tiltY: Double,
+  var altitudeAngle: Double,
+  var azimuthAngle: Double,
+  var pressure: Double


Suggested change

var tiltX: Double,

var tiltY: Double,

var altitudeAngle: Double,

var azimuthAngle: Double,

var pressure: Double

val tiltX: Double,

val tiltY: Double,

val altitudeAngle: Double,

val azimuthAngle: Double,

val pressure: Double

Done in b896f2e

j-piasecki · 2024-09-19T12:22:56Z

android/src/main/java/com/swmansion/gesturehandler/core/PanGestureHandler.kt

@@ -45,6 +45,7 @@ class PanGestureHandler(context: Context?) : GestureHandler<PanGestureHandler>()
  private var activateAfterLongPress = DEFAULT_ACTIVATE_AFTER_LONG_PRESS
  private val activateDelayed = Runnable { activate() }
  private var handler: Handler? = null
+  var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)


Suggested change

var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)

var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)

private set

And the same deal with numbers

Done in b8203f2 and 4034348

m-bert added 16 commits September 15, 2024 15:53

Add initial implementation to Pan

ada4fbf

Mergele main

9138c70

Merge branch 'main' into @mbert/stylus-support-web

d7c6b76

Add another conversion algorithm

3f5a48c

Add stylus support to hover

5992af5

Change comparison operators

dc601b7

Add check for undefined azimuth

8c8f104

Add missing tsdocs

8012cda

Add example

02f1a3b

Send pressure on pointerMove

95599e0

Add docs

ebc5321

Merge branch 'main' into @mbert/stylus-support-web

e562197

Initial Android implementation

2520bf8

Android implementation cleanup

6865215

Update example

b3edab6

Merge branch '@mbert/stylus-support-web' into @mbert/stylus-support-a…

583d684

…ndroid

m-bert marked this pull request as ready for review September 18, 2024 08:50

m-bert changed the base branch from main to @mbert/stylus-support-web September 18, 2024 08:50

m-bert added 8 commits September 18, 2024 10:52

Remove docs

878a43d

Merge branch '@mbert/stylus-support-web' into @mbert/stylus-support-a…

a833bb1

…ndroid

Fix incorrect comment

bd55726

Add abs

2de0879

Merge branch 'main' into @mbert/stylus-support-android

414882b

Merge branch 'main' into @mbert/stylus-support-web

f3b97e1

Remove hover from example

91cbc3d

Merge branch '@mbert/stylus-support-web' into @mbert/stylus-support-a…

7075d52

…ndroid

m-bert marked this pull request as draft September 19, 2024 08:12

m-bert added 2 commits September 19, 2024 10:34

Avoid sending empty event

1f4f89f

Improve formatting

6f4e399

m-bert marked this pull request as ready for review September 19, 2024 09:18

m-bert requested review from latekvo and j-piasecki and removed request for latekvo September 19, 2024 09:18

Base automatically changed from @mbert/stylus-support-web to main September 19, 2024 09:50

m-bert added 8 commits September 19, 2024 11:52

Mergele main

92059a5

Better comment

9c87760

Another better comment

01c8a17

Change if to else

7cfdb0c

Do not allocate new object every time

efde202

Change default values

737d267

Send data only on stylus

7cfad11

Minor adjustments

9e2c062

j-piasecki requested changes Sep 19, 2024

View reviewed changes

m-bert added 6 commits September 19, 2024 15:20

Azimuth calculation

560c28a

Allocate new object

29d2d67

Add toReadableMap method

1ab4c37

Add default values in StylusData

b8203f2

Add private setter

4034348

Change var to val and move reset

b896f2e

m-bert requested a review from j-piasecki September 19, 2024 14:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Android] Stylus support #3111

[Android] Stylus support #3111

m-bert commented Sep 17, 2024 •

edited

Loading

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

j-piasecki Sep 19, 2024

m-bert Sep 19, 2024

	var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)
	var stylusData: StylusData = StylusData(0.0, 0.0, 0.0, 0.0, -1.0)
	private set

[Android] Stylus support #3111

Are you sure you want to change the base?

[Android] Stylus support #3111

Conversation

m-bert commented Sep 17, 2024 • edited Loading

Description

Test plan

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-bert commented Sep 17, 2024 •

edited

Loading