[tubras] r1895 committed - irrB doc updates.
tub...@googlecode.com
Author: pc0der
Date: Sun Jan 1 18:40:37 2012
Log: irrB doc updates.
http://code.google.com/p/tubras/source/detail?r=1895
Added:
/trunk/tools/irrb/doc/_static/img016.png
Modified:
/trunk/tools/irrb/doc/iwalktest.rst
=======================================
--- /dev/null
+++ /trunk/tools/irrb/doc/_static/img016.png Sun Jan 1 18:40:37 2012
Binary file, no diff available.
=======================================
--- /trunk/tools/irrb/doc/iwalktest.rst Mon Sep 26 10:03:18 2011
+++ /trunk/tools/irrb/doc/iwalktest.rst Sun Jan 1 18:40:37 2012
@@ -1,33 +1,40 @@
-=====================
-iwalktest Integration
-=====================
+============
+Walk Testing
+============
.. toctree::
:maxdepth: 2
-irrB integrates an optional utility named "iwalktest" which allows you
-to view and walk through your freshly exported scene using the Irrlicht
-engine. iwalktest is currently available to execute on both the
-Windows and Linux platforms.
-
-Instructions on iwalktest installation and usage may be found here: irrB
Utilities
-
-The "Walk Test" GUI button will only appear in irrB's GUI if the following
conditions are met:
-
-1. The "IWALKTEST" OS environment variable is defined.
-
-2. The irrB "Create Scene File" toggle button is selected.
-
-With these conditions met, it's simply a matter of selecting the "Walk
Test"
-toggle button to view your scene immediately after exporting.
-
-After you export a scene for the first time, a "Run Walk Test" push button
will appear
-at the bottom of the irrB interface. Clicking on this button will
re-execute iwalktest
-with the last scene exported.
-
-If you prefer to run a different application other than "iwalktest.exe",
you may
-do so by setting the "IWALKTEST" environment variable to point to your own
application.
-
+**irrB** contains an option to execute an application which may be used
+to view and walk test your freshly exported scene. You may use your own
custom
+application for walk testing or you may use the "**iwalktest**"
application that
+was written specifically to work with **irrB** and also uses Irrlicht for
+rendering.
+
+Instructions on installing and using **iwalktest** may be found
here: :doc:`irrB Utilities </utilities>`
+
+.. container:: irrb-right
+
+ .. image:: _static/img016.png
+
+The "Walktest" GUI button will only appear in **irrB**'s export sub-panel
if the
+following conditions are met:
+
+ 1. The "IWALKTEST" OS environment variable is defined.
+
+ 2. The **irrB** "Scene" option (Export Scene) is selected in the export
sub-panel.
+
+With these conditions met, it's simply a matter of selecting the "Walktest"
+option to view your scene immediately after exporting.
+
+After you export a scene for the first time, a "Walktest" push button will
appear
+underneath the "Export" button.. Clicking on this button will re-execute
the
+defined walk test application with the last scene exported.
+
+----
+
+Walktest Setup
+==============
A couple of notes on how irrB executes the external application:
* **irrB** sets the current directory to the directory in which the
external application
@@ -37,3 +44,48 @@
the environment variable contains a "$1", the scene file is substituted
in its
place. A "$2" substitution variable is replaced with value of
the "Output Directory" path.
+----
+
+Walktest Options
+================
+
+Walktest options defined in the **irrB** export sub-panel are saved to
a "configuration"
+file alongside the scene file. This file is named "{Scene Name}.cfg".
For example,
+if you export a scene named "TestScene", the walktest options will be
saved to a
+file named "TestScene.cfg".
+
+The format of walktest configuration file is that of an .ini file.
+
+Sample contents of a configuration file::
+
+ [options]
+ debug = 4
+ console = false
+ velocity = 4.0
+ angularvelocity = 100.0
+ maxvertangle = 80
+ velocitydamp = 0.0
+ defcampos = {0, 5, -50}
+ defcamtarget = {0, 0, 0}
+ showHelpGUI = true
+ showDebugGUI = true
+
+ [video]
+ driver = EDT_OPENGL
+ resolution = 'medium'
+ keepaspect = false
+ colordepth = 32
+ fullscreen = false
+ vsync = true
+ stencilbuffer = true
+ antialias = 4
+
+ [physics]
+ library = Irrlicht
+ broadphase = btDbvt
+ maxSubSteps = 1
+ fixedTimeStep = 60
+ characterWidth = 1.0
+ characterHeight = 2.5
+ characterStepHeight = 0.3499999940395355
+ characterJumpSpeed = 1.5