Changeset 6901 for OpenSceneGraph/trunk/examples/osgviewerCocoa/ViewerCocoa.mm

Timestamp:

06/08/07 12:16:33 (6 years ago)

Author:

robert

Message:

From Eric Wing, "So, something strange happened to the repo and some of this project's
files got messed up, most notiably the Nib and also the Localized
strings file. I didn't notice the latter until now so Martin is
missing this file.

Anyway, the attached tar contains all new versions of all the
necessary files. There are cleanups and fixes to a lot of things.
Martin did a good job porting the thing to osg::Viewer so most of the
code changes I made address other areas.

Two things I noticed in the new port you might want to consider as
feedback. First, there might be a bug with osgViewer when the view
size goes to 0. If you play with the splitviews in this program and
shrink the view until it is closed, and then re-expand it, the model
doesn't come back, not even after a home() call. SimpleViewer? didn't
have this problem.

Second, a more minor thing, this program has a
take-screenshot--and-copy-to-clipboard feature via Cmd-C (or Menu
item). I achieve this by using osg::Camera to render to an FBO and
then copy the contents to Cocoa. To insert the camera, I manipulate
the scenegraph so I can get the camera node in and out. I end up
calling setSceneData at the end of eveything to restore everything to
the original state before I started mucking with the scenegraph. This
unfortunately, triggers a home() reset. So in this particular case, it
make Copy look like it's changing the scene. The old SimpleViewer? had
the same problem, but I was able to work around it by directly
invoking the underlying SceneView?'s setSceneData so the home()
mechanism was bypassed. The viewer design seems to protect this data
more carefully so the bypass trick won't work. My feedback is that
maybe a flag or extra parameter can be introduced so a reset is not
triggered if not desired.

I have checked in a ton of Xcode fixes for the entire build process in
general so once this piece gets checked in, hopefully everything will
build cleanly."

Files:

• OpenSceneGraph/trunk/examples/osgviewerCocoa/ViewerCocoa.mm (modified) (37 diffs)

OpenSceneGraph/trunk/examples/osgviewerCocoa/ViewerCocoa.mm

@@ -268 +268 @@
 
 //      osg::setNotifyLevel( osg::DEBUG_FP );
-        Viewer = new osgViewer::Viewer;
-        graphicsWindow = Viewer->setUpViewerAsEmbeddedInWindow(0,0,800,800);
+        theViewer = new osgViewer::Viewer;
+        graphicsWindow = theViewer->setUpViewerAsEmbeddedInWindow(0,0,740,650); // numbers from Nib
         // Builts in Stats handler
-        Viewer->addEventHandler(new osgViewer::StatsHandler);
+        theViewer->addEventHandler(new osgViewer::StatsHandler);
 #ifdef VIEWER_USE_SHARED_CONTEXTS
         // Workaround: osgViewer::Viewer automatically increments its context ID values.
@@ -281 +281 @@
 
         // Cocoa follows the same coordinate convention as OpenGL. osgViewer's default is inverted.
-        Viewer->getEventQueue()->getCurrentEventState()->setMouseYOrientation(osgGA::GUIEventAdapter::Y_INCREASING_UPWARDS);
+        theViewer->getEventQueue()->getCurrentEventState()->setMouseYOrientation(osgGA::GUIEventAdapter::Y_INCREASING_UPWARDS);
         // Use a trackball manipulator...matches nicely with the Mighty Mouse Scrollball.
-        Viewer->setCameraManipulator(new osgGA::TrackballManipulator);
+        theViewer->setCameraManipulator(new osgGA::TrackballManipulator);
         
 }
@@ -326 +326 @@
         [animationTimer invalidate];
         [animationTimer release];
-        delete Viewer;
-        Viewer = NULL;
+        delete theViewer;
+        theViewer = NULL;
         [super dealloc];
 }
@@ -333 +333 @@
 - (void) finalize
 {
-        delete Viewer;
-        Viewer = NULL;
+        delete theViewer;
+        theViewer = NULL;
         [super finalize];
 }
@@ -358 +358 @@
         // See Technical Note TN2085 Enabling multi-threaded execution of the OpenGL framework
         // http://developer.apple.com/technotes/tn2006/tn2085.html
+        // For this simple viewer, you are probably not going to see a speed boost, but possibly a speed hit,
+        // since we probably don't have much data to dispatch,
+        // but it is enabled anyway for demonstration purposes.
         uint64_t num_cpus = 0;
         size_t num_cpus_length = sizeof(num_cpus);
         // Multithreaded engine only benefits with muliple CPUs, so do CPU count check
