Changeset 19884

Timestamp:

03/25/07 18:07:21 (1 year ago)

Author:

patrick

Message:

Here is almost everything that I have been working on for adding Cocoa
support to VR Juggler. At this point, the pending bugs in Ticket #3 still
exist, but I have workarounds in place for those related to OpenGL views.
The code is not yet hooked up to the build, and pending changes to
vrj::Kernel to use the new CocoaWrapper? class have not been committed.
Furthermore, an important change to vpr::Thread still needs some work, and
without that, this code will not compile let alone function. Finally, there
are some minor changes that need to be made to the test and sample
applications that are not included with this revision.

Ultimately, I wanted to get some revision control behind these files since
I have been working on them for many weeks without it.

Files:

• juggler/trunk/modules/vrjuggler/data/bundle (added)
• juggler/trunk/modules/vrjuggler/data/bundle/Info.plist (added)
• juggler/trunk/modules/vrjuggler/data/bundle/InfoPlist.strings (added)
• juggler/trunk/modules/vrjuggler/data/bundle/MainMenu.nib (added)
• juggler/trunk/modules/vrjuggler/data/bundle/MainMenu.nib/classes.nib (added)
• juggler/trunk/modules/vrjuggler/data/bundle/MainMenu.nib/info.nib (added)
• juggler/trunk/modules/vrjuggler/data/bundle/MainMenu.nib/keyedobjects.nib (added)
• juggler/trunk/modules/vrjuggler/data/bundle/vrjuggler.icns (added)
• juggler/trunk/modules/vrjuggler/data/bundle/vrjuggler.plist (added)
• juggler/trunk/modules/vrjuggler/mtree/VJ.data.dist.in (modified) (1 diff)
• juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlDrawManager.cpp (modified) (2 diffs)
• juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlExtensionLoader.cpp (modified) (1 diff)
• juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlViewCocoa.h (modified) (3 diffs)
• juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlViewCocoa.mm (modified) (16 diffs)
• juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlWindowCocoa.h (added)
• juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlWindowCocoa.mm (added)
• juggler/trunk/modules/vrjuggler/vrj/Kernel/CocoaWrapper.h (added)
• juggler/trunk/modules/vrjuggler/vrj/Kernel/CocoaWrapper.mm (added)

juggler/trunk/modules/vrjuggler/mtree/VJ.data.dist.in

@@ -33 +33 @@
-.
-    data
+        bundle
+            MainMenu.nib
+            ..
+        ..
-        configFiles
-        ..

juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlDrawManager.cpp

@@ -496 +496 @@
-#  include <vrj/Draw/OGL/GlWindowWin32.h>
-#elif defined(VPR_OS_Darwin) && ! defined(VRJ_USE_X11)
-OSX
+Cocoa
-#else
-#  include <vrj/Draw/OGL/GlWindowXWin.h>
@@ -509 +509 @@
-   return GlWindowPtr(new vrj::GlWindowWin32);
-#elif defined(VPR_OS_Darwin) && ! defined(VRJ_USE_X11)
-OSX
+Cocoa
-#else
-   return GlWindowPtr(new vrj::GlWindowXWin);

juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlExtensionLoader.cpp

@@ -26 +26 @@
-
-#include <vrj/Draw/OGL/GlExtensionLoader.h>
-
+
+
-#include <vpr/Util/Debug.h>
-
-
+
+
+
+
+
-
-#if !defined(WIN32) && !defined(VPR_OS_Darwin)

juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlViewCocoa.h

