Changeset 8306

Timestamp:

05/12/08 12:55:55

Author:

robert

Message:

From Eric Sokolowski and Robert Osfield, moved command line option usage setup
from osgviewer example into osg::ArgumentParser? and osgViewer::Viewer to make
them more universally available.

Files:

• OpenSceneGraph/trunk/applications/osgviewer/osgviewer.cpp (modified) (1 diff)
• OpenSceneGraph/trunk/include/osg/ApplicationUsage (modified) (1 diff)
• OpenSceneGraph/trunk/include/osg/ArgumentParser (modified) (1 diff)
• OpenSceneGraph/trunk/src/osg/ArgumentParser.cpp (modified) (1 diff)
• OpenSceneGraph/trunk/src/osgViewer/Viewer.cpp (modified) (1 diff)

OpenSceneGraph/trunk/applications/osgviewer/osgviewer.cpp

@@ -40 +40 @@
-    arguments.getApplicationUsage()->addCommandLineOption("--image <filename>","Load an image and render it on a quad");
-    arguments.getApplicationUsage()->addCommandLineOption("--dem <filename>","Load an image/DEM and render it on a HeightField");
-    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display command line parameters");
-    arguments.getApplicationUsage()->addCommandLineOption("--help-env","Display environmental variables available");
-    arguments.getApplicationUsage()->addCommandLineOption("--help-keys","Display keyboard & mouse bindings available");
-    arguments.getApplicationUsage()->addCommandLineOption("--help-all","Display all command line, env vars and keyboard & mouse bindings.");
-    arguments.getApplicationUsage()->addCommandLineOption("--SingleThreaded","Select SingleThreaded threading model for viewer.");
-    arguments.getApplicationUsage()->addCommandLineOption("--CullDrawThreadPerContext","Select CullDrawThreadPerContext threading model for viewer.");
-    arguments.getApplicationUsage()->addCommandLineOption("--DrawThreadPerContext","Select DrawThreadPerContext threading model for viewer.");
-    arguments.getApplicationUsage()->addCommandLineOption("--CullThreadPerCameraDrawThreadPerContext","Select CullThreadPerCameraDrawThreadPerContext threading model for viewer.");
-
-
-
-
-
-
-
+
+
+
+
-    {
-        arguments.getApplicationUsage()->write(std::cout, helpType);
-        return 1;
-    }
-
-    osgViewer::Viewer viewer(arguments);
-    
-    // report any errors if they have occurred when parsing the program arguments.

OpenSceneGraph/trunk/include/osg/ApplicationUsage

@@ -44 +44 @@
-        enum Type
-        {
+            NO_HELP = 0x0,
-            COMMAND_LINE_OPTION = 0x1,
-            ENVIRONMENTAL_VARIABLE = 0x2,
-
+
+
-        };
-        

OpenSceneGraph/trunk/include/osg/ArgumentParser

@@ -191 +191 @@
-        void writeErrorMessages(std::ostream& output,ErrorSeverity sevrity=BENIGN);
-
+        
+        /** This convinience method handles help requests on the command line.
+          * Return the type(s) of help requested. The return value of this
+          * function is suitable for passing into getApplicationUsage()->write().
+          * If ApplicationUsage::NO_HELP is returned then no help commandline option 
+          * was found on the command line. */
+        ApplicationUsage::Type readHelpType();
+
-  
-  protected:

OpenSceneGraph/trunk/src/osg/ArgumentParser.cpp

@@ -631 +631 @@
-    }
-}
+
+ApplicationUsage::Type ArgumentParser::readHelpType() 
+{
+    getApplicationUsage()->addCommandLineOption("-h or --help","Display command line parameters");
+    getApplicationUsage()->addCommandLineOption("--help-env","Display environmental variables available");
+    getApplicationUsage()->addCommandLineOption("--help-keys","Display keyboard & mouse bindings available");
+    getApplicationUsage()->addCommandLineOption("--help-all","Display all command line, env vars and keyboard & mouse bindings.");
+
+    // if user request help write it out to cout.
+    if (read("--help-all"))             return ApplicationUsage::HELP_ALL;
+    if (read("-h") || read("--help"))   return ApplicationUsage::COMMAND_LINE_OPTION;
+    if (read("--help-env"))             return ApplicationUsage::ENVIRONMENTAL_VARIABLE;
+    if (read("--help-keys"))            return ApplicationUsage::KEYBOARD_MOUSE_BINDING;
+
+    return ApplicationUsage::NO_HELP;
+}

OpenSceneGraph/trunk/src/osgViewer/Viewer.cpp

@@ -44 +44 @@
-
-    constructorInit();
+
+    // Add help for command-line options read here
+    arguments.getApplicationUsage()->addCommandLineOption("--SingleThreaded","Select SingleThreaded threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--CullDrawThreadPerContext","Select CullDrawThreadPerContext threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--DrawThreadPerContext","Select DrawThreadPerContext threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--CullThreadPerCameraDrawThreadPerContext","Select CullThreadPerCameraDrawThreadPerContext threading model for viewer.");
+    arguments.getApplicationUsage()->addCommandLineOption("--clear-color <color>","Set the background color of the viewer in the form \"r,g,b[,a]\".");
+    arguments.getApplicationUsage()->addCommandLineOption("--screen <num>","Set the screen to use when multiple screens are present.");
+    arguments.getApplicationUsage()->addCommandLineOption("--window <x y w h>","Set the position (x,y) and size (w,h) of the viewer window.");
+    // FIXME: Uncomment these lines when the options have been documented properly
+    //arguments.getApplicationUsage()->addCommandLineOption("--3d-sd","");
+    //arguments.getApplicationUsage()->addCommandLineOption("--panoramic-sd","");
+    //arguments.getApplicationUsage()->addCommandLineOption("--radius","");
+    //arguments.getApplicationUsage()->addCommandLineOption("--collar","");
+    //arguments.getApplicationUsage()->addCommandLineOption("--im","");
-    
-    std::string filename;