From 9d28cf2e8f4cae49fd9dd87f864852ba2de3d820 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Fri, 11 Apr 2003 10:37:31 +0000 Subject: [PATCH] Fixes to documentions to refelect the move from osgGLUT to osgProducer. --- AUTHORS.txt | 6 ++- INSTALL.txt | 10 ++-- NEWS.txt | 11 ++++- README.txt | 2 +- doc/contents.html | 45 +++++++++--------- doc/data.html | 4 +- doc/dependencies.html | 14 +++--- doc/documentation.html | 10 ++-- doc/{demos.html => examples.html} | 42 +++++++--------- doc/images/{sgv_cow.jpg => osgviewer_cow.jpg} | Bin .../{sgv_stereo.jpg => osgviewer_stereo.jpg} | Bin doc/images/{osgviews.jpg => osgwindows.jpg} | Bin doc/index.html | 10 ++-- doc/install.html | 18 +++---- doc/introduction.html | 14 +++--- doc/{sgv.html => osgviewer.html} | 12 ++--- doc/plan.html | 8 ++-- doc/stereo.html | 16 +++---- 18 files changed, 115 insertions(+), 107 deletions(-) rename doc/{demos.html => examples.html} (85%) rename doc/images/{sgv_cow.jpg => osgviewer_cow.jpg} (100%) rename doc/images/{sgv_stereo.jpg => osgviewer_stereo.jpg} (100%) rename doc/images/{osgviews.jpg => osgwindows.jpg} (100%) rename doc/{sgv.html => osgviewer.html} (95%) diff --git a/AUTHORS.txt b/AUTHORS.txt index 702c59b1c..050cedd63 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -130,7 +130,11 @@ Vladimir Vukicevic Rune Schmidt Jensen - dds loader. - + +Romano José Magacho da Silva + - pause/resume in osgGA::AnimationPathManipulator + - support for managing deleted vertex programs in osg::VertexProgram. + Indirect Contributors --------------------- diff --git a/INSTALL.txt b/INSTALL.txt index fdf140cb5..c6218e635 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -3,8 +3,12 @@ read doc/install.html. Quick hints for Unix (including Mac OSX and Cygwin): - make - to make the disitribtion. + gmake - to make the disitribtion. - make install - to intall the disitrubion (defaults to /usr/local/) + gmake install - to intall the disitrubion (defaults to /usr/local/) - make help - for list of make instructions. + gmake help - for list of make instructions. + +Note, the OpenSceneGraph's Make system requires the use of GNU gmake, on +OSX, Linux and FreeBSD this is the default make, but on Solaris and IRIX +you may need to download & install it. diff --git a/NEWS.txt b/NEWS.txt index dbe33edae..49bbf21b6 100644 --- a/NEWS.txt +++ b/NEWS.txt @@ -47,10 +47,19 @@ OSG News (most significant items from ChangeLog) New osg::TextureRectangle texture class which encapsulates the NV_texture_rectangle and EXT_texture_rectange extensions. - Added automatic subloading of textures when images are updated. + Added automatic subloading of textures when image data is updated. Added the option of automatic unref'ing of texture image data once the data has been download to OpenGL to active graphics contexts. + + New osg::ArgumentParser and osg::ApplicationUsage classes for + convineiently and robustly parsing command line arguments and + report command line usage, environmental variables and + keyboard and mouse bindings used by applications. Running any + of the examples with -h or --help will report full details example + usage. Keyboard and Mouse bindings usage is now also available as + a HUD on all examples, simply press 'h' while the app is runing to + bring up help. New database cache in the osgDB library. diff --git a/README.txt b/README.txt index 11840cf48..c0045776b 100644 --- a/README.txt +++ b/README.txt @@ -1,7 +1,7 @@ Welcome to the OpenSceneGraph (OSG). For information on the project, this distribtion, how to compile and -run libraries and demos, and for documention see open up index.html +run libraries and examples, and for documention open up index.html in your perfered html browser. Robert Osfield. diff --git a/doc/contents.html b/doc/contents.html index 23d5a76e4..7b70b02fa 100644 --- a/doc/contents.html +++ b/doc/contents.html @@ -15,9 +15,9 @@ Contents Install Dependencies - Demos + examples Data - Viewer + Viewer Stereo Plan Reference Guides @@ -39,7 +39,7 @@ file listing coarse grained changes between releases. file with notes on how to install the osg.
ChangeLog  text file listing fine grained changes between releases. -
Makefile   Unix makefile. +
GNUMakefile   Unix GNU makefile.
index.html This file!


