[tubras] r1901 committed - and some more...
tub...@googlecode.com
Author: pc0der
Date: Sat Jan 7 17:29:44 2012
Log: and some more...
http://code.google.com/p/tubras/source/detail?r=1901
Added:
/trunk/tools/irrb/doc/_static/img025.png
/trunk/tools/irrb/doc/_static/img026.png
/trunk/tools/irrb/doc/_static/img027.png
Modified:
/trunk/tools/irrb/doc/_templates/layout.html
/trunk/tools/irrb/doc/features.rst
/trunk/tools/irrb/doc/irrbmesh.rst
/trunk/tools/irrb/doc/utilities.rst
=======================================
--- /dev/null
+++ /trunk/tools/irrb/doc/_static/img025.png Sat Jan 7 17:29:44 2012
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/tools/irrb/doc/_static/img026.png Sat Jan 7 17:29:44 2012
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/tools/irrb/doc/_static/img027.png Sat Jan 7 17:29:44 2012
Binary file, no diff available.
=======================================
--- /trunk/tools/irrb/doc/_templates/layout.html Sun Sep 25 04:06:31 2011
+++ /trunk/tools/irrb/doc/_templates/layout.html Sat Jan 7 17:29:44 2012
@@ -11,7 +11,7 @@
{% endblock %}
{% block rootrellink %}
- <li><a href="{{ pathto('index') }}">irrb home</a> | </li>
+ <li><a href="{{ pathto('index') }}">irrB home</a> | </li>
<li><a href="{{ pathto('contents') }}">Documentation</a>
»</li>
{% endblock %}
=======================================
--- /trunk/tools/irrb/doc/features.rst Mon Sep 26 10:03:18 2011
+++ /trunk/tools/irrb/doc/features.rst Sat Jan 7 17:29:44 2012
@@ -9,7 +9,7 @@
Implemented Features:
-* Blender Scene data is exported to Irrlicht native scene format (.irr).
+* Blender Scene data is exported to the Irrlicht native scene format
(.irr).
* Blender Mesh data is exported to the Irrlicht native mesh format
(.irrmesh).
* Export Blender ID Properties and Logic Properties as Irrlicht scene
UserData.
* Export Blender Lamp, Mesh, Camera, and Empty objects.
=======================================
--- /trunk/tools/irrb/doc/irrbmesh.rst Tue Jan 3 11:03:18 2012
+++ /trunk/tools/irrb/doc/irrbmesh.rst Sat Jan 7 17:29:44 2012
@@ -31,6 +31,8 @@
reason the .irrbmesh format performs so well is that it mimics Irrlicht's
internal mesh buffer and material formats. Very little parsing is required.
+----
+
Using .irrbmesh In Your Application
===================================
=======================================
--- /trunk/tools/irrb/doc/utilities.rst Mon Sep 26 10:03:18 2011
+++ /trunk/tools/irrb/doc/utilities.rst Sat Jan 7 17:29:44 2012
@@ -5,4 +5,102 @@
.. toctree::
:maxdepth: 2
-irrB Utilities.
+.. container:: irrb-right
+
+ .. image:: _static/img025.png
+
+The utilities **iwalktest** and **imeshcvt** may optionally be used to
enhance
+the functionality of **irrB**. iwalktest is used to view exported Blender
scenes.
+imeshcvt is used to convert meshes to an experimental binary mesh format
(.irrbmesh).
+
+Installation
+============
+
+The latest stable download of irrbUtils is accessible from both
the "Project"
+and "Downloads" tabs of this `Tubras Google Code project
<http://code.google.com/p/tubras>`_.
+On the "Project Home" tab, irrbUtils is listed in the "Featured Downloads"
+section. The current version is 0.6. It may be downloaded from here:
+
+Windows:
+ `irrbUtils-0.6-win.zip
<http://tubras.googlecode.com/files/irrbUtils-0.6-win.zip>`_
+
+Linux:
+ `irrbUtils-0.6-linux.zip
<http://tubras.googlecode.com/files/irrbUtils-0.6-linux.zip>`_
+
+Each .zip file contains both 32 and 64 bit versions of the utilities. The
+zip file includes the following:
+
+ | ``data/ // config and texture data``
+ | ``imeshcvt.exe // windows executable``
+ | ``iwalktest.exe // linux executable``
+ | ``x64/imeshcvt.exe // windows 64 bit executable``
+ | ``x64/iwaltest.exe // windows 64 bit executable``
+
+The Linux zip file contains the same files except the executables have
the .exe
+extension removed.
+
+Unzip the contents to a user **writable** directory because iwalktest
creates a
+log file in the directory it is executed from.
+
+----
+
+Configuration
+=============
+
+In order to integrate iwalktest and imeshcvt with irrb, you need to set up
+environment variables which point to the locations of their respective
executables.
+
+**Windows** - If installed/unzipped to "c:\\irrbutils", then you would set
the following
+environment variables:
+
+ | ``IWALKTEST=c:\irrbutils\iwalktest.exe -i "$1" -a "$2"``
+ | ``IMESHCVT=c:\irrbutils\imeshcvt.exe``
+
+**Linux** - if installed to "/home/jethro/irrbutils", then you would set
the following
+environment variables:
+
+ | ``IWALKTEST=/home/jethro/iwalktest -i "$1" -a "$2"``
+ | ``IMESHCVT=/home/jethro/imeshcvt``
+
+The "$1" and "$2" substitution variables inform irrb where to insert the
+"Scene File" and "Base Directory" command line parameters.
+
+Regardless of the OS you use, you may wish to run a different application
+instead of iwalktest (maybe your own or `irrEdit
<http://www.ambiera.com/irredit/>`_).
+To do this, simply set the appropriate value in the IWALKTEST environment
variable.
+For example to run irrEdit under Windows you would set the value to
(assuming irrEdit is
+installed to "c:\irredit"):
+
+ | ``IWALKTEST=c:\irredit\irredit.exe "$1"``
+
+This will cause the scene you export with **irrB** to be opened in irrEdit
immediately
+after the export finishes (the scene file name is passed to irrEdit as a
parameter).
+
+If you want to run an application that requires information other than the
scene
+file name you may set up the environment variable using the "$1"
substitution
+variable. For example, your application (myapp.exe) requires a "-i" in
front of
+the scene file name:
+
+ | ``IWALKTEST=c:\myappdir\myapp.exe -i "$1" -u``
+
+irrb will make the appropriate substitution before invoking your
application.
+
+----
+
+iwalktest Usage
+===============
+.. container:: irrb-left
+
+ .. image:: _static/img026.png
+
+The default application used to view scenes exported by irrb is iwalktest.
+iwalktest is a simple Irrlicht application that allows you to freely (God
camera) move around and view your
+scene. It also allows you to easily switch (F9 key) between the various
cameras you choose to export.
+
+.. image:: _static/img027.png
+
+----
+
+imeshcvt Usage
+==============
+imeshcvt is a command line utility that allows you to: