Futher work on documentation - added seperate context.html, a new demos.html

directory and moved the previous doc/index.html to doc/documentation.html.
This commit is contained in:
Robert Osfield 2002-04-24 13:05:03 +00:00
parent 20b5e59dfd
commit 061094ae40
17 changed files with 373 additions and 8 deletions

166
doc/contents.html Normal file
View File

@ -0,0 +1,166 @@
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.6 [en-gb]C-CCK-MCD NetscapeOnline.co.uk (Win95; I) [Netscape]">
<title>OSG Distribution</title>
</head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#990066" alink="#FF0000">
<img SRC="OpenSceneGraphBanner_Distribution.jpg" height=77 width=640>
<br><a href="install.html">Installation&nbsp;</a>&nbsp;&nbsp; <a href="#Contents of distribution">Contents
of Distribution</a>&nbsp;&nbsp;&nbsp; <a href="documentation.html">Documentation</a>&nbsp;&nbsp;&nbsp;<a href="dependencies.html">Plugin
Dependencies</a>&nbsp;&nbsp; <a href="data.html">Data Sources</a>&nbsp;&nbsp;
<a href="#Contacts">Contacts</a>
<h3>
<a NAME="../Contents of distribution"></a><u>Contents of distribution</u></h3>
./&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Root directory.
<blockquote><tt><a href="../README">README</a>&nbsp;&nbsp;&nbsp;&nbsp; </tt>text
bare bones readme file.
<br><tt><a href="../COPYING">COPYING</a>&nbsp;&nbsp;&nbsp; </tt>text&nbsp;
file containing the details of the OSG's Open Source LGPL license.
<br><tt><a href="../AUTHORS">AUTHORS</a>&nbsp;&nbsp;&nbsp; </tt>text file
containing names of contributors to the osg.
<br><tt><a href="../NEWS">NEWS</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </tt>text
file listing coarse grained changes between releases.
<br><tt><a href="../ChangeLog">ChangeLog</a>&nbsp; </tt>text file listing
fine grained changes between releases.
<br><tt><a href="../TODO">TODO</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </tt>text
file listing&nbsp; left to implement/extend/rewrite.
<br><tt><a href="../FAQ">FAQ</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>text file listing Frequently asked questions.
<br><tt><a href="../Makefile">Makefile</a>&nbsp;&nbsp; </tt>Unix makefile.
<br><tt>index.html </tt>This file!</blockquote>
<p><br><a href="../doc/">doc/</a>&nbsp;&nbsp; Documentation directory
<blockquote><tt><a href="../doc/index.html">index.html</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Documentation index
<br><tt><a href="../doc/doc++/osg/HIER.html">osg/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Scene graph reference guide.
<br><tt><a href="../doc/doc++/osgUtil/HIER.html">osgUtil/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Scene graph utilities reference guide.
<br><tt><a href="../doc/doc++/osgDB/HIER.html">osgDB/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Scene graph database utilities reference guide.
<br><tt><a href="../doc/doc++/osgText/HIER.html">osgText/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Scene graph text reference guide.
<br><tt><a href="../doc/doc++/osgGLUT/HIER.html">osgGLUT/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Simple GLUT based viewer base classes reference guide.</blockquote>
<p><a href="../include/">include/</a>&nbsp;&nbsp;&nbsp;&nbsp; External includes
(i.e. files which would be installed in /usr/include)
<blockquote><tt><a href="../include/osg">include/osg/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>The OSG library header files.
<br><tt><a href="../include/osgUtil">include/osgUtil/</a>&nbsp; </tt>The OSG
Util library header files.
<br><tt><a href="../include/osgDB">include/osgDB/</a>&nbsp;&nbsp;&nbsp; </tt>The
OSG Database library header files.
<br><tt><a href="../include/osgText">include/osgText/</a>&nbsp; </tt>The
OSG text library header files.
<br><tt><a href="../include/osgGLUT">include/osgGLUT/</a>&nbsp; </tt>The OSG
GLUT utiltiy library header files.</blockquote>
<p><a href="../src/">src/</a>&nbsp;&nbsp;&nbsp; source files (including internal
includes)
<blockquote><tt><a href="../src/osg">src/osg</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>The OSG library source files.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Contains all core osg classes, including reader/writer support for
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>the .osg ascii format, and sgi's rgb image format.
<p><tt><a href="../src/osgUtil">src/osgUtil</a>&nbsp; </tt>The OSG utility
library source files.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Contains useful utility classes such as for setting
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>up and rendering/draw.
<p><tt><a href="../src/osgDB">src/osgDB</a>&nbsp;&nbsp;&nbsp; </tt>The OSG
database utility library source files.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Contains useful utility classes such as for reading
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>and writing 3D databases and image files.
<p><tt><a href="../src/osgText">src/osgText</a>&nbsp; </tt>The OSG
text library source files.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Contains true type font rendering classes.
<p><tt><a href="../src/osgGLUT">src/osgGLUT</a>&nbsp; </tt>The OSG GLUT library
source files.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Contains basic GLUT viewer base classes used by
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>demo programs to bring up window and provide keyboard
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>and mouse interaction.
<p><tt><a href="../src/osgPlugins/">src/osgPlugins/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Import/Export/Node kit plug-ins to the OSG.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/osg/">osg/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.osg native ASCII reader/write plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/flt/">flt/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.flt Open Flight reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/lib3ds/">lib3ds/</a>&nbsp;
</tt>.3ds Auto Studio Maxx reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/lwo/">lwo/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.lwo Light Wave binary (.lwo,.lw & .geo) reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/obj/">obj/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.obj Alias Wavefront reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/pfb">pfb/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.pfb (and others) Performer reader and writer plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/dw/">dw/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.dw Design Workshop reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/rgb">rgb/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.rgb RGB image file format reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/png">png/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.png PNG image file format reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/gif">gif/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.gif GIF image file format reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/jpeg/">jpeg/</a>&nbsp;&nbsp;&nbsp;
</tt>.jpg JPEG image file format reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/pic">pic/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.pic PIC image file format reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/tga">tga/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>.tga TGA image file format reader plugin.</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/osgPlugins/tiff">tiff/</a>&nbsp;&nbsp;&nbsp;
</tt>.tif TIFF image file format reader plugin.</tt>
<p><tt><a href="../src/Demos/">src/Demos/</a> <a href="../src/Demos/sgv">sgv/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>A basic scene graph viewer for the OSG which is loads .osg files and
above formats.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgconv">osgconv/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>A program which reads input files into a single scene graph and outputs
the results.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/hangglide/">hangglide/</a>&nbsp;&nbsp;&nbsp;&nbsp;
</tt>A program which of creates a flying site and allows users to fly over
the scene.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgtexture">osgtexture/</a>&nbsp;&nbsp;&nbsp;
</tt>A simple program which demonstrates how to use various textures modes.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgcube/">osgcube/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>A basic animation of an oscillating cube.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgreflect/">osgreflect/</a>&nbsp;&nbsp;&nbsp;
</tt>A demonstration of multi-pass stencil buffer based planar reflections.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgimpostor/">osgimpostor/</a>&nbsp;&nbsp;
</tt>A basic demo to show how to use the osg::Impostor node.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgviews/">osgviews/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>A demo of multiple views of the same or multiple scenes.
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="../src/Demos/osgtext/">osgtext/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>A demo of true type fonts support provided by osgText.
</blockquote>
<p><br><tt><a href="../lib/">lib/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>The local repository for the OSG library and plugins (files to be
installed in /usr/lib/ or<tt> </tt>/usr/local/lib)
<p><tt><a href="../lib/osgPlugins/">lib/osgPlugins/</a>&nbsp; </tt>The local
repository for the OSG plugins (files to be installed in /usr/lib/osgPlugins
or<tt> </tt>/usr/local/lib/osgPlugins)
<p><tt><a href="../bin/">bin/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>The local repository for the OSG binary files (files to be installed
in /usr/bin or /usr/local/bin)
<p><tt><a href="../Make/">Make/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Unix platform specific make rules and dependencies.
<p><tt><a href="../VisualStudio/">VisualStudio/</a>&nbsp;&nbsp;&nbsp; </tt>MS
VisualC++ 6.0 Make/Workspace files for Windows.
<p><tt><a href="../dist/">dist/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</tt>Distribution make files for RedHat Linux and IRIX.
</body>
</html>

103
doc/demos.html Normal file
View File

@ -0,0 +1,103 @@
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.6 [en-gb]C-CCK-MCD NetscapeOnline.co.uk (Win95; I) [Netscape]">
<title>OSG Distribution</title>
</head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#990066" alink="#FF0000">
<img SRC="OpenSceneGraphBanner_Distribution.jpg" height=77 width=640>
<h2>
<a NAME="Running the demos"></a><u>Running the demos</u></h2>
<table>
<tr>
<td><img src="images/sgv_cow.jpg" width=128 height=100 border=0> </td>
<td><b>sgv cow.osg</b></td>
<td>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 <a href="sgv.html">sgv</a> documentaion.</td>
</tr>
<tr>
<td><img src="images/sgv_stereo.jpg" width=128 height=100 border=0> </td>
<td><b>sgv -stereo cessna.osg</b></td>
<td>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 <a href="stereo.html">sgv</a> documentaion.</td>
</tr>
<tr>
<td><img src="images/hangglide.jpg" width=128 height=100 border=0> </td>
<td><b>hangglide</b></td>
<td>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.
.</td>
</tr>
<tr>
<td><img src="images/osgbillboard.jpg" width=128 height=100 border=0> </td>
<td><b>osgbillboard lz.rgb</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgcube.jpg" width=128 height=100 border=0> </td>
<td><b>osgcube</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osghud.jpg" width=128 height=100 border=0> </td>
<td><b>osghud glider.osg</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgimpostor.jpg" width=128 height=100 border=0> </td>
<td><b>osgimpostor Town.osg</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgreflect.jpg" width=128 height=100 border=0> </td>
<td><b>osgreflect cow.osg</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgscribe.jpg" width=128 height=100 border=0> </td>
<td><b>osgscribe.cow.osg</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgstereoimage.jpg" width=128 height=100 border=0> </td>
<td><b>osgstereoimage left.rgb right.rgb</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgtext.jpg" width=128 height=100 border=0> </td>
<td><b>osgtext</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgtexture.jpg" width=128 height=100 border=0> </td>
<td><b>osgtexture lz.rgb reflect.rgb</b></td>
<td>
.</td>
</tr>
<tr>
<td><img src="images/osgviews.jpg" width=128 height=100 border=0> </td>
<td><b>osgviews.cow.osg</b></td>
<td>
.</td>
</tr>
</table>
</body>
</html>

