source: OGRE/trunk/ogrenew/Tools/BlenderExport/Docs/index.html @ 692

Revision 692, 9.2 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HEAD>
3<TITLE>Blender to Ogre Exporter</TITLE>
4<META NAME="description" CONTENT="Blender to Ogre Exporter Manual">
5<META NAME="keywords" CONTENT="Ogre, Blender, Export">
6<META NAME="resource-type" CONTENT="document">
7<META NAME="distribution" CONTENT="global">
8<meta http-equiv="Content-Type" content="text/html;charset=ISO-8859-1" >
9<LINK TYPE="text/css" rel="stylesheet" href="style.css">
10</HEAD>
11<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
12<DIV>
13<H1>Blender to Ogre Exporter</H1>
14Blender is an open source 3D content creation suite for modeling, animation, rendering and video post production. The Blender to Ogre Exporter is a python script to run directly within Blender. Currently it supports the export of
15<UL>
16<LI>mesh objects with vertex colours, multiple materials, uv textures and blend modes,</LI>
17<LI>armature keyframe animations.</LI>
18</UL>
19<H2>Installation</H2>
20<P>
21The script needs access to standard Python modules not shipped with Blender. Consult the Blender documentation at <A HREF="http://www.blender.org"> www.blender.org</A> how to incorporate Python with Blender.
22</P>
23<UL>
24<LI>
25Copy the script either into ".blender/scripts" or the user defined scripts directory.
26</LI>
27<LI>
28In the "Scripts Window" run "Scripts -> Update Menus".
29</LI>
30</UL>
31<H2>Basic Usage</H2>
32<UL>
33<LI>In the "3D View" select the objects you want to export.</LI>
34<LI>In the "Scripts Window" run "Scripts -> Export -> Ogre XML".</LI>
35<LI>Choose your export options.</LI>
36<LI>Press the "Export" button.</LI>
37</UL>
38You will get a detailed log of the export process. Use the OgreXmlConverter of your Ogre installation to convert the generated XML files to binary .mesh and .skeleton files.
39<P>
40<DIV ID=exporter>
41<IMG SRC="images/exporter.png" WIDTH="473" HEIGHT="397" ALT="exporter screenshot" />
42<P>Screenshot of the exporter interface.</P>
43</DIV>
44<H3>Options</H3>
45<DL COMPACT>
46<DT>Material File</DT>
47<DD>The name of the material script file that will be generated.</DD>
48<DT>Game Engine Materials</DT>
49<DD>Export materials as diplayed in the game engine. Materials are exported
50as displayed in the rendered results on default.</DD>
51<DT>Export Armature</DT>
52<DD>Export armatures and armature animations.</DD>
53<DT>World Coordinates</DT>
54<DD>Export objects in world coordinates instead of object coordinates.</DD>
55<DT>Coloured Ambient</DT>
56<DD>Use scaled diffuse colour as ambient colour instead of scaled white.
57This does only work for materials for which TexFace is not set.</DD>
58<DT>Mesh Scale Factor</DT>
59<DD>All meshs and bones are scaled on export by this factor.</DD>
60<DT>RotX</DT>
61<DD>Angle of an additional rotation around the x-axis of all objects on export. This rotation is applied first. Set it to -90 degrees to map Blender's up-vector (z-direction) to Ogre's default up-vector (y-direction).</DD>
62<DT>RotY</DT>
63<DD>Angle of an additional rotation around the y-axis. This rotation is applied second, after RotX.</DD>
64<DT>RotZ</DT>
65<DD>Angle of an additional rotation around the z-axis. This rotation is applied third, after RotY.</DD>
66<DT>Animation settings of</DT>
67<DD>Choose an object from the list of all objects selected for export. The animations that will be exported for that object are then displayed in the scroll area below. Each animation correspond to one line.
68<DL>
69<DT>Action name</DT>
70<DD>The name of the Blender action.</DD>
71<DT>Start frame (Sta:)</DT>
72<DD>Start frame of the animation.</DD>
73<DT>End frame (End:)</DT>
74<DD>End frame of the animation.</DD>
75<DT>Animation export name</DT>
76<DD>The animation name in the exported Ogre file.</DD>
77<DT>Delete</DT>
78<DD>Removes the animation from export.</DD>
79<DT>Add</DT>
80<DD>Add another animation to be exported.</DD>
81</DL></DD>
82<DT>Update</DT>
83<DD>Updates the list of all objects selected for export from the currently selected objects in the "3D View". Also updates the list of possible actions, deletes animations for removed actions and sets default animations for new actions.</DD>
84<DT>Path</DT>
85<DD>All generated files of the exporter are written into this directory. Mesh files are named after the mesh object name in Blender with suffix ".mesh.xml". Skeleton files are named after the armature object name in Blender with suffix ".skeleton.xml".</DD>
86<DT>Export</DT>
87<DD>Export all objects in the list of objects selected for export.</DD>
88<DT>Quit</DT>
89<DD>Exit from the export script.</DD>
90</DL>
91<P>
92The script loads and saves its options to a text buffer "ogreexport.cfg" inside the current .blend file. You can disable this behaviour by changing the script variable KEEP_SETTINGS to 0.
93</P>
94<P>
95If the OGRE_XML_CONVERTER script variable is set to the OgreXMLConverter executable, the converter is called on the exported XML files.
96</P>
97<H2>Specifics</H2>
98<H3>Mesh</H3>
99<P>The script supports sticky and per face vertex uv coordinates, smoothed and non-smoothed normals, vertex colours. Each rectangle face is automatically converted into two triangle faces in the exported mesh.</P>
100<P>The script does not support subdivision surface (SubSurf) options. To export a SubSurf object, you have to convert it into a Mesh object, "Object -> Convert Object Type... -> Mesh (keep original)".</P>
101<P>The script does not support the "Double Sided" mesh option, use the "Two Sided" face option instead.</P>
102<H3>Material</H3>
103<P>
104In contrast to Ogre, Blender treats material, uv texture and blend mode separately. Also Blender distinguishs between material appearance in the game engine and material appearance in the rendered results.
105</P>
106<H4>Game Engine Materials</H4>
107The material name has to be unique. Therefore, the name of the exported material consists of Blender's material name (if any), the face blend mode and texture file name (if any). If vertex colours are defined, a postfix "/VertCol" is appended. Also, if the two-sided face option is set, "/TWOSIDE" is appended.
108<P>
109If a material is assigned to face, only the properties that affect the appearance in the game engine are exported. These are the "Col" and "Spe" colours, the "Amb", "Spec" and "Hard" factors and the "VCol Paint" and "TexFace" options.
110</P>
111Textures assigned with the UV/Image Editor are exported. Note that material image textures, which can be exported as rendering engine materials, give you more control over filtering and texture address modes.
112<P>
113<IMG SRC="images/face.png" WIDTH="398" HEIGHT="310" ALT="face options" />
114</P>
115Blender's face settings affect the mesh appearance only in the game engine. The properties exported by the script are marked green.
116<H4>Rendering Engine Materials</H4>
117<P>The name of the exported material is the same as in Blender. If the "Two Sided" face option is set, the suffix "/TWOSIDE" is appended. If the "TexFace" material option is set, the suffix "/TEXFACE" and the name of the texture image that is assigned with the UV/Image Editor is appended. The "Two Sided" face option has no effect in Blender's rendering results and is evaluated on export for convenience only.
118</P>
119<P>
120<IMG SRC="images/material.png" WIDTH="288" HEIGHT="203" ALT="material panel" />
121</P>
122<P>
123<IMG SRC="images/shaders.png" WIDTH="288" HEIGHT="203" ALT="shaders panel" />
124</P>
125<P>
126<IMG SRC="images/mirrortransp.png" WIDTH="288" HEIGHT="203" ALT="mirrortransp panel" />
127</P>
128Blender's material settings that affect the exported Ogre material are marked green.
129<P>
130<IMG SRC="images/image.png" WIDTH="288" HEIGHT="203" ALT="image panel" />
131</P>
132<P>
133The script exports image textures with "Map Input" set to "UV" and "Map To" set to "Col" and optional "Alpha". The supported image options are marked green.
134</P>
135<TABLE>
136  <TR>
137    <TH>InterPol</TH>
138    <TH>MidMap</TH>
139    <TH>resulting filtering</TH>
140  </TR>
141  <TR>
142    <TD>yes</TD>
143    <TD>yes</TD>
144    <TD>trilinear</TD>
145  </TR>
146  <TR>
147    <TD>yes</TD>
148    <TD>no</TD>
149    <TD>linear linear none</TD>
150  </TR>
151  <TR>
152    <TD>no</TD>
153    <TD>yes</TD>
154    <TD>bilinear</TD>
155  </TR>
156  <TR>
157    <TD>no</TD>
158    <TD>no</TD>
159    <TD>none</TD>
160  </TR>
161</TABLE>
162<H3>Armature</H3>
163<P>
164You must have no more than four weighted bone assignments per mesh vertex. If you have more, the script will eliminate the lowest weighted assignments and renormalise the other weights. All vertices must be assigned to at least one bone.
165</P>
166<P>
167Armature animations are exported based upon keyframe ranges and action names. You can choose any frame as start and end frame of an animation. The script will automatically insert keyframes at the start and end of the exported animation and reverse the exported animation if the end frame is lesser than the start frame. In order to export armature animations of a mesh you don't have to select the armature separately.
168</P>
169<P>
170The script does not evaluate action constraints. To export an action with constraints you have to convert the constraint effects into ipo keys ("Action Editor -> Bake") and choose the baked action in the animation settings.
171</P>
172Ogre does not inherit parent bone scaling by default.
173<P>
174</P>
175The animation speed in the export in terms of frames per second is taken from the corresponding scene render button.
176<P>
177<IMG SRC="images/format.png" WIDTH="288" HEIGHT="203" ALT="format panel" />
178</P>
179Blender's format setting that affect the exported Ogre animation is marked green.
180</DIV>
181</BODY>
182</HTML>
Note: See TracBrowser for help on using the repository browser.