diff --git a/doc/contents.html b/doc/contents.html deleted file mode 100644 index cdfb9105d..000000000 --- a/doc/contents.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - Contents of Distribution - - - - - - - - - - - - - - - - - - - -
Index Introduction Contents Install Dependencies examples Data Viewer Stereo osgdemPlan Reference Guides
- - -

Contents of distribution

-./        Root directory. -
README     text -bare bones readme file. -
LICENSE    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. -
INSTALL    text -file with notes on how to install the osg. -
ChangeLog  text file listing -fine grained changes between releases. -
GNUMakefile   Unix GNU 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. -
osgProducer/         -Simple Producer based viewer base classes reference guide.
- - -

include/     External includes -(i.e. files which would be installed in /usr/include) -

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/osgProducer/  The OSG -Producer utiltiy library header files.
- - -

src/    source files (including internal -includes) -

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. -

src/osgUtil  The OSG utility -library source files. -
              -Contains useful utility classes such as for setting -
              -up and rendering/draw. -

src/osgDB    The OSG -database utility library source files. -
              -Contains useful utility classes such as for reading -
              -and writing 3D databases and image files. -

src/osgText  The OSG -text library source files. -
              -Contains true type font rendering classes. -

src/osgProducer  The OSG Producer library -source files. -
              -Contains basic Producer viewer base classes used by -
              -demo programs to bring up window and provide keyboard -
              -and mouse interaction. -

src/osgPlugins/     -Import/Export/Node kit plug-ins to the OSG. -
           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. -

examples/ osgviewer/           -A basic scene graph viewer for the OSG which is loads .osg files and -above formats. -
           osgconv/       -A program which reads input files into a single scene graph and outputs -the results. -
           osghangglide/     -A program which of creates a flying site and allows users to fly over -the scene. -
           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/   -A basic demo to show how to use the osg::Impostor node. -
           osgwindows/      -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) -

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/dependencies.html b/doc/dependencies.html deleted file mode 100644 index e161d9b53..000000000 --- a/doc/dependencies.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - Compilation dependencies - - - - - - - - - - - - - - - - - - - - -
IndexIntroductionContentsInstallDependenciesexamplesDataViewerStereoosgdemPlanReference Guides
-

Scene graph dependencies

-The OpenSceneGraph is composed of core scene graph libraries, plugins -libraries and demo programs. The core scene graph libraries (osg, -osgDB, osgUtil, -osgText, osgParticle, osgSim) are only dependent upon OpenGL and -Standard -C++ so should compile straight out of the box on most systems. To run -the -examples one will also need to 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 only needed if you need to load that specific file -format, -so it is not critical if you don't have all the required dependencies.
-
-Under UNIX you can take advantage of flexibility in the build system -that allows you to manually define the external dependencies that are -installed on your system.  To override the default dependencies -copy the Make/dependencies file to a directory of choosing, and then -point to this file by setting the OSG_DEPENDENCIES environmental -variable to point to this file.  Then edit this file to reflect -which dependencies are present. i.e
-
-    cd /home/osguser/OpenSceneGraph
-    cp Make/dependencies my_custom_osg_dependencies
-    export -OSG_DEPENDENCIES=/home/osguser/OpenSceneGraph/my_custom_osg_dependencies
-    myfavorite-editor my_custom_osg_dependencies
-
-When editing the file, simple change the no to yes, and visa-versa -where apporpriate.
-
-
-

Windows dependency -archives

-To make life easier for Windows users, we have put together a .zip -archives with all the required dependencies which can be download and -installed somewhere in you system. You'll need to set VisualStudio to -pick up on the include and -libs, and the PATH set to pick up in the dll's. Alternatively, a more -hacky -but simpler solution is to unpack this archive inside you -OpenSceneGraph distribution, -so that all the include files drop into OpenSceneGraph/include, and the -libs drop into OpenSceneGraph/lib, and all the dll's drop into -OpenSceneGraph/bin, this way VisualStudio will pick up the files -simpler through the paths set up inside the workspace and project -files. The archives can be downloaded here: . . - - -
-
- -