+        // I've been told that Apple has started doing this check behind the scenes in some version of Tiger.
         if(sysctlbyname("hw.activecpu", &num_cpus, &num_cpus_length, NULL, 0) == 0)
         {
@@ -367 +371 @@
                 {
                         // Cleared to enable multi-threaded engine
-                        CGLError error_val = CGLEnable((CGLContextObj)[[self openGLContext] CGLContextObj], kCGLCEMPEngine);
+                        // kCGLCEMPEngine may not be defined before certain versions of Tiger/Xcode,
+                        // so use the numeric value 313 instead to keep things compiling.
+                        CGLError error_val = CGLEnable((CGLContextObj)[[self openGLContext] CGLContextObj], static_cast<CGLContextEnable>(313));
                         if(error_val != 0)
                         {
@@ -423 +429 @@
         the_geode->addDrawable(default_text.get());
 
-        Viewer->setSceneData(the_geode.get());
+        theViewer->setSceneData(the_geode.get());
 }
 
@@ -458 +464 @@
 - (void) prepareForMiniaturization:(NSNotification*)notification
 {
+        [[self openGLContext] makeCurrentContext];
         NSBitmapImageRep* ns_image_rep = [self renderOpenGLSceneToFramebuffer];
         if([self lockFocusIfCanDraw])
@@ -518 +525 @@
     NSPoint converted_point = [self convertPoint:the_point fromView:nil];
         
-        Viewer->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
+        theViewer->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
         [self setNeedsDisplay:YES];
 }
@@ -556 +563 @@
     NSPoint converted_point = [self convertPoint:the_point fromView:nil];
         
-        Viewer->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
+        theViewer->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
         [self setNeedsDisplay:YES];
 }
@@ -591 +598 @@
     NSPoint converted_point = [self convertPoint:the_point fromView:nil];
         
-        Viewer->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
+        theViewer->getEventQueue()->mouseMotion(converted_point.x, converted_point.y);
         [self setNeedsDisplay:YES];
 }
@@ -645 +652 @@
         if([the_event clickCount] == 1)
         {
-                Viewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 1);
+                theViewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 1);
         }
         else
         {
-                Viewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, 1);
+                theViewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, 1);
         }
         [self setNeedsDisplay:YES];
@@ -661 +668 @@
     NSPoint converted_point = [self convertPoint:the_point fromView:nil];
         
-        Viewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 1);
+        theViewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 1);
         [self setNeedsDisplay:YES];
 }
@@ -673 +680 @@
         if([the_event clickCount] == 1)
         {
-                Viewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 3);
+                theViewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 3);
         }
         else
         {
-                Viewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, 3);
+                theViewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, 3);
         }
         [self setNeedsDisplay:YES];
@@ -690 +697 @@
     NSPoint converted_point = [self convertPoint:the_point fromView:nil];
         
-        Viewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 3);
+        theViewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 3);
         [self setNeedsDisplay:YES];
 }
@@ -703 +710 @@
         if([the_event clickCount] == 1)
         {
-                Viewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 2);
+                theViewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 2);
         }
         else
         {
-                Viewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, 2);
+                theViewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, 2);
         }
         [self setNeedsDisplay:YES];
@@ -721 +728 @@
         if([the_event clickCount] == 1)
         {
-                Viewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, button_number+1);
+                theViewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, button_number+1);
         }
         else
         {
-                Viewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, button_number+1);
+                theViewer->getEventQueue()->mouseDoubleButtonPress(converted_point.x, converted_point.y, button_number+1);
         }
         [self setNeedsDisplay:YES];
@@ -737 +744 @@
         NSPoint the_point = [the_event locationInWindow];
         NSPoint converted_point = [self convertPoint:the_point fromView:nil];
-        Viewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 2);
+        theViewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, 2);
         [self setNeedsDisplay:YES];
 }
@@ -747 +754 @@
         NSPoint the_point = [the_event locationInWindow];
         NSPoint converted_point = [self convertPoint:the_point fromView:nil];
-        Viewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, button_number+1);
+        theViewer->getEventQueue()->mouseButtonRelease(converted_point.x, converted_point.y, button_number+1);
         
         [self setNeedsDisplay:YES];
@@ -765 +772 @@
         // The camera manipulators don't seem to implement any code that utilize the scroll values.
         // This this call does nothing.
-//      Viewer->getEventQueue()->mouseScroll2D([the_event deltaX], [the_event deltaY]);
+//      theViewer->getEventQueue()->mouseScroll2D([the_event deltaX], [the_event deltaY]);
 
         // With the absense of a useful mouseScroll2D API, we can manually simulate the desired effect.
         NSPoint the_point = [the_event locationInWindow];
         NSPoint converted_point = [self convertPoint:the_point fromView:nil];