@@ -36 +36 @@
-
-/**
-is
-designed to be used as a subview for InputViewCocoa from Gadgeteer. This
-holds a pointer back to the vrj::GlWindowCocoa object that keeps track of
-an NSWindow instance for which this object is a view. This view will updat
-the state of the vrj:GlWindowCocoa object as appropriate, usually as a
-result of resize 
+must be
+the content view for an NSWindow instance. This holds a pointer back to the
+vrj::GlWindowCocoa object that keeps track of an NSWindow instance for
+which this object is a view. This view will update the state of th
+vrj:GlWindowCocoa object as appropriate, usually as a result of resize
+
- *
-18
+21
- */
-@interface GlViewCocoa : NSOpenGLView
-{
-   vrj::GlWindowCocoa* mVrjWindow;      /**< The window using this view. */
+
+   /** @name Full Screen State */
+   //@{
+   /** Indicates whether this view is in a full screen window. */
+   BOOL mFullScreen;
+
+   /**
+    * The Core Graphics display ID for the screen on which this view is
+    * rendered.
+    */
+   CGDirectDisplayID mDisplayID;
+
+   NSDictionary* mOrigDisplayMode;
+   //@}
+
+   /**
+    * Indicates whether this view should handle keyboard and mouse events.
+    * If so, they are handed off to \c mVrjWindow (as subclass of
+    * gadget::InputAreaCocoa).
+    */
+   BOOL mHandleInput;
+
+   /**
+    * Indicates whether the mouse cursor should be hidden whenever the mouse
+    * is within the tracking rectnagle of this view.
+    */
+   BOOL mShouldHideCursor;
-
-   /**
@@ -64 +91 @@
-    * use of the NSOpenGLView initWithFrame:pixelFormat: initializer.
-    *
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-    *
-    * @return self on successful initialization or nil on failure.
@@ -78 +107 @@
-   -(id) initWithFrame:(NSRect) frameRect
-              glWindow:(vrj::GlWindowCocoa*) window
-
+
+
-@end

juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/GlViewCocoa.mm

@@ -35 +35 @@
-#import <AppKit/NSOpenGL.h>
-#import <AppKit/NSScreen.h>
+#import <AppKit/NSWindow.h>
-#import <AGL/agl.h>
-
@@ -46 +47 @@
-   -(void) clearTrackingRect;
-   -(void) resetTrackingRect;
-
+
+
-@end
-
@@ -54 +56 @@
-              glWindow:(vrj::GlWindowCocoa*) window
-                screen:(NSScreen*) screen
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-      if ( pixel_format == nil )
@@ -75 +87 @@
-
-      vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_CONFIG_LVL)
-
-std::endl << 
+ << std::endl
+
-
-      self = [super initWithFrame:frameRect
-                      pixelFormat:pixel_format];
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-         [[self openGLContext] setFullScreen];
-      }
-
-      return self;
+   }
+
+   -(void) dealloc
+   {
+      [mOrigDisplayMode release];
+      [super dealloc];
+   }
+
+   -(void) reshape
+   {
-   }
-/*
@@ -98 +135 @@
-//      mVrjWindow->updateOriginSize(bounds.origin.x, bounds.origin.y,
-//                                   bounds.size.width, bounds.size.height);
+//      mVrjWindow->setDirtyViewport(true);
-   }
-*/
+   /** @name NSResponder overrides */
+   //@{
-   /**
-    * Indicates whether this object can take on the first responder role for
@@ -134 +174 @@
-
-   /**
-
+
+
+
+
-    */
-   -(void) viewWillMoveToWindow:(NSWindow*) newWindow
@@ -144 +187 @@
-   /**
-    * Adds a tracking rectangle to this view if it needs one for mouse cursor
-
+ and/or input handling
-    */
-   -(void) viewDidMoveToWindow
@@ -150 +193 @@
-      [super viewDidMoveToWindow];
-      [self resetTrackingRect];
+
+      // If this view was moved to a new window, determine if the mouse is
+      // currently within the bounds of this view. If it is, then we post a
+      // fake mouseEntered event to inform this view that the mouse is within
+      // it. Without this, the user would have to move the mouse out of the
+      // window and back in to get the mouseEntered event to be posted.
+      if ( [self window] )
+      {
+         const NSPoint mouse_loc =
+            [[self window] mouseLocationOutsideOfEventStream];
+         const NSRect bounds = [self bounds];
+
+         if ( [self mouse:mouse_loc inRect:bounds] )
+         {
+            [self mouseEntered:nil];
+         }
+      }
+      // This view has been removed from its window, so we need to clean up
+      // its state.
+      else
+      {
+         [NSOpenGLContext clearCurrentContext];
+         [[self openGLContext] clearDrawable];
+
+         if ( mFullScreen )
+         {
+            CGDisplaySwitchToMode(mDisplayID,
+                                  (CFDictionaryRef) mOrigDisplayMode);
+            CGDisplayErr err = CGDisplayRelease(mDisplayID);
+
+            if ( err != CGDisplayNoErr )
+            {
+               vprDEBUG(vprDBG_ALL, vprDBG_WARNING_LVL)
+                  << "GlViewCocoa failed to release display "
+                  << std::hex << mDisplayID << std::dec << std::endl
+                  << vprDEBUG_FLUSH;
+            }
+         }
+      }
-   }
-
@@ -158 +240 @@
-   -(void) viewWillStartLiveResize
-   {
+      mVrjWindow->acquireRenderLock();
+
-      [super viewWillStartLiveResize];
-
-VrjWindow->getDisplay()->shouldHideMouse()
+ShouldHideCursor
-      {
-         [NSCursor unhide];
-      }
+   }
+
+   -(void) viewDidEndLiveResize
+   {
+      vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL)
+         << "GlViewCocoa viewDidEndLiveResize" << std::endl << vprDEBUG_FLUSH;
+      mVrjWindow->releaseRenderLock();
+      [super viewDidEndLiveResize];
-   }
-
@@ -172 +264 @@
-   -(void) mouseEntered:(NSEvent*) theEvent
-   {
-
+
+
+
+
+
+
+
-      [super mouseEntered:theEvent];
-   }
@@ -182 +280 @@
-   -(void) mouseExited:(NSEvent*) theEvent
-   {
-
+
+
+
+
+
+
+
+
+
+
-      [super mouseExited:theEvent];
-   }
-
+   /**
+    * Responds to mouse movement. This is only invoked if the mouse is inside
+    * the tracking rectangle for this view and \c mHandleInput is YES.
+    */
+   -(void) mouseMoved:(NSEvent*) theEvent
+   {
+      mVrjWindow->addMouseMoveEvent(theEvent);
+   }
+
+   /**
+    * Responds to mouse movement while the left button is pressed. This is
+    * only invoked if the mouse is inside the tracking rectangle for this view
+    * and \c mHandleInput is YES.
+    */
+   -(void) mouseDragged:(NSEvent*) theEvent
+   {
+      mVrjWindow->addMouseMoveEvent(theEvent);
+   }
+
+   /**
+    * Responds to mouse left button press.
+    */
+   -(void) mouseDown:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addMouseButtonEvent(gadget::MBUTTON1,
+                                         gadget::MouseButtonPressEvent,
+                                         theEvent);
+      }
+      else
+      {
+         [super mouseDown:theEvent];
+      }
+   }
+
+   /**
+    * Responds to mouse left button release.
+    */
+   -(void) mouseUp:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addMouseButtonEvent(gadget::MBUTTON1,
+                                         gadget::MouseButtonReleaseEvent,
+                                         theEvent);
+      }
+      else
+      {
+         [super mouseUp:theEvent];
+      }
+   }
+
+   /**
+    * Responds to mouse movement while the right button is pressed. This is
+    * only invoked if the mouse is inside the tracking rectangle for this view
+    * and \c mHandleInput is YES.
+    */
+   -(void) rightMouseDragged:(NSEvent*) theEvent
+   {
+      mVrjWindow->addMouseMoveEvent(theEvent);
+   }
+
+   /**
+    * Responds to mouse right button press.
+    */
+   -(void) rightMouseDown:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addMouseButtonEvent(gadget::MBUTTON2,
+                                         gadget::MouseButtonPressEvent,
+                                         theEvent);
+      }
+      else
+      {
+         [super rightMouseDown:theEvent];
+      }
+   }
+
+   /**
+    * Responds to mouse right button release.
+    */
+   -(void) rightMouseUp:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addMouseButtonEvent(gadget::MBUTTON2,
+                                         gadget::MouseButtonReleaseEvent,
+                                         theEvent);
+      }
+      else
+      {
+         [super rightMouseUp:theEvent];
+      }
+   }
+
+   /**
+    * Responds to mouse movement while a button other than the left or the
+    * right is pressed. This is only invoked if the mouse is inside the
+    * tracking rectangle for this view and \c mHandleInput is YES.
+    */
+   -(void) otherMouseDragged:(NSEvent*) theEvent
+   {
+      mVrjWindow->addMouseMoveEvent(theEvent);
+   }
+
+   /**
+    * Responds to mouse button press other than the right or the left.
+    */
+   -(void) otherMouseDown:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addMouseButtonEvent(gadget::MouseButtonPressEvent,
+                                         theEvent);
+      }
+      else
+      {
+         [super otherMouseDown:theEvent];
+      }
+   }
+
+   /**
+    * Responds to mouse button release other than the right or the left.
+    */
+   -(void) otherMouseUp:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addMouseButtonEvent(gadget::MouseButtonReleaseEvent,
+                                         theEvent);
+      }
+      else
+      {
+         [super otherMouseUp:theEvent];
+      }
+   }
+
+   /**
+    * Responds to scroll wheel use.
+    */
+   -(void) scrollWheel:(NSEvent*) theEvent
+   {
+      // Add a mouse button event.
+   }
+
+   /**
+    * Responds to a key press.
+    */
+   -(void) keyDown:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addKeyEvent(gadget::KeyPressEvent, theEvent);
+      }
+      else
+      {
+         [super keyDown:theEvent];
+      }
+   }
+
+   /**
+    * Responds to a key release.
+    */
+   -(void) keyUp:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->addKeyEvent(gadget::KeyReleaseEvent, theEvent);
+      }
+      else
+      {
+         [super keyUp:theEvent];
+      }
+   }
+
+   /**
+    * Responds to a change in the keyboard modifier flags.
+    */
+   -(void) flagsChanged:(NSEvent*) theEvent
+   {
+      if ( mHandleInput )
+      {
+         mVrjWindow->flagsChanged(theEvent);
+      }
+      else
+      {
+         [super flagsChanged:theEvent];
+      }
+   }
+   //@}
+
+   /**
+    * Invoked whenever the window containing this view is moved or resized.
+    * The job of this method is to update the tracking rectangle for this
+    * view.
+    */
-   -(void) resetCursorRects
-   {
-      vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL)
-         << "GlViewCocoa resetCursorRects" << std::endl << vprDEBUG_FLUSH;
+//      mVrjWindow->acquireRenderLock();
-      [super resetCursorRects];
+
+      // Clear the current tracking rectnagle and define a new one based on
+      // our new bounds.
-      [self resetTrackingRect];
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-   -(void) clearTrackingRect
-   {
@@ -206 +526 @@
-   }
-
+   /**
+    * Sets a new tracking rectangle for this view. If this view already has a
+    * tracking rectangle, the existing one is removed first.
+    *
+    * @post This view has a tracking rectangle whose ID is stored in
+    *       \c mTrackingRect.
+    */
-   -(void) resetTrackingRect
-   {
-      [self clearTrackingRect];
-
-, then w
-create a tracking rectangle that is the size of this view. Then, th
-NSResponder overrides of -mouseEntered: and -mouseExited: will be
-
-VrjWindow->getDisplay()->shouldHideMouse()
+ or we ar
+handling input, then we create a tracking rectangle that is the siz
+of this view. Then, the NSResponder overrides of -mouseEntered: and
+-mouseExited: will be 
+ShouldHideCursor || mHandleInput
-      {
-         mTrackingRect = [self addTrackingRect:[self visibleRect]
@@ -228 +555 @@
-    * vrj::Display object associated with \c mVrjWindow.
-    */
-:(NSScreen*) screen
-
-*
+
+
+Ptr
-      jccl::ConfigElementPtr gl_fb_elt = display->getGlFrameBufferConfig();
-
@@ -356 +683 @@
-      }
-
-      const bool full_screen = display->isFullScreen();
-
-      std::vector<NSOpenGLPixelFormatAttribute> attr_vec;
-
-full_s
+mFullS
-      {
-         attr_vec.push_back(NSOpenGLPFAFullScreen);
-         attr_vec.push_back(NSOpenGLPFAScreenMask);
-         NSNumber* screen_num =
-            [[screen deviceDescription] objectForKey:@"NSScreeNumber"];
-         _CGDirectDisplayID* gl_id =
-            reinterpret_cast<_CGDirectDisplayID*>([screen_num intValue]);
-         attr_vec.push_back(
-            static_cast<NSOpenGLPixelFormatAttribute>(
-gl_id
+mDisplayID
-            )
-         );
+         attr_vec.push_back(NSOpenGLPFAAllRenderers);
-      }
-      else
@@ -380 +702 @@
-
-      attr_vec.push_back(NSOpenGLPFADoubleBuffer);
+      attr_vec.push_back(NSOpenGLPFAAccelerated);
-      attr_vec.push_back(NSOpenGLPFAColorSize);
-      attr_vec.push_back(
@@ -454 +777 @@
-            mVrjWindow->setInStereo(true);
-         }
+
+         // If we reached this point, we still do not have a usable pixel
+         // format. Disabling the alpha channel may give us something usable.
+         vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_CRITICAL_LVL)
+            << "WARNING: Could not get an OpenGL visual with a color buffer\n";
+         vprDEBUG_NEXTnl(vrjDBG_DRAW_MGR, vprDBG_CRITICAL_LVL)
+            << "         alpha channel; trying without.\n" << vprDEBUG_FLUSH;
+
+         attr_vec[alpha_attrib_index] =
+            static_cast<NSOpenGLPixelFormatAttribute>(0);
+
+         pixel_format = [[NSOpenGLPixelFormat alloc] initWithAttributes:attrs];
+
+         if ( pixel_format != nil )
+         {
+            return pixel_format;
+         }
-      }
-
-      return pixel_format;
-   }
+
+   -(CGDirectDisplayID) getDisplayID:(NSScreen*) screen
+   {
+      NSNumber* screen_num =
+         [[screen deviceDescription] objectForKey:@"NSScreeNumber"];
+      return reinterpret_cast<CGDirectDisplayID>([screen_num intValue]);
+   }
+   //@}
-@end