Changeset 10208 for OpenSceneGraph/trunk/src/osgViewer/GraphicsWindowCocoa.mm

Timestamp:

05/14/09 17:34:15 (4 years ago)

Author:

robert

Message:

From Stephan Huber, "attached you'll find some bugfixes and enhancements for the Cocoa
implementation of GraoicsWindowCocoa?:

Enhancements/Bugfixes:

+ now it's possible to integrate osgViewer better into existing
cocoa-applications:
* create one or more NSOpenGLView(s) and add these to your window(s)
* create one or more NSWindows
* disable the integrated event-polling of osgViewer, and let the work be
done by Cocoa / NSApplicationRun. You'll have to run the osgViewer's
runloop in a separate thread

+ missing menu-event-handling implemented

+ added NSAutoReleasePools where necessary, this fixes some memory-leaks
+ fixed some crashes and thread-issues"

Files:

• OpenSceneGraph/trunk/src/osgViewer/GraphicsWindowCocoa.mm (modified) (41 diffs)

OpenSceneGraph/trunk/src/osgViewer/GraphicsWindowCocoa.mm

@@ -8 +8 @@
  *  Some code borrowed from the implementation of CocoaViewer, 
  *  Created by Eric Wing on 11/12/06. and ported by Martin Lavery 7/06/07
+ *
+ *  Other snippets are borrowed from the Cocoa-implementation of the SDL-lib
  */
 
@@ -18 +20 @@
 #include "DarwinUtils.h"
 
+//#define DEBUG_OUT(s) std::cout << "GraphicsWindowCocoa :: " << s << std::endl;
+
+#define DEBUG_OUT(s) ;
 
 static bool s_quit_requested = false;
+
+#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
+@interface NSApplication(NSAppleMenu)
+- (void)setAppleMenu:(NSMenu *)menu;
+@end
+#endif
 
 
@@ -188 +199 @@
 
 - (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender;
+- (void)applicationDidFinishLaunching:(NSNotification *)aNotification;
 @end
 
@@ -194 +206 @@
 {
     s_quit_requested = true;
-    // std::cout << "quit requested " << std::endl;
-    return NSTerminateNow;
+    DEBUG_OUT("quit requested ");
+    return NSTerminateCancel;
+}
+
+- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
+{
+    DEBUG_OUT("applicationDidFinishLaunching");
 }
 
@@ -323 +340 @@
 - (void) handleModifiers: (NSEvent*)theEvent
 {
+    DEBUG_OUT("handling modifiers");
+    
+    if ((!_win) || (!_win->getEventQueue())) 
+        return; // no event    queue in place
+    
     unsigned int flags = [theEvent modifierFlags];
     
@@ -367 +389 @@
 - (void) mouseMoved:(NSEvent*)theEvent 
 {
+    DEBUG_OUT("Mouse moved");
     NSPoint converted_point = [self getLocalPoint: theEvent];
     _win->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
@@ -375 +398 @@
 - (void) mouseDown:(NSEvent*)theEvent
 {
+    DEBUG_OUT("Mouse down");
     // Because many Mac users have only a 1-button mouse, we should provide ways
     // to access the button 2 and 3 actions of osgViewer.
@@ -403 +427 @@
 - (void) mouseDragged:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];    
     _win->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
@@ -441 +467 @@
 - (void) rightMouseDragged:(NSEvent*)theEvent
 {
-   
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     _win->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
@@ -473 +500 @@
 - (void) otherMouseDragged:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];    
     _win->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
@@ -524 +553 @@
 - (void) doLeftMouseButtonDown:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     
@@ -538 +569 @@
 - (void) doLeftMouseButtonUp:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     
@@ -546 +579 @@
 - (void) doRightMouseButtonDown:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     if([theEvent clickCount] == 1)
@@ -561 +596 @@
 - (void) doRightMouseButtonUp:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];    
     _win->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 3);
@@ -567 +604 @@
 - (void) doMiddleMouseButtonDown:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     
@@ -581 +620 @@
 - (void) doExtraMouseButtonDown:(NSEvent*)theEvent buttonNumber:(int)button_number
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     if([theEvent clickCount] == 1)
@@ -595 +636 @@
 - (void) doMiddleMouseButtonUp:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     _win->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 2);
@@ -602 +645 @@
 - (void) doExtraMouseButtonUp:(NSEvent*)theEvent buttonNumber:(int)button_number
 {
+    if (!_win) return;
+    
     NSPoint converted_point = [self getLocalPoint: theEvent];
     _win->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, button_number+1);