-        Viewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 1);
-        Viewer->getEventQueue()->mouseMotion(converted_point.x + -[the_event deltaX], converted_point.y + [the_event deltaY]);
-        Viewer->getEventQueue()->mouseButtonRelease(converted_point.x + -[the_event deltaX], converted_point.y + [the_event deltaY], 1);
+        theViewer->getEventQueue()->mouseButtonPress(converted_point.x, converted_point.y, 1);
+        theViewer->getEventQueue()->mouseMotion(converted_point.x + -[the_event deltaX], converted_point.y + [the_event deltaY]);
+        theViewer->getEventQueue()->mouseButtonRelease(converted_point.x + -[the_event deltaX], converted_point.y + [the_event deltaY], 1);
 
         [self setNeedsDisplay:YES];
@@ -798 +805 @@
         unichar unicode_character = [event_characters characterAtIndex:0];
 //      NSLog(@"unicode_character: %d", unicode_character);
-        Viewer->getEventQueue()->keyPress(static_cast<osgGA::GUIEventAdapter::KeySymbol>(unicode_character));
+        theViewer->getEventQueue()->keyPress(static_cast<osgGA::GUIEventAdapter::KeySymbol>(unicode_character));
 
         [self setNeedsDisplay:YES];
@@ -809 +816 @@
 //      NSString* event_characters = [the_event charactersIgnoringModifiers];
         unichar unicode_character = [event_characters characterAtIndex:0];
-        Viewer->getEventQueue()->keyRelease(static_cast<osgGA::GUIEventAdapter::KeySymbol>(unicode_character));
+        theViewer->getEventQueue()->keyRelease(static_cast<osgGA::GUIEventAdapter::KeySymbol>(unicode_character));
         [self setNeedsDisplay:YES];
 }
@@ -843 +850 @@
         // This coordinate system conversion seems to make things work with Quartz Debug.
         NSSize size_in_window_coordinates = [self convertSize:size_in_points toView:nil];
-        Viewer->getEventQueue()->windowResize(0, 0, size_in_window_coordinates.width, size_in_window_coordinates.height);
+        theViewer->getEventQueue()->windowResize(0, 0, size_in_window_coordinates.width, size_in_window_coordinates.height);
         graphicsWindow->resized(0, 0, size_in_window_coordinates.width, size_in_window_coordinates.height);
 }