46
doc/documentation.html Normal file
View File

@ -0,0 +1,46 @@
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.75C-SGI [en] (X11; I; IRIX64 6.5 IP27) [Netscape]">
<title>OSG Documentation</title>
</head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000EE" vlink="#551A8B" alink="#FF0000">
<img SRC="OpenSceneGraphBanner_Distribution.jpg" height=77 width=640>
<h1>
<b><i><u>Documentation</u></i></b></h1>
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.
<p><u><a href="../index.html">Introduction, distribution contents and contacts</a></u>
<p><u>User documention</u>
<blockquote><a href="sgv.html">sgv</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Documentation on key binding in sgv (Scene Graph Viewer.)</blockquote></p>
<blockquote><a href="stereo.html">stereo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Details on how to run osg applications in stereo.</blockquote></p>
<p><u>Reference guides (automatically generated using doc++)</u>
<blockquote><a href="doc++/osg/HIER.html">osg/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
core scene graph reference guide.
<br><a href="doc++/osgUtil/HIER.html">osgUtil/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
scene graph utilities reference guide.
<br><a href="doc++/osgDB/HIER.html">osgDB/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
scene graph database utilities reference guide.
<br><a href="doc++/osgText/HIER.html">osgText/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
scene graph text reference guide.
<br><a href="doc++/osgGLUT/HIER.html">osgGLUT/</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
simple GLUT based viewer base classes reference guide.</blockquote>
<p>Doxygen-generated tarballs are available for <a href="http://www.openscenegraph.org/download/dox/">download</a> from the website</p>
<p><u>UML Diagrams</u>
<blockquote><a href="UML/osg.png">osg</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
UML diagram of the osg core library
<br><a href="UML/osgutils.png">osgUtil</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
UML diagram of the osg utilities library</blockquote></p>
<p><u>Mind Maps</u>
<blockquote><a href="MindMaps/DesignPatterns/DesignPatterns.html">Design
Pattern used in the OSG.</a>
<br><a href="MindMaps/Mission/Mission.html">Mission Statement for OSG.</a></blockquote></p>
</body>
</html>

BIN
doc/images/hangglide.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
doc/images/osgbillboard.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

BIN
doc/images/osgcube.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

BIN
doc/images/osghud.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

BIN
doc/images/osgimpostor.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

BIN
doc/images/osgreflect.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

BIN
doc/images/osgscribe.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

BIN
doc/images/osgtext.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

BIN
doc/images/osgtexture.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

BIN
doc/images/osgviews.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

BIN
doc/images/sgv_cow.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
doc/images/sgv_stereo.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

View File

