Add rotary input support for Android platform #88130

AlekseyKapustyanenko · 2024-02-09T09:56:48Z

This PR adds Rotary input support for wear os devices. It converts RotaryInput to vertical mouse wheel event. Without it Godot does not recognise this event at all.

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

akien-mga · 2024-02-09T10:27:00Z

Assuming the implementation will be accepted by the @godotengine/android team, one step prior to merging would be to squash the commits. See PR workflow for instructions.

AlekseyKapustyanenko · 2024-02-09T10:27:52Z

Here is an issue in proposal repo godotengine/godot-proposals#9062

m4gr3d · 2024-02-10T02:24:12Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

+		if (event.isFromSource(InputDevice.SOURCE_ROTARY_ENCODER)) {
+			// If event came from RotaryEncoder (Bezel or Crown rotate event on Wear OS smart watches),
+			// convert it to vertical mouse wheel event.
+			verticalFactor = event.getAxisValue(MotionEvent.AXIS_SCROLL);


The documentation you linked to has additional logic that is not replicated here; is there a reason to leave that logic out?

You should also provide the ability for users to select whether this should be converted to a vertical event or to a horizontal event using project settings.

Thank you for review. Yes you are right I need to make negation for axis value. All other logic in this documentation connected with getting some settings from configuration, like getting scroll velocity and applying RotaryInput to UI control.

You should also provide the ability for users to select whether this should be converted to a vertical event or to a horizontal event using project settings.

I have concerns about ability to change direction of this input from vertical to horizontal through project settings. As I understand we should convert some specific inputs to another more general inputs. So here I conver RotaryInput to mouse wheel input(most of miсe have only one wheel for vertical scrolling). If I added such settings It would be very disappointed, because in the same game running on PC mouse wheel would cause vertical scrolling but on smart watches crown wheel or bezel wheel would cause horizontal scrolling. Anyway In the same game such event can cause as vertical as horizontal scrolling in different scenes. So how to handle this events and which axis should be chaned by this event should be defined in specific places(inside controls or scene or other object scripts) in my opinion.

Considering fact that if developer wants to handle this events as horizaontal scrolling he can override it with a couple lines of script such configuration option contradicts this rule:

Can the feature be worked around in script with a few lines?
If the feature is only intended to save users a few lines of code it is unlikely to be accepted.

So if I have not convinced you, let me know and I will add this setting.

For a cross-platform game/app, I'd agree that consistency is key and for that reason the default value for the project setting should be set to vertical to simulate similar interaction on other platforms.

However a developer can also decide to target wear os devices only and as such should not be restricted by other platforms conventions. For that reason, we should provide the option to override how the rotary input is interpreted.

Added option to change RotaryInpur axis through project settings.

Mickeon · 2024-02-12T20:00:39Z

main/main.cpp

@@ -2857,6 +2857,7 @@ Error Main::setup2() {

 		GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_long_press_as_right_click", false);
 		GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_pan_and_scale_gestures", false);
+		GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Y,X"), "Y");


I personally suggest switching the order here as X is conventionally the first axis.

Suggested change

GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Y,X"), "Y");

GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "X,Y"), "Y");

But, is it appropriate to use a string for this setting? Could it also not be a numerical value or a boolean (0 or 1), instead?

I agree the axis value should be an int instead of a string. This matches the pattern used in the codebase.

As for the labels, I think using Horizontal, Vertical would be more clear.

Horizontal,Vertical. No spacing, it is not trimmed when visualized. Notably, though, there's really going to ever be just two options so the setting could also be reworked into a toggle. Unless for some reason other mouse button combinations are considered.

Thanks for the correction!
I think it's okay to keep both options since it's consistent with what we usually do for axes, and it provides more clarity to the end user.

doc/classes/InputEventMouse.xml

Mickeon · 2024-02-12T20:25:19Z

doc/classes/ProjectSettings.xml

@@ -1358,6 +1358,9 @@
 		<member name="input_devices/pointing/android/enable_pan_and_scale_gestures" type="bool" setter="" getter="" default="false">
 			If [code]true[/code], multi-touch pan and scale gestures are enabled on Android devices.
 		</member>
+		<member name="input_devices/pointing/android/rotary_input_scroll_axis" type="String" setter="" getter="" default="Y">
+			Defines which axis of mouse wheel RotaryInput will be mapped on Wear OS devices.


Suggested change