@@ -862 +869 @@
         if([[NSGraphicsContext currentContext] isDrawingToScreen])
         {
-//              [[self openGLContext] makeCurrentContext];
-                Viewer->frame();
+                [[self openGLContext] makeCurrentContext];
+                theViewer->frame();
                 [[self openGLContext] flushBuffer];
         }
         else // This is usually the print case
         {
-//              [[self openGLContext] makeCurrentContext];
+                [[self openGLContext] makeCurrentContext];
 
                 // FIXME: We should be computing a size that fits best to the paper target
@@ -904 +911 @@
         NSSize size_in_points = [self bounds].size;
         NSSize size_in_window_coordinates = [self convertSize:size_in_points toView:nil];
-        const osg::Vec4& clear_color = Viewer->getCamera()->getClearColor();
+        const osg::Vec4& clear_color = theViewer->getCamera()->getClearColor();
 
         return [self renderOpenGLSceneToFramebufferAsFormat:GL_RGB viewWidth:size_in_window_coordinates.width viewHeight:size_in_window_coordinates.height clearColorRed:clear_color[0] clearColorGreen:clear_color[1] clearColorBlue:clear_color[2] clearColorAlpha:clear_color[3]];
@@ -912 +919 @@
 - (NSBitmapImageRep*) renderOpenGLSceneToFramebufferAsFormat:(int)gl_format viewWidth:(float)view_width viewHeight:(float)view_height
 {
-        const osg::Vec4& clear_color = Viewer->getCamera()->getClearColor();
+        const osg::Vec4& clear_color = theViewer->getCamera()->getClearColor();
 
         return [self renderOpenGLSceneToFramebufferAsFormat:gl_format viewWidth:view_width viewHeight:view_height clearColorRed:clear_color[0] clearColorGreen:clear_color[1] clearColorBlue:clear_color[2] clearColorAlpha:clear_color[3]];
@@ -1004 +1011 @@
         NSSize original_size_in_points = [self bounds].size;
         NSSize original_size_in_window_coordinates = [self convertSize:original_size_in_points toView:nil];
-//      Viewer->getEventQueue()->windowResize(0, 0, original_size_in_window_coordinates.width, original_size_in_window_coordinates.height);
-
-        Viewer->getEventQueue()->windowResize(0, 0, viewport_width, viewport_height);
+//      theViewer->getEventQueue()->windowResize(0, 0, original_size_in_window_coordinates.width, original_size_in_window_coordinates.height);
+
+        theViewer->getEventQueue()->windowResize(0, 0, viewport_width, viewport_height);
         graphicsWindow->resized(0, 0, viewport_width, viewport_height);
 
@@ -1025 +1032 @@
          */
         //NSLog(@"Before camera glGetError: %s", gluErrorString(glGetError()));
-        osg::Camera* root_camera = Viewer->getCamera();
+        osg::Camera* root_camera = theViewer->getCamera();
 
         // I originally tried the clone() method and the copy construction, but it didn't work right,
@@ -1049 +1056 @@
         // We need to insert the new (second) camera into the scene (below the root camera) and attach 
         // the scene data to the new camera.
-        osg::ref_ptr<osg::Node> root_node = Viewer->getSceneData();
+        osg::ref_ptr<osg::Node> root_node = theViewer->getSceneData();
 
         the_camera->addChild(root_node.get());
         // Don't call (bypass) Viewer's setSceneData, but the underlying SceneView's setSceneData.
         // Otherwise, the camera position gets reset to the home position.
-        Viewer->setSceneData(the_camera);
+        theViewer->setSceneData(the_camera);
 
         // set the camera to render before the main camera.
@@ -1071 +1078 @@
 
         // Render the scene
-        Viewer->frame();
+        theViewer->frame();
 
         // Not sure if I really need this (seems to work without it), and if so, not sure if I need flush or finish
@@ -1089 +1096 @@
         // Don't call (bypass) Viewer's setSceneData, but the underlying SceneView's setSceneData.
         // Otherwise, the camera position gets reset to the home position.
-        Viewer->setSceneData(root_node.get());
-        Viewer->getEventQueue()->windowResize(0, 0, original_size_in_window_coordinates.width, original_size_in_window_coordinates.height);
+        theViewer->setSceneData(root_node.get());
+        theViewer->getEventQueue()->windowResize(0, 0, original_size_in_window_coordinates.width, original_size_in_window_coordinates.height);
         graphicsWindow->resized(0, 0, original_size_in_window_coordinates.width, original_size_in_window_coordinates.height);
 
@@ -1171 +1178 @@
                         return NO;
                 }
-                Viewer->setSceneData(loaded_model.get());
+                theViewer->setSceneData(loaded_model.get());
                 return YES;
     }
@@ -1190 +1197 @@
                         return NO;
                 }
-                Viewer->setSceneData(loaded_model.get());
+                theViewer->setSceneData(loaded_model.get());
                 return YES;
         }
@@ -1225 +1232 @@
 - (NSData*) dataWithTIFFOfContentView
 {
+        [[self openGLContext] makeCurrentContext];
         NSBitmapImageRep * image = [self renderOpenGLSceneToFramebuffer];
         NSData* data = nil;
@@ -1259 +1267 @@
         // Create the image that will be dragged
         NSString * type = NSTIFFPboardType;
+
+        [[self openGLContext] makeCurrentContext];
 
         // I want two images. One to be rendered for the target, and one as the drag-image.
@@ -1328 +1338 @@
 - (IBAction) resetPosition:(id)the_sender
 {
-        //      osgGA::MatrixManipulator* camera_manipulator = Viewer->getCameraManipulator();
+        //      osgGA::MatrixManipulator* camera_manipulator = theViewer->getCameraManipulator();
         // This only resets the position
         //      camera_manipulator->home(0.0);
         
-        // There is no external API from Viewer that I can see that will stop movement.
+        // There is no external API from SimpleViewer that I can see that will stop movement.
         // So fake the 'spacebar' to stop things and reset.
-        printf("I'am here"); 
-        
-        Viewer->home();
+        // (Changed in Viewer?)
+        //      printf("I'am here"); 
+        
+        // Reset to start position
+        theViewer->home();
         [self setNeedsDisplay:YES];
 }
@@ -1348 +1360 @@
         NSColor* the_color = [the_sender color];
 
-        Viewer->getCamera()->setClearColor(
+        theViewer->getCamera()->setClearColor(
                 osg::Vec4(
                         [the_color redComponent],