@@ -610 +655 @@
 - (void) scrollWheel:(NSEvent*)theEvent
 {
+    if (!_win) return;
+    
     // Unfortunately, it turns out mouseScroll2D doesn't actually do anything.
     // The camera manipulators don't seem to implement any code that utilize the scroll values.
@@ -620 +667 @@
 - (void)keyDown:(NSEvent *)theEvent 
 {
+    if (!_win) return;
+    
     NSString* chars = [theEvent charactersIgnoringModifiers]; 
     unsigned int keyCode = remapCocoaKey([chars characterAtIndex:0], ([theEvent modifierFlags] & NSFunctionKeyMask) );
@@ -629 +678 @@
 - (void)keyUp:(NSEvent *)theEvent 
 {   
+    if (!_win) return;
+    
     NSString* chars = [theEvent charactersIgnoringModifiers]; 
     unsigned int keyCode = remapCocoaKey([chars characterAtIndex:0], ([theEvent modifierFlags] & NSFunctionKeyMask));
@@ -644 +695 @@
 -(void)handleTabletEvents:(NSEvent *)theEvent
 {
+    if (!_win) return;
+    
     float pressure = [theEvent pressure];
     _win->getEventQueue()->penPressure(pressure);
@@ -654 +707 @@
 - (void)tabletProximity:(NSEvent *)theEvent
 {
+    if (!_win) return;
+    
     osgGA::GUIEventAdapter::TabletPointerType pt(osgGA::GUIEventAdapter::UNKNOWN);
     switch ([theEvent pointingDeviceType]) {
@@ -845 +900 @@
     NSRect rect = NSMakeRect(_traits->x + screenLeft, _traits->y + screenTop, _traits->width, _traits->height);
     
-    _window = [[GraphicsWindowCocoaWindow alloc] initWithContentRect: rect styleMask: style backing: NSBackingStoreBuffered defer: NO];
-    
-    if (!_window) {
-        osg::notify(osg::WARN) << "GraphicsWindowCocoa::realizeImplementation :: could not create window" << std::endl;
-        return false;
-    }
-    
-    rect = convertFromQuartzCoordinates(rect);
-    [_window setFrameOrigin: rect.origin];
-     
+    _ownsWindow = true;
+    
+    // should we create a NSView only??
+    WindowData* windowData = _traits->inheritedWindowData ? dynamic_cast<WindowData*>(_traits->inheritedWindowData.get()) : NULL;
+    if (windowData) 
+    {
+        if (windowData->createOnlyView())
+            _ownsWindow = false;
+        _checkForEvents = windowData->checkForEvents();
+        
+    } 
+    
+
+    osg::notify(osg::DEBUG_INFO) << "GraphicsWindowCocoa::realizeImplementation / ownsWindow: " << _ownsWindow << " checkForEvents: " << _checkForEvents << std::endl;
+
+    if (_ownsWindow) 
+    {
+        _window = [[GraphicsWindowCocoaWindow alloc] initWithContentRect: rect styleMask: style backing: NSBackingStoreBuffered defer: NO];
+        
+        if (!_window) {
+            osg::notify(osg::WARN) << "GraphicsWindowCocoa::realizeImplementation :: could not create window" << std::endl;
+            return false;
+        }
+
+        rect = convertFromQuartzCoordinates(rect);
+        [_window setFrameOrigin: rect.origin];
+    } 
+            
     NSOpenGLPixelFormatAttribute attr[32];
     int i = 0;
@@ -914 +987 @@
     [theView setGraphicsWindowCocoa: this];
     [theView setOpenGLContext:_context];
-    [_window setContentView: theView];
-    
-    setupNSWindow(_window);
-    
-    [theView release];
+    _view = theView;
+    osg::notify(osg::DEBUG_INFO) << "GraphicsWindowCocoa::realizeImplementation / view: " << theView << std::endl;
+
+    if (_ownsWindow) {
+        [_window setContentView: theView];
+        setupNSWindow(_window);
+        [theView release];
+        
+        MenubarController::instance()->attachWindow( new CocoaWindowAdapter(this) );
+    }
+    else 
+    {
+        windowData->setCreatedNSView(theView);
+    }
+
     [pool release];
     
-    MenubarController::instance()->attachWindow( new CocoaWindowAdapter(this) );
     
     useCursor(_traits->useCursor);
@@ -951 +1033 @@
     if (mbc) mbc->detachWindow(this);
     
-    [_window close];
-    [_window release];
+    if (_window) {
+        [_window close];
+        [_window release];
+    }
+    
+    if (_view) {
+        [_view setGraphicsWindowCocoa: NULL];
+    }
+    
+    _window = NULL;
+    _view = NULL;
+    
 }
 
@@ -994 +1086 @@
 void GraphicsWindowCocoa::checkEvents()
 {
+    if (!_checkForEvents)
+        return;
+    
     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
     
@@ -1005 +1100 @@
             so it may not effectively make much of a difference.
          */
-        NSEvent *event = [ [NSApplication sharedApplication]
+        NSEvent *event = [ NSApp
                 nextEventMatchingMask:NSAnyEventMask
                 untilDate:[NSDate distantPast]
@@ -1012 +1107 @@
         if(!event)
             break;
-        [[NSApplication sharedApplication] sendEvent: event];
+        [NSApp sendEvent: event];
     }    
     
@@ -1037 +1132 @@
 bool GraphicsWindowCocoa::setWindowDecorationImplementation(bool flag)
 {
-    if (!_realized) return false;
+    if (!_realized || !_ownsWindow) return false;
+    
+    NSAutoreleasePool* localPool = [[NSAutoreleasePool alloc] init];
     
     unsigned int style(NSBorderlessWindowMask);
@@ -1062 +1159 @@
     }
     
+    [localPool release];
+    
     return true;
 }
@@ -1071 +1170 @@
 void GraphicsWindowCocoa::grabFocus()
 {
-    [_window makeKeyAndOrderFront: nil];
+    if (_ownsWindow)
+        [_window makeKeyAndOrderFront: nil];
 }
 
@@ -1090 +1190 @@
 void GraphicsWindowCocoa::resizedImplementation(int x, int y, int width, int height)
 {
-    std::cout << "resized implementation" << x << " " << y << " " << width << " " << height << std::endl; 
+    DEBUG_OUT("resized implementation" << x << " " << y << " " << width << " " << height); 
     GraphicsContext::resizedImplementation(x, y, width, height);
+    
+    NSAutoreleasePool* localPool = [[NSAutoreleasePool alloc] init];
    
-    [_context update];
+    if (_context)
+        [_context update];
     MenubarController::instance()->update();
     getEventQueue()->windowResize(x,y,width, height, getEventQueue()->getTime());
+    [localPool release];
 }
 
@@ -1106 +1210 @@
 bool GraphicsWindowCocoa::setWindowRectangleImplementation(int x, int y, int width, int height)
 {
+    if (!_ownsWindow)
+        return false;
+        
+    NSAutoreleasePool* localPool = [[NSAutoreleasePool alloc] init];
+        
     DarwinWindowingSystemInterface* wsi = dynamic_cast<DarwinWindowingSystemInterface*>(osg::GraphicsContext::getWindowingSystemInterface());
     int screenLeft(0), screenTop(0);
@@ -1120 +1229 @@
     MenubarController::instance()->update();
     
+    [localPool release];
+    
     return true;
 }
@@ -1155 +1266 @@
 void GraphicsWindowCocoa::setWindowName (const std::string & name)
 {
+    if (_traits.valid()) _traits->windowName = name;
+    
+    if (!_ownsWindow)
+        return;
+        
     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
     
@@ -1201 +1317 @@
 void GraphicsWindowCocoa::setCursor(MouseCursor mouseCursor)
 {
+    NSAutoreleasePool* localPool = [[NSAutoreleasePool alloc] init];
+    
     switch (mouseCursor) 
     {
@@ -1223 +1341 @@
             osg::notify(osg::INFO) << "GraphicsWindowCocoa::setCursor :: unsupported MouseCursor: " << mouseCursor << std::endl;    
     }
+    
+    [localPool release];
 }
 
@@ -1243 +1363 @@
 GraphicsWindowCocoa::~GraphicsWindowCocoa() 
 {
+    close();
 }
 
@@ -1256 +1377 @@
     
     CocoaWindowingSystemInterface()
-    :    DarwinWindowingSystemInterface() 
-    {
-        localPool = [[NSAutoreleasePool alloc] init];
-        [[NSApplication sharedApplication] setDelegate: [[CocoaAppDelegate alloc] init] ];
+    :    DarwinWindowingSystemInterface()
+    
+    {        
+    }
+    
+    void initAsStandaloneApplication() 
+    {
+        static bool s_inited = false;
+        if (s_inited) return;
+        s_inited = true;
+        
+        osg::notify(osg::INFO) << "CocoaWindowingSystemInterface::initAsStandaloneApplication " << std::endl;
+        
+        ProcessSerialNumber psn;
+        if (!GetCurrentProcess(&psn)) {
+            TransformProcessType(&psn, kProcessTransformToForegroundApplication);
+            SetFrontProcess(&psn);
+        }
+        
+        NSAutoreleasePool* localPool = [[NSAutoreleasePool alloc] init];
+        
+        if (NSApp == nil) {
+            [NSApplication sharedApplication];
+        }
+        
+        [NSApp setDelegate: [[CocoaAppDelegate alloc] init] ];
+        
+        createApplicationMenus();
+        
+        [NSApp finishLaunching];
+        
+        [localPool release];
     }
     
     virtual osg::GraphicsContext* createGraphicsContext(osg::GraphicsContext::Traits* traits) 
     {
+        if (!traits->pbuffer) 
+        {
+            GraphicsWindowCocoa::WindowData* windowData = traits->inheritedWindowData ? dynamic_cast<GraphicsWindowCocoa::WindowData*>(traits->inheritedWindowData.get()) : NULL;
+        
+            if (!windowData || (windowData && windowData->poseAsStandaloneApp())) 
+            {
+                initAsStandaloneApplication();
+            }
+        }
+        
         return createGraphicsContextImplementation<PixelBufferCocoa, GraphicsWindowCocoa>(traits);
     }
@@ -1269 +1428 @@
     virtual ~CocoaWindowingSystemInterface() 
     {
-        [localPool release];
-    }
-    
-    NSAutoreleasePool *localPool;
+    }
+    
+private:
+    NSString *getApplicationName(void)
+    {
+        NSDictionary *dict;
+        NSString *appName = 0;
+
+        /* Determine the application name */
+        dict = (NSDictionary *)CFBundleGetInfoDictionary(CFBundleGetMainBundle());
+        if (dict)
+            appName = [dict objectForKey: @"CFBundleName"];
+        
+        if (![appName length])
+            appName = [[NSProcessInfo processInfo] processName];
+
+        return appName;
+    }
+    
+     void createApplicationMenus(void)
+    {
+        NSString *appName;
+        NSString *title;
+        NSMenu *appleMenu;
+        NSMenuItem *menuItem;
+        
+        /* Create the main menu bar */
+        [NSApp setMainMenu:[[NSMenu alloc] init]];
+
+        /* Create the application menu */
+        appName = getApplicationName();
+        appleMenu = [[NSMenu alloc] initWithTitle:@""];
+        
+        /* Add menu items */
+        title = [@"About " stringByAppendingString:appName];
+        [appleMenu addItemWithTitle:title action:@selector(orderFrontStandardAboutPanel:) keyEquivalent:@""];
+
+        [appleMenu addItem:[NSMenuItem separatorItem]];
+        
+        NSMenu* service_menu = [[NSMenu alloc] init];
+        NSMenuItem* service_menu_item = [[NSMenuItem alloc] initWithTitle:@"Services" action:nil keyEquivalent:@""];
+        [service_menu_item setSubmenu: service_menu];
+        [appleMenu addItem: service_menu_item];
+        [NSApp setServicesMenu: service_menu];
+        
+        [appleMenu addItem:[NSMenuItem separatorItem]];
+
+        title = [@"Hide " stringByAppendingString:appName];
+        [appleMenu addItemWithTitle:title action:@selector(hide:) keyEquivalent:@/*"h"*/"h"];
+
+        menuItem = (NSMenuItem *)[appleMenu addItemWithTitle:@"Hide Others" action:@selector(hideOtherApplications:) keyEquivalent:@/*"h"*/""];
+        [menuItem setKeyEquivalentModifierMask:(NSAlternateKeyMask|NSCommandKeyMask)];
+
+        [appleMenu addItemWithTitle:@"Show All" action:@selector(unhideAllApplications:) keyEquivalent:@""];
+
+        [appleMenu addItem:[NSMenuItem separatorItem]];
+
+        title = [@"Quit " stringByAppendingString:appName];
+        [appleMenu addItemWithTitle:title action:@selector(terminate:) keyEquivalent:@/*"q"*/"q"];
+        
+        /* Put menu into the menubar */
+        menuItem = [[NSMenuItem alloc] initWithTitle:@"" action:nil keyEquivalent:@""];
+        [menuItem setSubmenu:appleMenu];
+        [[NSApp mainMenu] addItem:menuItem];
+        [menuItem release];
+
+        /* Tell the application object that this is now the application menu */
+        [NSApp setAppleMenu:appleMenu];
+        [appleMenu release];
+
+
+    }
 
 };
-
 
 }