@ -147,7 +147,7 @@ and bring in user data with a very small amount of code.
platform speciific dependancy, requiring little more than Standard C++ and OpenGL. platform speciific dependancy, requiring little more than Standard C++ and OpenGL.
The has allowed the scene graph to be rapidly ported on wide range of platforms - The has allowed the scene graph to be rapidly ported on wide range of platforms -
originally developed on IRIX, then ported to Linux, then to Windows, then FreeBSD, then Mac OSX originally developed on IRIX, then ported to Linux, then to Windows, then FreeBSD, then Mac OSX
and most recently Solaris! Being completely windowing system independant it easy and most recently Solaris! Being completely windowing system independant makes it easy
for users to add their own window specific libraries and applications on top. for users to add their own window specific libraries and applications on top.
In the distribution there is aleady the osgGLUT library, and in the Bazaar found In the distribution there is aleady the osgGLUT library, and in the Bazaar found
at openscenegrph.org/download/ once can find examples of how applications written at openscenegrph.org/download/ once can find examples of how applications written
@ -160,7 +160,7 @@ ontop Qt, MFC, WxWindows and SDL. Users have also integrated it with Motif, and
</p> </p>
<i>Scalability</i> - the scene graph not only runs from portables all the way up <i>Scalability</i> - the scene graph not only runs from portables all the way up
to Onyx Infinite Reality Monsters, it supports the multiple graphics subsystems to Onyx Infinite Reality Monsters, it supports the multiple graphics subsystems
found on the machines like the a mulitpipe Onyx. This is possible since the core scene found on machines like the a mulitpipe Onyx. This is possible since the core scene
graph supports multiple graphics context for both OpenGL DisplayLists and texture objects, graph supports multiple graphics context for both OpenGL DisplayLists and texture objects,
and the cull and draw traversals have been designed to cache rendering data locally and and the cull and draw traversals have been designed to cache rendering data locally and
use the scene gaph almost entirely as a read only operation. This allows multiple use the scene gaph almost entirely as a read only operation. This allows multiple
@ -197,6 +197,42 @@ scene graphs. Numerous companies, university researchers and graphics enthusasts
already adopted their projects, and are from all over the world. already adopted their projects, and are from all over the world.
</p> </p>
<hr>
<h2>Getting started</h2>
<p>
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
<a href="http://www.openscenegraph.org/download">http://www.openscenegraph.org/download</a> page.
The latest developments area available as via a nightly tarball or via cvs.
</p>
<p>
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.
</p>
<p>
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.
</p>
<p>
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.
</p>
<p>
If you are using a source disitribution then read the <a href="install.html">installation</a> 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
<a href="dependencies.html">dependencies</a> list for futher details.
</p>
<hr> <hr>
<h2>How to learn to use the OpenSceneGraph</h2> <h2>How to learn to use the OpenSceneGraph</h2>
@ -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, 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 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 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 <a href="http://www.c2.com/cgi/wiki?OpenSceneGraphFaq">Wiki based FAQ</a>
which may help answer a few of the common querries.
<p>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. written by Don Burns and Robert Osfield, parts of it will be available.online.
</p> </p>
<p> <p>
Although not directly releated to the OpenSceneGraph, once can learn about scene graph technolgy from 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 such sources as the <a href="http://www.sgi.com/software/inventor/manuals.html">Open Inventor Mentor</a>, and <a href="http://www.cineca.it/manuali/Performer/ProgGuide24/html"> Performer Programming Guides</a>.
in design/API structure to the OpenSceneGraph.</p> The later is the closest in design concepts to the OpenSceneGraph, although Performer manuals is in C alas.
</p>
<p>
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 - <a href="http://fly.cc.fer.hr/~unreal/theredbook/">`Red Book`</a>
and OpenGL reference guide 'Blue Book'. The main <a href="http://www.opengl.org">OpenGL website</a> is also a good source of links and further information.
</p>
<hr> <hr>
<h2>Support and discussion - the OpenSceneGraph-news mailing list</h2> <h2>Support and discussion - the <i>openscenegraph-news</i> mailing list</h2>
<p> <p>
For scene graph related questions, bug reports, bug fixes, and general design and development discussion one should 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 <a href="http://lists.sourceforge.net/mailman/listinfo/openscenegraph-news">openscenegraph-news</a> mailing list,
and check the the mailing list <a href="http://www.geocrawler.com/redir-sf.php3?list=openscenegraph-news">archives</a>.
</p> </p>
<p> <p>
Professional support is also available in the form of confidential online, phone and onsite support and Professional support is also available in the form of confidential online, phone and onsite support and
consultancy, for details contact robert@openscengraph.com.</p> consultancy, for details contact Robert Osfield at <a href="mailto:robert@openscenegraph.com">robert@openscenegraph.com</a>.</p>
</body> </body>
</html> </html>