Defines which axis of mouse wheel RotaryInput will be mapped on Wear OS devices.

On Wear OS devices, defines which axis of the mouse wheel rotary input is mapped to.

m4gr3d · 2024-02-13T00:23:06Z

main/main.cpp

@@ -2857,6 +2857,7 @@ Error Main::setup2() {

 		GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_long_press_as_right_click", false);
 		GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_pan_and_scale_gestures", false);
+		GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Y,X"), "Y");


I agree the axis value should be an int instead of a string. This matches the pattern used in the codebase.

As for the labels, I think using Horizontal, Vertical would be more clear.

m4gr3d · 2024-02-13T00:24:34Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

+	/**
+	 * Define which axis of mouse wheel event will be used for mapping RotaryInput.
+	 */	
+	protected open fun setRotaryInputAxis() =


This should be getRotaryInputAxis().

m4gr3d · 2024-02-13T00:26:22Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

@@ -70,6 +73,8 @@ public class GodotInputHandler implements InputManager.InputDeviceListener {
 	 * Used to decide whether mouse capture can be enabled.
 	 */
 	private int lastSeenToolType = MotionEvent.TOOL_TYPE_UNKNOWN;
+
+	private static String rotaryInputAxis = AXIS_Y;


You can remove static.

No I can not. This property is used in handleMouseEvent function which is static.

m4gr3d · 2024-02-13T00:27:42Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

+        // convert it to vertical mouse wheel event.
+        if (event.isFromSource(InputDevice.SOURCE_ROTARY_ENCODER)) {        	
+        	if (rotaryInputAxis.equals(AXIS_X)) {
+        		horizontalFactor = event.getAxisValue(MotionEvent.AXIS_SCROLL);        		


The negation should be applied here as well.

m4gr3d · 2024-02-13T08:12:47Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

@@ -101,6 +106,13 @@ public void enableLongPress(boolean enable) {
 	public void enablePanningAndScalingGestures(boolean enable) {
 		this.godotGestureHandler.setPanningAndScalingEnabled(enable);
 	}
+
+	/**
+	 * Set RotaryInput axis. This is Y by default.


This javadoc should be updated to match the added documentation.

m4gr3d · 2024-02-13T08:13:29Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

+		float horizontalFactor = 0;
+
+		// If event came from RotaryEncoder (Bezel or Crown rotate event on Wear OS smart watches),
+		// convert it to vertical mouse wheel event.


The vertical in this sentence can be removed.

m4gr3d · 2024-02-13T08:20:53Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

@@ -272,6 +273,11 @@ open class GodotEditor : GodotActivity() {
 	 */
 	protected open fun enablePanAndScaleGestures() =
 		java.lang.Boolean.parseBoolean(GodotLib.getEditorSetting("interface/touchscreen/enable_pan_and_scale_gestures"))
+	/**
+	 * Define which axis of mouse wheel event will be used for mapping RotaryInput.


The javadoc should be updated to match the added documentation.

m4gr3d · 2024-02-13T08:24:04Z

doc/classes/ProjectSettings.xml

@@ -1358,6 +1358,9 @@
 		<member name="input_devices/pointing/android/enable_pan_and_scale_gestures" type="bool" setter="" getter="" default="false">
 			If [code]true[/code], multi-touch pan and scale gestures are enabled on Android devices.
 		</member>
+		<member name="input_devices/pointing/android/rotary_input_scroll_axis" type="int" setter="" getter="" default="Vertical">


The value for default should be 1

m4gr3d · 2024-02-13T08:26:04Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

@@ -110,6 +110,7 @@ open class GodotEditor : GodotActivity() {
 		super.onGodotSetupCompleted()
 		val longPressEnabled = enableLongPressGestures()
 		val panScaleEnabled = enablePanAndScaleGestures()
+		val rotaryInputAxis = getRotaryInputAxis()


The rotaryInputAxis value needs to be passed to the GodotInputHandler below on line 121.

Actually, I made a mistake; the changes in the GodotEditor class are not needed because the editor just used the Godot object which applies the setting for it.
So you should be able to revert the changes in this file.

m4gr3d · 2024-02-13T08:26:51Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

+	 * Define which axis of mouse wheel event will be used for mapping RotaryInput.
+	 */	
+	protected open fun getRotaryInputAxis() =
+		GodotLib.getEditorSetting("input_devices/pointing/android/rotary_input_scroll_axis")


GodotLib.getEditorSetting(...) returns a String, so you need to use Integer.parseInt(...) to parse it to an int value.

m4gr3d · 2024-02-13T08:28:32Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

+	private static final int VERTICAL_AXIS = 1;
+	private static final int HORIZONTAL_AXIS = 0;


Let's update these constants to ROTARY_INPUT_VERTICAL_AXIS and ROTARY_INPUT_HORIZONTAL_AXIS for clarity.

m4gr3d · 2024-02-13T08:29:37Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

+    	rotaryInputAxis = axis;
+    }


Looks like there is an issue with indentation here.

Fixed. And All others indentation errors.

AThousandShips · 2024-02-13T09:48:42Z

main/main.cpp

@@ -2857,7 +2857,7 @@ Error Main::setup2() {

 		GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_long_press_as_right_click", false);
 		GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_pan_and_scale_gestures", false);
-
+		GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), "1");


Suggested change

GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), "1");

GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), 1);

