To: sdl@libsdl.org
authorRyan C. Gordon <icculus@icculus.org>
Mon, 02 Jan 2006 00:31:00 +0000
changeset 12127663bb0f52c7
parent 1211 304d8dd6a989
child 1213 8eb191652834
To: sdl@libsdl.org
From: Christian Walther <cwalther@gmx.ch>
Date: Thu, 15 Dec 2005 21:19:53 +0100
Subject: [SDL] More mouse enhancements for Mac OS X

The attached patch brings two more enhancements to mouse handling on Mac
OS X (Quartz):

1. Currently, after launching an SDL application, SDL's notion of the
mouse position is stuck in the top left corner (0,0) until the first
time the mouse is moved. That's because the UpdateMouse() function isn't
implemented in the Quartz driver. This patch adds it.

2. When grabbing input while the mouse cursor is hidden, the function
CGAssociateMouseAndMouseCursorPosition(0) is called, which prevents the
system's notion of the mouse location from moving (and therefore leaving
the SDL window) even when the mouse is moved. However, apparently the
Wacom tablet driver (and maybe other special pointing device drivers)
doesn't care about that setting and still allows the mouse location to
go outside of the window. Interestingly, the system cursor, which is
made visible by the existing code in SDL in that case, does not follow
the mouse location, but appears in the middle of the SDL window. The
mouse location being outside of the window however means that mouse
button events go to background applications (or the dock or whatever is
there), which is very confusing to the user who sees no cursor outside
of the SDL window.

I have not found any way of intercepting these events (and that's
probably by design, as "normal" applications shouldn't prevent the user
from bringing other applications' windows to the front by clicking on
them). An idea would be placing a fully transparent, screen-filling
window in front of everything, but I fear that this might affect
rendering performance (by doing unnecessary compositing, using up
memory, or whatever).

The deluxe solution to the problem would be talking to the tablet
driver using AppleEvents to tell it to constrain its mapped area to the
window (see Wacom's "TabletEventDemo" sample app,
http://www.wacomeng.com/devsupport/mac/downloads.html), but I think that
the bloat that solution would add to SDL would outweigh its usefulness.

What I did instead in my patch is reassociating mouse and cursor when
the mouse leaves the window while an invisible grab is in effect, and
restoring the grab when the window is entered. That way, the grab can
still be effectively broken by a tablet, but at least it's obvious to
the user that it is broken. That change is minimal - it doesn't affect
operation with a mouse (or a trackpad), and the code that it adds is not
executed on every PumpEvents() call, only when entering and leaving the
window.

Unless there are any concerns about the patch, please apply. Feel free
to shorten the lengthy comment in SDL_QuartzEvents.m if you think it's
too verbose.

Thanks

-Christian
src/video/quartz/SDL_QuartzEvents.m
src/video/quartz/SDL_QuartzVideo.h
src/video/quartz/SDL_QuartzVideo.m
     1.1 --- a/src/video/quartz/SDL_QuartzEvents.m	Sun Jan 01 23:45:52 2006 +0000
     1.2 +++ b/src/video/quartz/SDL_QuartzEvents.m	Mon Jan 02 00:31:00 2006 +0000
     1.3 @@ -887,6 +887,21 @@
     1.4                      if ( !isInGameWin && (SDL_GetAppState() & SDL_APPMOUSEFOCUS) ) {
     1.5                      
     1.6                          SDL_PrivateAppActive (0, SDL_APPMOUSEFOCUS);
     1.7 +                        if (grab_state == QZ_INVISIBLE_GRAB)
     1.8 +                            /*The cursor has left the window even though it is
     1.9 +                              disassociated from the mouse (and therefore
    1.10 +                              shouldn't move): this can happen with Wacom
    1.11 +                              tablets, and it effectively breaks the grab, since
    1.12 +                              mouse down events now go to background
    1.13 +                              applications. The only possibility to avoid this
    1.14 +                              seems to be talking to the tablet driver
    1.15 +                              (AppleEvents) to constrain its mapped area to the
    1.16 +                              window, which may not be worth the effort. For
    1.17 +                              now, handle the condition more gracefully than
    1.18 +                              before by reassociating cursor and mouse until the
    1.19 +                              cursor enters the window again, making it obvious
    1.20 +                              to the user that the grab is broken.*/
    1.21 +                            CGAssociateMouseAndMouseCursorPosition (1);
    1.22                          if (!cursor_should_be_visible)
    1.23                              QZ_ShowMouse (this);
    1.24                      }
    1.25 @@ -896,6 +911,10 @@
    1.26                          SDL_PrivateAppActive (1, SDL_APPMOUSEFOCUS);
    1.27                          if (!cursor_should_be_visible)
    1.28                              QZ_HideMouse (this);
    1.29 +                        if (grab_state == QZ_INVISIBLE_GRAB) { /*see comment above*/
    1.30 +                            QZ_PrivateWarpCursor (this, SDL_VideoSurface->w / 2, SDL_VideoSurface->h / 2);
    1.31 +                            CGAssociateMouseAndMouseCursorPosition (0);
    1.32 +                        }
    1.33                      }
    1.34                      break;
    1.35                  case NSScrollWheel:
    1.36 @@ -947,3 +966,11 @@
    1.37      
    1.38      [ pool release ];
    1.39  }
    1.40 +
    1.41 +void QZ_UpdateMouse (_THIS)
    1.42 +{
    1.43 +    NSPoint p;
    1.44 +    QZ_GetMouseLocation (this, &p);
    1.45 +    SDL_PrivateAppActive (QZ_IsMouseInWindow (this), SDL_APPMOUSEFOCUS);
    1.46 +    SDL_PrivateMouseMotion (0, 0, p.x, p.y);
    1.47 +}
     2.1 --- a/src/video/quartz/SDL_QuartzVideo.h	Sun Jan 01 23:45:52 2006 +0000
     2.2 +++ b/src/video/quartz/SDL_QuartzVideo.h	Mon Jan 02 00:31:00 2006 +0000
     2.3 @@ -196,6 +196,7 @@
     2.4  void         QZ_WarpWMCursor     (_THIS, Uint16 x, Uint16 y);
     2.5  void         QZ_MoveWMCursor     (_THIS, int x, int y);
     2.6  void         QZ_CheckMouseMode   (_THIS);
     2.7 +void         QZ_UpdateMouse      (_THIS);
     2.8  
     2.9  /* Event functions */
    2.10  void         QZ_InitOSKeymap     (_THIS);
     3.1 --- a/src/video/quartz/SDL_QuartzVideo.m	Sun Jan 01 23:45:52 2006 +0000
     3.2 +++ b/src/video/quartz/SDL_QuartzVideo.m	Mon Jan 02 00:31:00 2006 +0000
     3.3 @@ -131,6 +131,7 @@
     3.4      device->ListModes        = QZ_ListModes;
     3.5      device->SetVideoMode     = QZ_SetVideoMode;
     3.6      device->ToggleFullScreen = QZ_ToggleFullScreen;
     3.7 +    device->UpdateMouse      = QZ_UpdateMouse;
     3.8      device->SetColors        = QZ_SetColors;
     3.9      /* device->UpdateRects      = QZ_UpdateRects; this is determined by SetVideoMode() */
    3.10      device->VideoQuit        = QZ_VideoQuit;