|
         
|
DocumentationDirect link to our TUTORIAL.
There are three levels of documentations, to answer three different levels of questions that arise when working with a system: How?Which parameters does this method have? What methods are there anyway? We use doxygen to create the HTML documentation for these kinds of questions directly from the code. If you have doxygen, you can create the doc by calling make doc from the toplevel directory. Note that the default configuration expects to find the dot graph tool, see Prerequisites for details. If you don't have doxygen you can browse the documentation online stable or you download it stable (.tar.gz, 33.72 mb) . What?What does the system do? What are the objects that it has, and in which respects are they different from other scenegraph systems? These questions are answered in the Starter Guide (.pdf, 1.91 mb) . There are two version of the Starter Guide now, one for users (.tar.gz, 31.88 mb) and one for developers (.tar.gz, 33.72 mb) . The developer version contains more of our internal classes and tries to explian more of the internal workings of the system. There is also a version in windows help (.chm, 42.81 mb) format. The Starter Guide gives a quick overview of the system and its concepts. It is not a general tutorial kind of introduction, rather it assumes that the reader is familiar with C++ and graphics in general, and it would help if he has used another scenegraph system before and just wants to know what the specific approaches and differences of OpenSG are. You can read it even if that doesn't apply to you, but don't expect to understand everything. ;) It is definitely not a beginners introduction to computer graphics, realtime graphics or scenegraphs. OpenGL.org has a lot of info on these subjects. It is created via doxygen, just like the standard documentation, using the userstarter and devstarter targets. It actually is part of the doxygen documentation in teh Related pages section. Why?Why did you do it like that? What about other approaches? The design document is there to answer these questions. Unfortunately it is not quite up-to-date right now. The basic premises are still valid, but the implementation has surpassed it in a number of detail aspects. It will be updated later. The design document is just a simple HTML file and is in the
Doc/design directory or online
|
|
|
