3D Raum

• 1: Home
• 2: API Documentation
  • 2.1: OpenSceneGraph
    • 2.1.1: With Diagrams
    • 2.1.2: With Graphs
    • 2.1.3: Archive
  • 2.2: Delta3D
    • 2.2.1: With Diagrams
    • 2.2.2: With Graphs
    • 2.2.3: Archive
  • 2.3: Screenshots
• 3: Samples
  • 3.1: Qt
    • 3.1.1: Qt Samples
  • 3.2: VB.NET
    • 3.2.1: Life
  • 3.3: OpenGL
    • 3.3.1: GLUT
    • 3.3.2: GLUT Samples
  • 3.4: Cinema4D
  • 3.5: Resourcepointers
  • 3.6: References
• 4: Links
  • 4.1: Programming
• 5: Info
  • 5.1: News
  • 5.2: Contact
  • 5.3: Support
• 6: Sitemap

API Documentation

Here you can download API reference documentation for several open source 3D scene graphs and game engines in different formats. Usually there's an API reference available from the particular web site, mostly in plain HTML format. What you get here are additional media formats as well as variations of how contents is worked up. As compared to the API documentation provided with the libraries these documents offer easy printing or search capabilities.

Media Formats

• HTML with a tree-like index structure to display hierarchical contents information.
• HTML Help with a tree-like index structure to display hierarchical contents information, an index and search capability. This format is for the Windows platform only.
  
• PDF for viewing in a PDF reader and mostly suited for printing. Also has search capability.
• Hyperlinked PDF as a platform independent alternative to HTML Help. Contains links just like the HTML based formats instead of page references and a tree-like index structure to display hierarchical contents information. This makes it suitable for online browsing using a PDF viewer.

Please note that the HTML format is always packed into a single zip-archive since a documentation can consist of several hundred separate files.

See the Support page if you cannot view the topics in a downloaded .chm file (HTML Help file).

The links to "Related Pages" in the current documentation files are broken due to a Doxygen malfunction.

Contents

There is a separate document for each individual library of a particular toolkit. They aren't interlinked with the documents of the other libraries within the same toolkit.

Although Doxygen (see below) supports interlinking with its "tag file" mechanism for references to external documentation this feature is avoided because its getting a bit complicated here. Instead a xxxALL document is provided which contains all libraries of a certain toolkit (the xxx prefix denotes the toolkit in question). In case the media format supports hyperlinking the xxxALL document has links crossing library boundaries thus "everything is linked with everything". Besides being big in size the xxxALL document shows documented entities with their full class and namespace scopes making it more complex to read at first sight.

There are two main differences of how code structures are graphically presented in the API references. All documents exist in both of these variants.

• With diagrams shows an inheritance diagram for classes with base or super classes. For daily programming this type of illustration is sufficient.
• With graphs shows for each documented class the direct and indirect implementation dependencies (inheritance, containment, and class reference variables) of the class with other documented classes. This type of illustration can help in getting an overview of the code base and relevant dependencies.

Source Code Browsing

For programming against a certain toolkit the description of classes, functions and the like is sufficient, there's no need of insight into the API code (information hiding, encapsulation, Geheimnisprinzip are the catch words here). But for tasks such as finding errors or learning how to program from others the source must be at hand. Therefore the HTML and HTML Help formatted API documentations are also available with source browsing capability where documented entities are cross-referenced with their sources to facilitate code analysis. Source code embedded in the documentation has numbered lines of code for easy reference and documented entities are back-linked from source to the API reference description. For clarity the documentations with source browsing have .Brwse inserted into their filenames.

Toolbox

The documents are generated by Doxygen from the source code, thus completeness and accuracy lies in the hands of the creative programmers and how much effort they put into commenting their code. Furthermore the generator tools have some flaws and produce minor mistakes in some outputs.

Images for class diagrams or dependency graphs are created by Doxygen with the help of the dot tool which is part of the Graphviz visualization software.

Post processing is done with the Microsoft HTML Help Compiler for HTML Help, the standard help system for the Windows platform, and with MiKTeX for all PDF's.

A huge thanks to those who provide these wonderful tools!

In Case of Problems

If you encounter any problems with your download then don't hesitate to contact me.