From 061094ae40ce6bf4d3cd5e2cd1979234b4bc1ab8 Mon Sep 17 00:00:00 2001
From: Robert Osfield include/ External includes
+(i.e. files which would be installed in /usr/include)
+ src/ source files (including internal
+includes)
+ src/osgUtil The OSG utility
+library source files.
+ src/osgDB The OSG
+database utility library source files.
+ src/osgText The OSG
+text library source files.
+ src/osgGLUT The OSG GLUT library
+source files.
+ src/osgPlugins/
+Import/Export/Node kit plug-ins to the OSG.
+ src/Demos/ sgv/
+A basic scene graph viewer for the OSG which is loads .osg files and
+above formats.
+ 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)
+ Make/
+Unix platform specific make rules and dependencies.
+ VisualStudio/ MS
+VisualC++ 6.0 Make/Workspace files for Windows.
+ dist/
+Distribution make files for RedHat Linux and IRIX.
+
+
+
diff --git a/doc/demos.html b/doc/demos.html
new file mode 100644
index 000000000..4ce3360f2
--- /dev/null
+++ b/doc/demos.html
@@ -0,0 +1,103 @@
+
+
+ Introduction, distribution contents and contacts
+ User documention
+
+
Installation Contents
+of Distribution Documentation Plugin
+Dependencies Data Sources
+Contacts
+
+
+Contents of distribution
+./ Root directory.
+README text
+bare bones readme file.
+
+
+
COPYING text
+file containing the details of the OSG's Open Source LGPL license.
+
AUTHORS text file
+containing names of contributors to the osg.
+
NEWS text
+file listing coarse grained changes between releases.
+
ChangeLog text file listing
+fine grained changes between releases.
+
TODO text
+file listing left to implement/extend/rewrite.
+
FAQ
+text file listing Frequently asked questions.
+
Makefile Unix makefile.
+
index.html This file!
doc/ Documentation directory
+index.html
+Documentation index
+
+
+
+
osg/
+Scene graph reference guide.
+
osgUtil/
+Scene graph utilities reference guide.
+
osgDB/
+Scene graph database utilities reference guide.
+
osgText/
+Scene graph text reference guide.
+
osgGLUT/
+Simple GLUT based viewer base classes reference guide.include/osg/
+The OSG library header files.
+
+
+
+
include/osgUtil/ The OSG
+Util library header files.
+
include/osgDB/ The
+OSG Database library header files.
+
include/osgText/ The
+OSG text library header files.
+
include/osgGLUT/ The OSG
+GLUT utiltiy library header files.src/osg
+The OSG library source files.
+
+
+
+Contains all core osg classes, including reader/writer support for
+
+the .osg ascii format, and sgi's rgb image format.
+
+Contains useful utility classes such as for setting
+
+up and rendering/draw.
+
+Contains useful utility classes such as for reading
+
+and writing 3D databases and image files.
+
+Contains true type font rendering classes.
+
+Contains basic GLUT viewer base classes used by
+
+demo programs to bring up window and provide keyboard
+
+and mouse interaction.
+
osg/
+.osg native ASCII reader/write plugin.
+
flt/
+.flt Open Flight reader plugin.
+
lib3ds/
+.3ds Auto Studio Maxx reader plugin.
+
lwo/
+.lwo Light Wave binary (.lwo,.lw & .geo) reader plugin.
+
obj/
+.obj Alias Wavefront reader plugin.
+
pfb/
+.pfb (and others) Performer reader and writer plugin.
+
dw/
+.dw Design Workshop reader plugin.
+
rgb/
+.rgb RGB image file format reader plugin.
+
png/
+.png PNG image file format reader plugin.
+
gif/
+.gif GIF image file format reader plugin.
+
jpeg/
+.jpg JPEG image file format reader plugin.
+
pic/
+.pic PIC image file format reader plugin.
+
tga/
+.tga TGA image file format reader plugin.
+
tiff/
+.tif TIFF image file format reader plugin.
+
osgconv/
+A program which reads input files into a single scene graph and outputs
+the results.
+
hangglide/
+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/
+A demonstration of multi-pass stencil buffer based planar reflections.
+
osgimpostor/
+A basic demo to show how to use the osg::Impostor node.
+
osgviews/
+A demo of multiple views of the same or multiple scenes.
+
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)
+
+
+
+Running the demos
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/documentation.html b/doc/documentation.html
new file mode 100644
index 000000000..f2d7d4a2c
--- /dev/null
+++ b/doc/documentation.html
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+
+
+
sgv cow.osg
+ The 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 to display information about the loaded database such as peformance stas, 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 documentaion.
+
+
+
+
sgv -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 variables see the sgv documentaion.
+
+
+
+
hangglide
+ The hang glide demo creates a simple flying site (Don Burns local hang glide site infact!),
+ demonstrating how to create simple terrain, trees and skydomes, and how to implement a simple
+ flight camera manipulator to allow the user to fly around.
+ .
+
+
+
+
osgbillboard lz.rgb
+
+ .
+
+
+
+
osgcube
+
+ .
+
+
+
+
+
osghud glider.osg
+
+ .
+
+
+
+
osgimpostor Town.osg
+
+ .
+
+
+
+
osgreflect cow.osg
+
+ .
+
+
+
+
osgscribe.cow.osg
+
+ .
+
+
+
+
osgstereoimage left.rgb right.rgb
+
+ .
+
+
+
+
osgtext
+
+ .
+
+
+
+
osgtexture lz.rgb reflect.rgb
+
+ .
+
+
+
+
osgviews.cow.osg
+
+ .
+
+
+
+Documentation
+The documentation on the OSG is still in its early stages, and far from
+complete. If you can't find your answers in what documentation there currently
+is, please feel free to post the question on the OSG mailing list.
+sgv
+Documentation on key binding in sgv (Scene Graph Viewer.)
stereo +Details on how to run osg applications in stereo.+
Reference guides (automatically generated using doc++) +
osg/ +core scene graph reference guide. ++
osgUtil/ +scene graph utilities reference guide. +
osgDB/ +scene graph database utilities reference guide. +
osgText/ +scene graph text reference guide. +
osgGLUT/ +simple GLUT based viewer base classes reference guide.
Doxygen-generated tarballs are available for download from the website
+UML Diagrams +
osg +UML diagram of the osg core library ++
osgUtil +UML diagram of the osg utilities library
Mind Maps +
Design +Pattern used in the OSG. ++ + + diff --git a/doc/images/hangglide.jpg b/doc/images/hangglide.jpg new file mode 100644 index 0000000000000000000000000000000000000000..13b48d5072feb2ee99f97610167c1ea189fcfa7c GIT binary patch literal 2504 zcmbW!dpy(o9|!R7Ha2tJGBTFMFxRpTO_Ad=W7S+Ygj4Qkkz7j5B~+3|HJ8{yxeraq z_0aF&B#}6-A&KKMhjKFAlyY>=@A3OR9>2eSzu)Wg_
Mission Statement for OSG.
>j0*b{C(`mikTs~KdXV>qhFkJfH(r^(n;Q}Xusu$h)=f_klD>w|)%
z_S)|&EhVYVV`tRvi&<83q*{f&)!q+Q88Hzcj4kt{iaJzmH7^YI%6E3MjECS#wWItS
zcctPH`dl4FcR`hnp!P>S1I18IW9Xt~V^|{oQ1j?9{q!~k;qxuXjkx=#i<-oaZI@nI
zIiTH&K-VH4xb#nxrDLh(T@$#yqd`Zt6l%?~*0S9|(9~<1TpTa1aa5d#|A+lb$*mWU
zLr1z _c4D@sQ
+The first thing is to select the distribution which suits you, there are binary, development and
+source code distributions, these can be loaded from the
+http://www.openscenegraph.org/download page.
+The latest developments area available as via a nightly tarball or via cvs.
+
+The binary distribution contains just the libraries (.dll's /.so's) and demo executables.
+This is suitable for using the OpenSceneGraph with an application that has already been compiled
+but depends at runtime on the OpenSceneGraph.
+
+The development distribution contains the libraries (.dll's /.so's), demo executabls, include files, and source to
+the demos. This is suitable for using the developers using the OpenSceneGraph.
+
+The source distribution contains the all the source and include files required to build the OpenSceneGraph from
+sratch, and is ideal if you want to learn more about how the scene gaph works, how to extend it, and to track
+down and fix any problems that you come across.
+
+If you are using a source disitribution 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 is dependant upon such as glut, check the
+dependencies list for futher details.
+ A programming guide will be avaialbe in form of a OpenSceneGraph book which is being
written by Don Burns and Robert Osfield, parts of it will be available.online.
Although not directly releated to the OpenSceneGraph, once can learn about scene graph technolgy from
-such sources as the Open Inventor Mentor, and Performer Programming Guides. The later is the closest
-in design/API structure to the OpenSceneGraph.=#2}K&+NiM%*D?w-m`RqhjCE{7WVvOFD@q}hgs4;~
zl%++hZR
zA8_r@p41fo3h
fck@gIQeT5@TZ=T*w7Rt-N1FX*m|YsYQ`Cqj@~X
zjoDu89lUg|GWzZO*U3Im(?vHuzO@v53~sBhnH)(t-Wiv=plPEZs_3Eavws
+
+Getting started
+
+
How to learn to use the OpenSceneGraph
@@ -205,24 +241,38 @@ already adopted their projects, and are from all over the world.
The OpenSceneGraph distribution comes with a reference guide for each of the componet libraries - osg, osgDB,
osgUtil, osgText and osgGLUT, a set of demos - the source of which can be found in src/Demos/.For questions
or help which can't be easily be answered by the reference guide and demo source, one should join the openscene
-gaph mailing list. A programming guide will be avaialbe in form of a OpenSceneGraph book which is being
+gaph mailing list (details below).There is also the beginings of Wiki based FAQ
+which may help answer a few of the common querries.
+
+
+
+The OpenSceneGraph uses OpenGL and does with a deliberately thin layer, making it easy to control the underlying +OpenGL and to extend it with OpenGL extensions. The close tie with OpenGL is also reflected in the nameing +of many of the OpenGL state related classes, the the parameters that they encapsulate and means that knowledge +of OpenGL itself will go a long way to understanding how to get the best out of the OpenSceneGraph. To this +end it is worth obtaining a copy of the OpenGL programming guide - `Red Book` +and OpenGL reference guide 'Blue Book'. The main OpenGL website is also a good source of links and further information. +
For scene graph related questions, bug reports, bug fixes, and general design and development discussion one should -join the OpenSceneGraph-news mailing list. +join the openscenegraph-news mailing list, +and check the the mailing list archives.
Professional support is also available in the form of confidential online, phone and onsite support and -consultancy, for details contact robert@openscengraph.com.
+consultancy, for details contact Robert Osfield at robert@openscenegraph.com.