Skip to content

Commit

Permalink
Fix reversed macOS trackpad rotation (flutter#36444)
Browse files Browse the repository at this point in the history
  • Loading branch information
@moffatman @OlehSv
moffatman authored and OlehSv committed Sep 28, 2022
1 parent b3f87ed commit 415e990
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 1 deletion.
2 changes: 1 addition & 1 deletion shell/platform/darwin/macos/framework/Source/FlutterViewController.mm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -611,7 +611,7 @@ - (void)dispatchMouseEvent:(NSEvent*)event phase:(FlutterPointerPhase)phase {
} else if (event.type == NSEventTypeMagnify) {
_mouseState.scale += event.magnification;
} else if (event.type == NSEventTypeRotate) {
_mouseState.rotation += event.rotation * (M_PI / 180.0);
_mouseState.rotation += event.rotation * (-M_PI / 180.0);
}
flutterEvent.pan_x = _mouseState.delta_x;
flutterEvent.pan_y = _mouseState.delta_y;
Expand Down
120 changes: 120 additions & 0 deletions shell/platform/darwin/macos/framework/Source/FlutterViewControllerTest.mm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,25 @@ + (void)respondFalseForSendEvent:(const FlutterKeyEvent&)event

namespace {

id MockGestureEvent(NSEventType type, NSEventPhase phase, double magnification, double rotation) {
id event = [OCMockObject mockForClass:[NSEvent class]];
NSPoint locationInWindow = NSMakePoint(0, 0);
CGFloat deltaX = 0;
CGFloat deltaY = 0;
NSTimeInterval timestamp = 1;
NSUInteger modifierFlags = 0;
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(type)] type];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(phase)] phase];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(locationInWindow)] locationInWindow];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(deltaX)] deltaX];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(deltaY)] deltaY];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(timestamp)] timestamp];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(modifierFlags)] modifierFlags];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(magnification)] magnification];
[(NSEvent*)[[event stub] andReturnValue:OCMOCK_VALUE(rotation)] rotation];
return event;
}

// Allocates and returns an engine configured for the test fixture resource configuration.
FlutterEngine* CreateTestEngine() {
NSString* fixtures = @(testing::GetFixturesPath());
Expand Down Expand Up @@ -432,6 +451,7 @@ - (bool)testTrackpadGesturesAreSentToFramework {
bundle:nil];
[viewController loadView];

// Test for pan events.
// Start gesture.
CGEventRef cgEventStart = CGEventCreateScrollWheelEvent(NULL, kCGScrollEventUnitPixel, 1, 0);
CGEventSetType(cgEventStart, kCGEventScrollWheel);
Expand Down Expand Up @@ -566,6 +586,106 @@ - (bool)testTrackpadGesturesAreSentToFramework {
EXPECT_EQ(last_event.scroll_delta_x, -40 * viewController.flutterView.layer.contentsScale);
EXPECT_EQ(last_event.scroll_delta_y, -80 * viewController.flutterView.layer.contentsScale);

// Test for scale events.
// Start gesture.
called = false;
[viewController magnifyWithEvent:flutter::testing::MockGestureEvent(NSEventTypeMagnify,
NSEventPhaseBegan, 1, 0)];
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomStart);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);

// Update gesture.
called = false;
[viewController magnifyWithEvent:flutter::testing::MockGestureEvent(NSEventTypeMagnify,
NSEventPhaseChanged, 1, 0)];
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomUpdate);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.pan_x, 0);
EXPECT_EQ(last_event.pan_y, 0);
EXPECT_EQ(last_event.scale, 2); // macOS uses logarithmic scaling values, the linear value for
// flutter here should be 2^1 = 2.
EXPECT_EQ(last_event.rotation, 0);

// Make sure the scale values accumulate.
called = false;
[viewController magnifyWithEvent:flutter::testing::MockGestureEvent(NSEventTypeMagnify,
NSEventPhaseChanged, 1, 0)];
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomUpdate);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.pan_x, 0);
EXPECT_EQ(last_event.pan_y, 0);
EXPECT_EQ(last_event.scale, 4); // macOS uses logarithmic scaling values, the linear value for
// flutter here should be 2^(1+1) = 2.
EXPECT_EQ(last_event.rotation, 0);

// End gesture.
called = false;
[viewController magnifyWithEvent:flutter::testing::MockGestureEvent(NSEventTypeMagnify,
NSEventPhaseEnded, 0, 0)];
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomEnd);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);

// Test for rotation events.
// Start gesture.
called = false;
[viewController rotateWithEvent:flutter::testing::MockGestureEvent(NSEventTypeRotate,
NSEventPhaseBegan, 1, 0)];
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomStart);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);

// Update gesture.
called = false;
[viewController rotateWithEvent:flutter::testing::MockGestureEvent(
NSEventTypeRotate, NSEventPhaseChanged, 0, -180)]; // degrees
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomUpdate);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.pan_x, 0);
EXPECT_EQ(last_event.pan_y, 0);
EXPECT_EQ(last_event.scale, 1);
EXPECT_EQ(last_event.rotation, M_PI); // radians

// Make sure the rotation values accumulate.
called = false;
[viewController rotateWithEvent:flutter::testing::MockGestureEvent(
NSEventTypeRotate, NSEventPhaseChanged, 0, -360)]; // degrees
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomUpdate);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.pan_x, 0);
EXPECT_EQ(last_event.pan_y, 0);
EXPECT_EQ(last_event.scale, 1);
EXPECT_EQ(last_event.rotation, 3 * M_PI); // radians

// End gesture.
called = false;
[viewController rotateWithEvent:flutter::testing::MockGestureEvent(NSEventTypeRotate,
NSEventPhaseEnded, 0, 0)];
EXPECT_TRUE(called);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);
EXPECT_EQ(last_event.phase, kPanZoomEnd);
EXPECT_EQ(last_event.device_kind, kFlutterPointerDeviceKindTrackpad);
EXPECT_EQ(last_event.signal_kind, kFlutterPointerSignalKindNone);

return true;
}

Expand Down

0 comments on commit 415e990

Please sign in to comment.