doc/   Documentation directory @@ -53,8 +53,8 @@ fine grained changes between releases. Scene graph database utilities reference guide.
osgText/         Scene graph text reference guide. -
osgGLUT/         -Simple GLUT based viewer base classes reference guide. +
osgProducer/         +Simple Producer based viewer base classes reference guide.

include/     External includes @@ -67,8 +67,8 @@ Util library header files. OSG Database library header files.
include/osgText/  The OSG text library header files. -
include/osgGLUT/  The OSG -GLUT utiltiy library header files. +
include/osgProducer/  The OSG +Producer utiltiy library header files.

src/    source files (including internal @@ -95,10 +95,10 @@ database utility library source files. text library source files.
              Contains true type font rendering classes. -

src/osgGLUT  The OSG GLUT library +

src/osgProducer  The OSG Producer library source files.
              -Contains basic GLUT viewer base classes used by +Contains basic Producer viewer base classes used by
              demo programs to bring up window and provide keyboard
              @@ -133,35 +133,34 @@ source files. .tga TGA image file format reader plugin.
           tiff/    .tif TIFF image file format reader plugin. -

src/Demos/ sgv/           +

examples/ osgviewer/           A basic scene graph viewer for the OSG which is loads .osg files and above formats. -
           osgconv/       +
           osgconv/       A program which reads input files into a single scene graph and outputs the results. -
           hangglide/     +
           osghangglide/     A program which of creates a flying site and allows users to fly over the scene. -
           osgtexture/    -A simple program which demonstrates how to use various textures modes. -
           osgcube/       -A basic animation of an oscillating cube. -
           osgreflect/    +
           osgtexture1D/    +A simple program which demonstrates how to use 1D textures. +
           osgtexture2D/    +A simple program which demonstrates how to use 2D textures . +
           osgtexture3D/    +A simple program which demonstrates how to use 3D textures. +
           osgreflect/    A demonstration of multi-pass stencil buffer based planar reflections. -
           osgimpostor/   +
           osgimpostor/   A basic demo to show how to use the osg::Impostor node. -
           osgviews/      +
           osgwindows/      A demo of multiple views of the same or multiple scenes. -
           osgtext/       +
           osgtext/       A demo of true type fonts support provided by osgText.


lib/             The local repository for the OSG library and plugins (files to be installed in /usr/lib/ or /usr/local/lib) -

lib/osgPlugins/  The local -repository for the OSG plugins (files to be installed in /usr/lib/osgPlugins -or /usr/local/lib/osgPlugins)

bin/             The local repository for the OSG binary files (files to be installed in /usr/bin or /usr/local/bin) diff --git a/doc/data.html b/doc/data.html index 26f194d54..f86f454d6 100644 --- a/doc/data.html +++ b/doc/data.html @@ -15,9 +15,9 @@ Contents Install Dependencies - Demos + examples Data - Viewer + Viewer Stereo Plan Reference Guides diff --git a/doc/dependencies.html b/doc/dependencies.html index 17fdb434b..d40c652a5 100644 --- a/doc/dependencies.html +++ b/doc/dependencies.html @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -39,7 +39,7 @@ The OpenSceneGraph is composed of core scene graph libraries, plugins libraries and demo programs. The core scene graph libraries (osg, osgDB, osgUtil) are only dependent upon OpenGL and Standard C++ so should compile straight out of the box on most systems. To run the demos one will also need to -compile osgGLUT which adds the dependency of GLUT, and if true type text +compile osgProducer which adds the dependency of Producer, and if true type text is required then the freetype library will be required. The plugins which are used to read and write various file formats have their own sets of dependencies listed below, some have no dependencies at all. A plugin is @@ -67,9 +67,9 @@ and dll.

  • -GLUT include, lib and dll.
    • +Producer include, lib and dll. - +
    @@ -84,9 +84,9 @@ library.
  • -src/osgGLUT - The osgGLUT library depends upon, you guessed it, glut...
    • +src/osgProducer - The osgProducer library depends upon, you guessed it, Producer... - +
    diff --git a/doc/documentation.html b/doc/documentation.html index 1a2ed6e02..97e11d01c 100644 --- a/doc/documentation.html +++ b/doc/documentation.html @@ -1,4 +1,4 @@ - +d @@ -16,9 +16,9 @@ Contents Install Dependencies - Demos + examples Data - Viewer + Viewer Stereo Plan Reference Guides @@ -46,8 +46,8 @@ scene graph text reference guide. scene graph visual simulation library reference guide.
    osgGA/         scene graph gui abstraction reference guide. -
    osgGLUT/      -simple GLUT based viewer base classes reference guide. +
    osgProducer/      +simple Producer based viewer base classes reference guide.

    Doxygen-generated tarballs are available for download from the website

    UML Diagrams

    osg                diff --git a/doc/demos.html b/doc/examples.html similarity index 85% rename from doc/demos.html rename to doc/examples.html index 0e421e779..1969605ce 100644 --- a/doc/demos.html +++ b/doc/examples.html @@ -3,7 +3,7 @@ - Demos + examples @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -34,7 +34,7 @@

    -Running the demos

    +Running the examples Once the OpenSceneGraph is installed you will need place the location where it was installed on the you systems paths environmental variables, and then download the demo @@ -72,24 +72,24 @@ it will either run, or provide help on what options it accepts.
      - + - + - +the osgviewer documentation. - + - + - - - - - - - - - @@ -206,11 +198,11 @@ texture parameters, including anisotrophic filtering and texture compression!&nb - + - + - +
    sgv cow.osgosgviewer cow.osgThe scene graph viewer demo uses osgGLUT::Viewer to bring up a basic -viewer. To find out what command line arguments it takes simply run sgv -without any arguments. To load a model simple run sgv filename.ext. The -osgGLUT::Viewer provides an extensive set of operations that can be used +The scene graph viewer demo uses osgProducer::Viewer to bring up a basic +viewer. To find out what command line arguments it takes simply run osgviewer +without any arguments. To load a model simple run osgviewer filename.ext. The +osgProducer::Viewer provides an extensive set of operations that can be used to display information about the loaded database such as performance stats, through to output a snapshot of the screen, which is how these thumbnails were created. For a full list of key presses and mouse interaction read -the sgv documentation.
    sgv -stereo cessna.osgosgviewer --stereo cessna.osg The scene graph viewer also supports anaglyphic, quad buffered, and split screen stereo modes, for a full list of options and environmental @@ -117,20 +117,12 @@ by the OpenSceneGraph. Billboards are typically used for trees or particles effects. 
    osgcubeSimplest of all demos, create a cube geometry and spin it! 
    osghud glider.osgVery similar to the basic sgv demo, but adds an orthographic projection +Very similar to the basic osgviewer demo, but adds an orthographic projection over the top of the main 3D view to create a head up display effect. Also demonstrates how to use osgText. .
    osgviews.cow.osgosgwindows cow.osgAn example of multiple viewports all running at once. An example of multiple windows all running at once. 
    diff --git a/doc/images/sgv_cow.jpg b/doc/images/osgviewer_cow.jpg similarity index 100% rename from doc/images/sgv_cow.jpg rename to doc/images/osgviewer_cow.jpg diff --git a/doc/images/sgv_stereo.jpg b/doc/images/osgviewer_stereo.jpg similarity index 100% rename from doc/images/sgv_stereo.jpg rename to doc/images/osgviewer_stereo.jpg diff --git a/doc/images/osgviews.jpg b/doc/images/osgwindows.jpg similarity index 100% rename from doc/images/osgviews.jpg rename to doc/images/osgwindows.jpg diff --git a/doc/index.html b/doc/index.html index b9ee2a273..4f7a2bf73 100644 --- a/doc/index.html +++ b/doc/index.html @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -64,7 +64,7 @@ to download them. -Demos +examples Thumbnails and info on all the demo applications which come with this distribution. @@ -78,9 +78,9 @@ from. -Viewer +Viewer -List of key bindings support by the osgGLUT::Viewer and hence sgv and +List of key bindings support by the osgProducer::Viewer and hence osgviewer and the rest of demos. diff --git a/doc/install.html b/doc/install.html index 8a4514598..dd2fdfc5a 100644 --- a/doc/install.html +++ b/doc/install.html @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -37,14 +37,14 @@ Compiling and installing the OpenSceneGraph The scene graph depends upon Standard C++, STL and OpenGL so you need a C++ compiler up to the task and OpenGL or Mesa installed. The viewer depends -upon GLUT which you'll need to download and install from the GLUT website. +upon Producer which you'll need to download and install from the Producer website. The OSG has it own native ascii file format, and .rgb image reader inbuilt which allows you read the example data with any dependencies other than C++, STL and OpenGL.

    The osgText library adds the dependency of the freetype library for support of true type fonts, however it is not essential to the core library, so you can comment it out from compilation by modifying the src/Makefile, -and src/Demos/Makefile. I you wish to use fonts then you can download freetype +and examples/Makefile. I you wish to use fonts then you can download freetype from www.freetype.org. The osgText library also requires an up to date GLU implementation which supports GLU1.2 tessellation routines. If you your current GLU is out of date you'll need to download the latest, for @@ -125,17 +125,17 @@ Visual Studio6.0 + Dinkumware's STL bug fix patches (see details below). Visual Studio6.0 + STLport (see details below)

    The OSG is composed of a number of scene graph libraries (with Core in -front of the project names), executables (with Demos in front of the project +front of the project names), executables (with examples in front of the project names), and plugins which read and write 3D data formats and 2D image formats (with osgPlugins in front of the project names). -To get the OSG running you'll need at least to compile Core osg,osgUtil,osgDB,osgGLUT, -osgPlugin dot_osg and Demo sgv. The rest of the libraries and executables +To get the OSG running you'll need at least to compile Core osg,osgUtil,osgDB,osgProducer, +osgPlugin dot_osg and Demo osgviewer. The rest of the libraries and executables are optional and can be compiled if you need them, however for simplicity I would recommend doing a batch build of all the libraries and executables in the distribution, some of the plug-ins which support non native file formats may not compile due to dependencies on other libraries (such as libpng), you can ignore these compilation errors unless you need to load -the related file types. To help the compilation the plugins, osgGLUT and +the related file types. To help the compilation the plugins, osgProducer and osgText one can download .zip archive will all the dependencies in it. Further details on this .zip file can be found in dependencies.html @@ -309,7 +309,7 @@ For anyone who's ever used a Unix box for development, well, the mac and running under Mac OS X. The main requirement is that you need to have installed the Developer tools from the CD that comes for free with OS X. This gives you compilers, headers, frameworks - stuff -like GLUT and Carbon for developers. Get those here: +like Producer and Carbon for developers. Get those here:

    • The Apple diff --git a/doc/introduction.html b/doc/introduction.html index df3cd52f3..8ec5a5f9b 100644 --- a/doc/introduction.html +++ b/doc/introduction.html @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -150,7 +150,7 @@ ported to a wide range of platforms - originally developed on IRIX, then ported to Linux, then to Windows, then FreeBSD, then Mac OSX and most recently Solaris! Being completely windowing system independent makes it easy for users to add their own window-specific libraries and applications on top. -In the distribution there is already the osgGLUT library, and in the Bazaar +In the distribution there is already the osgProducer library, and in the Bazaar found at openscenegrph.org/download/ one can find examples of applications written on top of Qt, MFC, WxWindows and SDL. Users have also integrated it with Motif, and X. @@ -209,17 +209,17 @@ to track down and fix any problems that you come across.

      If you are using a source distribution then read the installation instructions for how to get the OpenSceneGraph compiling and installed on your system. You may also need to download libraries that parts of the -OpenSceneGraph depend upon, such as glut. Check the dependencies +OpenSceneGraph depend upon, such as Producer. Check the dependencies list for further details. -

      For full instructions of how to run the demos read the demos +

      For full instructions of how to run the demos read the demos page.

      Learning how to use the OpenSceneGraph

      The OpenSceneGraph distribution comes with a reference guide for each of -the component libraries - osg, osgDB, osgUtil, osgText, osgParticle and osgGLUT, a set -of demos - the source of which can be found in src/Demos. For questions +the component libraries - osg, osgDB, osgUtil, osgText, osgParticle and osgProducer, a set +of demos - the source of which can be found in examples. For questions or help which can't be easily be answered by the reference guide and demo source, one should join the mailing list (details below). There are also the beginnings of a Wiki diff --git a/doc/sgv.html b/doc/osgviewer.html similarity index 95% rename from doc/sgv.html rename to doc/osgviewer.html index c65ea06a3..8352dc134 100644 --- a/doc/sgv.html +++ b/doc/osgviewer.html @@ -16,16 +16,16 @@ Contents Install Dependencies - Demos + Demos Data - Viewer + Viewer Stereo Plan Reference Guides -

      osgGLUT::Viewer / Scene Graph Viewer (sgv) keyboard bindings:

      +

      osgProducer::Viewer / Scene Graph Viewer (osgviewer) keyboard bindings:


      @@ -253,7 +253,7 @@ x and mouse y position and delete the nearest interesected geoset.
      '?'/'h'
      - + @@ -262,7 +262,7 @@ x and mouse y position and delete the nearest interesected geoset. @@ -281,7 +281,7 @@ the window and leaves the window's borders.
      Esc 
      - +
      Print out sgv's keyboard bindings.Print out osgviewer's keyboard bindings.
      -
      Toggle between fullscreen and the previous window size. Note GLUT +
      Toggle between fullscreen and the previous window size. Note Producer fullscreen works properly on Windows and Irix, but on Linux it just maximizes the window and leaves the window's borders.
      		   Exit sgv.  Exit osgviewer.
      diff --git a/doc/plan.html b/doc/plan.html index 58f3fcd5b..3ff9bb5cc 100644 --- a/doc/plan.html +++ b/doc/plan.html @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -61,8 +61,8 @@ osgSim - cross platform library for the visual simulation market with support fo small target anti-aliasing, geometry correction and clip mapping.

    • -Replace osgGLUT with Open Producer for the demos. Open Producer is a much cleaner and more scalable -windowing API. Move osgGLUT out of the distribution and into the bazaar.
      • +Replace osgProducer with Open Producer for the demos. Open Producer is a much cleaner and more scalable +windowing API. Move osgProducer out of the distribution and into the bazaar.
    • Introduce a new library osgEnv/osgShapes, which adds support for creating diff --git a/doc/stereo.html b/doc/stereo.html index 14f831c32..d2535ce85 100644 --- a/doc/stereo.html +++ b/doc/stereo.html @@ -19,11 +19,11 @@ Dependencies -Demos +examples Data -Viewer +Viewer Stereo @@ -43,7 +43,7 @@ potential for stereo support simply by setting the relevant environmental variables, or via command line arguments. Little or no code changes will be required, the support is handled transparently inside osgUtil::SceneView's handling of rendering. It is a simple as: -
          sgv -stereo cow.osg +
          osgviewer --stereo cow.osg

      If the user is planning to use head tracked stereo, or a cave then it is currently recommend to set it up via a VR toolkit such as VRjuggler, in this case refer to the VR toolkits handling of stereo, and keep all @@ -246,19 +246,19 @@ Command line arguments can be used to override these settings:

      Examples:

      To invoke stereo from the comandline: -
          sgv -stereo cow.osg +
          osgviewer -stereo cow.osg

      To invoke quad buffered stereo from the commandline: -
          sgv -stereo QUAD_BUFFER cow.osg +
          osgviewer -stereo QUAD_BUFFER cow.osg

      To force all apps to start up in quad buffered stereo (if system supports it)
          export OSG_STEREO=ON
          export OSG_STEREO_MODE=QUAD_BUFFER -
          sgv cow.osg +
          osgviewer cow.osg

      To set quad buffered stereo to the default, but use the commandline to switch stereo on:
          export OSG_STEREO=OFF
          export OSG_STEREO_MODE=QUAD_BUFFER -
          sgv -stereo cow.osg +
          osgviewer -stereo cow.osg

      @@ -284,7 +284,7 @@ achieve this then the object will be perceived as at infinity.

      Camera Manipulator Modes:

      There are three osgUtil::CameraManipulator's which come with osgUtil, which -operate as a Trackball, Drive and Flight modes of interaction (see sgv.html +operate as a Trackball, Drive and Flight modes of interaction (see osgviewer.html for how to invoke them in the scene graph viewer). The osgUtil::Trackball Manipulator automatically scales the fusion distance to that which will fusion on center point of rotation - this will appear at the middle of