Thank you. Fixed

m4gr3d

Looks great!

There is one set of changes that need to be reverted then it'll be good to merge!

m4gr3d · 2024-02-13T15:53:11Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

@@ -110,6 +110,7 @@ open class GodotEditor : GodotActivity() {
 		super.onGodotSetupCompleted()
 		val longPressEnabled = enableLongPressGestures()
 		val panScaleEnabled = enablePanAndScaleGestures()
+		val rotaryInputAxis = getRotaryInputAxis()


Actually, I made a mistake; the changes in the GodotEditor class are not needed because the editor just used the Godot object which applies the setting for it.
So you should be able to revert the changes in this file.

Mickeon

Documentation is good now.

m4gr3d · 2024-02-13T16:04:39Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

@@ -118,6 +118,7 @@ open class GodotEditor : GodotActivity() {
 			godotFragment?.godot?.renderView?.inputHandler?.apply {
 				enableLongPress(longPressEnabled)
 				enablePanningAndScalingGestures(panScaleEnabled)
+				setRotaryInputAxis(rotaryInputAxis)


You can also revert this change for the GodotEditor.

m4gr3d · 2024-02-13T16:04:58Z

platform/android/java/editor/src/main/java/org/godotengine/editor/GodotEditor.kt

+	 * On Wear OS devices, defines which axis of the mouse wheel rotary input is mapped to.
+	 */
+	protected open fun getRotaryInputAxis() =
+		Integer.parseInt(GodotLib.getEditorSetting("input_devices/pointing/android/rotary_input_scroll_axis"))


You can also revert this change for the GodotEditor.

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

doc/classes/ProjectSettings.xml

m4gr3d

Looks great!

Calinou

Code and docs look good to me. I don't have a setup to test this locally though.¹

I acquired a Galaxy Watch 6 the other day, but didn't look at sideloading apps on it yet. ↩

akien-mga · 2024-02-13T22:53:27Z

Thanks! And congrats for your first merged Godot contribution 🎉

AlekseyKapustyanenko · 2024-02-14T06:29:21Z

Code and docs look good to me. I don't have a setup to test this locally though.1

Footnotes

I acquired a Galaxy Watch 6 the other day, but didn't look at sideloading apps on it yet. ↩

I have checked this solution on my smartwatches. So let me know if I could help you to check it on your side.

AlekseyKapustyanenko requested a review from a team as a code owner February 9, 2024 09:56

akien-mga changed the title ~~Add rotary input support for android platform~~ Add rotary input support for Android platform Feb 9, 2024

akien-mga added enhancement platform:android topic:input labels Feb 9, 2024

akien-mga added this to the 4.x milestone Feb 9, 2024

akien-mga reviewed Feb 9, 2024

View reviewed changes

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java Outdated Show resolved Hide resolved

AlekseyKapustyanenko mentioned this pull request Feb 9, 2024

Add Rotary input support for android(wear os) platform. godotengine/godot-proposals#9062

Closed

akien-mga requested a review from a team February 9, 2024 10:26

AlekseyKapustyanenko force-pushed the Rotary_Input branch from ade7b8c to 53608d1 Compare February 9, 2024 10:34

Calinou added the topic:porting label Feb 9, 2024

m4gr3d requested changes Feb 10, 2024

View reviewed changes

AlekseyKapustyanenko force-pushed the Rotary_Input branch 2 times, most recently from 0a8db8c to f55f612 Compare February 12, 2024 19:43

AlekseyKapustyanenko requested review from a team as code owners February 12, 2024 19:43

AlekseyKapustyanenko requested a review from m4gr3d February 12, 2024 19:46

AlekseyKapustyanenko force-pushed the Rotary_Input branch from f55f612 to 7afc512 Compare February 12, 2024 19:50

Mickeon reviewed Feb 12, 2024

View reviewed changes

m4gr3d requested changes Feb 13, 2024

View reviewed changes

AlekseyKapustyanenko force-pushed the Rotary_Input branch 2 times, most recently from f7f5b14 to db5a8b2 Compare February 13, 2024 08:03

AlekseyKapustyanenko requested review from m4gr3d, akien-mga and Mickeon February 13, 2024 08:07

m4gr3d requested changes Feb 13, 2024

View reviewed changes

AlekseyKapustyanenko force-pushed the Rotary_Input branch from db5a8b2 to 387b706 Compare February 13, 2024 08:54

AlekseyKapustyanenko requested a review from m4gr3d February 13, 2024 08:56

AThousandShips reviewed Feb 13, 2024

View reviewed changes

AlekseyKapustyanenko force-pushed the Rotary_Input branch from 387b706 to 3641437 Compare February 13, 2024 10:05

AlekseyKapustyanenko requested a review from AThousandShips February 13, 2024 10:05

m4gr3d requested changes Feb 13, 2024

View reviewed changes

AlekseyKapustyanenko force-pushed the Rotary_Input branch from 3641437 to 4098933 Compare February 13, 2024 15:59

Mickeon approved these changes Feb 13, 2024

View reviewed changes

AlekseyKapustyanenko requested a review from m4gr3d February 13, 2024 16:00

m4gr3d requested changes Feb 13, 2024

View reviewed changes

AlekseyKapustyanenko force-pushed the Rotary_Input branch from 4098933 to 8b198d9 Compare February 13, 2024 16:11

AlekseyKapustyanenko requested a review from m4gr3d February 13, 2024 16:12

Calinou reviewed Feb 13, 2024

View reviewed changes

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java Outdated Show resolved Hide resolved

Calinou reviewed Feb 13, 2024

View reviewed changes

doc/classes/ProjectSettings.xml Outdated Show resolved Hide resolved

m4gr3d approved these changes Feb 13, 2024

View reviewed changes

Add rotary input support. Fix documentation

d5c2a64

AlekseyKapustyanenko force-pushed the Rotary_Input branch from 8b198d9 to d5c2a64 Compare February 13, 2024 17:14

akien-mga modified the milestones: 4.x, 4.3 Feb 13, 2024

AlekseyKapustyanenko requested a review from Calinou February 13, 2024 18:28

Calinou approved these changes Feb 13, 2024

View reviewed changes

akien-mga merged commit afc49e5 into godotengine:master Feb 13, 2024
16 checks passed

This was referenced Feb 17, 2024

Rotary input 3.x #88461

Closed

Rotary input for 3.x #88462

Closed

[3.x] Add rotary input support for Android platform #88490

Merged

	GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Y,X"), "Y");
	GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "X,Y"), "Y");

	Defines which axis of mouse wheel RotaryInput will be mapped on Wear OS devices.
	On Wear OS devices, defines which axis of the mouse wheel rotary input is mapped to.

		private static final int VERTICAL_AXIS = 1;
		private static final int HORIZONTAL_AXIS = 0;

	GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), "1");
	GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), 1);

Add rotary input support for Android platform #88130

Add rotary input support for Android platform #88130

Conversation

AlekseyKapustyanenko commented Feb 9, 2024

akien-mga commented Feb 9, 2024

AlekseyKapustyanenko commented Feb 9, 2024 • edited Loading

Choose a reason for hiding this comment

AlekseyKapustyanenko Feb 10, 2024 • edited Loading

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

Mickeon Feb 13, 2024 • edited Loading

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

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

m4gr3d left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mickeon left a 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

m4gr3d left a comment

Choose a reason for hiding this comment

Calinou left a comment

Choose a reason for hiding this comment

Footnotes

akien-mga commented Feb 13, 2024

AlekseyKapustyanenko commented Feb 14, 2024

Footnotes

AlekseyKapustyanenko commented Feb 9, 2024 •

edited

Loading

AlekseyKapustyanenko Feb 10, 2024 •

edited

Loading

Mickeon Feb 13, 2024 •

edited

Loading