HowTo/Export from Blender using FBX

Revision as of 21:43, 6 July 2017

Introduction

This guide provides information for the export of FilmBoX (FBX) files from Blender.

Versions

The FBX format

A brief discussion on the FBX format history can be found here . FBX can be exported either as an ASCII (i.e. human readable) file or in binary format. TANE will only recognise the binary format.

Blender and FBX

Blender is capable of both importing and exporting FBX. The Blender exporter does not export all possible object attributes and it is likely that TANE will not recognise all those attributes that are exported. The Blender documention contains a list of attributes that are exported.

Included in this guide is a list of attributes that have been observed as exported and treatment/acceptance by TANE. The list is incomplete and so is a work in progress.

TANE and the FBX Importer

A discussion of the FBX format and general guidelines for use with TANE is discussed at this Trainz WiKi page: FBX file format

Skills Required

For this version of the guide, it is assumed the user has some knowledge of the use of Blender and an understanding of the Trainz asset creation process.

Exporting a mesh object from Blender in FBX format (no animation)

The FBX exporter addon must be enabled in User Preferences.

Select File->Export->Export FBX and the FBX export panel will show in the bottom left hand corner and should look like the following picture. The panel contents vary significantly between the Binary export version and the ASCII export version so make sure you have Binary selected.

The Main Menu

• Ignore the Operator Presets for now.
• Ensure FBX 7.4 binary version is selected.
• The Main/Geometry/Armatures/Animation buttons provide menu options for the item selected. Select the Main option.
• Selected Objects. This option needs careful consideration. Unlike the Blender XML exporter, the FBX exporter will export all objects in all layers

which is probably undesirable in many cases and particularly if you have different LOD models in different layers. So, first select those objects within Blender that you want to export and then select Selected Objects in this panel.

• Scale. Leave the Scale value as 1.00 and deselect the small icon to the right of the Scale value.
• Forward and Up. Set these to the values :Y forward and Z Up.

The options below are multi select (i.e. you can select more than one). For the time being just leave Mesh selected.

• Leave the Experimental and Custom Properties as deselected.
• Leave Path Mode as Auto and Batch Mode as Off.
• Choose the FBX filename and export using the Export FBX in the top right hand corner. There is no exporter log.

Tip

You can save your preferences for a given situation by clicking on the plus button (+) next to Operator Presets and saving the preset with a name. This is particularly useful for animation. You will need to reload the preset each time you start Blender.

The Geometry Menu

• Leave these values as shown.

The Armatures and Animation Menus

• See the Animation Section.

Config.txt - simple model

Setting up the CONFIG.TXT

The only changes to the config.txt are in the mesh table. The mesh entries for FBX files now have a "trainzmesh" extention as per the following example:

 mesh-table {
   default {
     auto-create                           1
     mesh                                  "my-mesh.trainzmesh"
   }
 }

Note that for the LM.TXT Level of Detail (LOD) you can still use the LM convention but the LM.TXT file must refer to trainzmesh files.

Files created

Mesh files

The file my-mesh.trainzmesh is created during the asset commit. Currently the FBX file is not deleted but bundled into the asset. Since the FBX format is readable by 3D modelling tools, you may want to remove any FBX files from assets uploaded to the DLS or other web sites.

Texture.txt files

You can provide your own texture.txt files (advisable) or let the commit process create them for you. The commit process will create suitable files, such as those required for normal maps, but you can provide your own if you have special requirements.

Warning: If you get odd effects with your textures, check the associated texture.txt file first. The FBX importer tends to add an "alpha=" line even though no alpha option has been chosen. This may be an issue with the Blender FBX exporter.

PEV's TextureTXT utility can be very useful for creating texture.txt files and its worth adding it into AssetX if you use AssetX for managing your projects.

Double Sided Meshes

It appears that FBX does not support double sided meshes so you need to create a metadata file as described at FBX file format#Mesh Metadata Files. Note that this is done per material. i.e. you cannot have the same material for single sided and double sided meshes.

General warnings and errors

Sample models using different materials

These are just Blender models (the cube) that demonstrate the various Trainz materials.

Notex: A notex material applied to a box. File:4000001- FBX paint-test-notex.zip

Onetex, reflect, tbumptex, tbumpenv and tbumpgloss

These are simple boxes using the same texture but with different material types;

Onetex: File:4000002 - FBX paint-test-onetex.zip

Reflect: File:4000003 - FBX - paint-test-reflect.zip

Tbumptex: File:4000004 - FBX - paint-test tbumptex.zip

Tbumpenv: File:4000005 - FBX - paint-test tbumpenv.zip

Tbumpgloss:

(TBD)

Animation

Overview

Trainz will not animate a mesh without the use of helper points using the "b.r" notation. For Blender, those helper points can be armatures (bones) or empties. Lattices are not supported by the FBX exporter.

An animation must have a root helper normally called "b.r.main" although "b.r.root" will also work. Using such names helps identify the overall parent of the animation. Other animation helpers are called "b.r.xxx", where "xxx" can be any name. These helpers must be children of the main/root helper.

Exporting an animated mesh object

The Main Menu

• Select Empty and Armature depending on how you set up your animation.
• Other options are described above.

The Armatures Menu

• Use the values as shown.

The Animation Menu

• Select Baked Animation and disable the other options.

Authors note: This is completely different from the process described in the 3DS Max FBX animation export. If Baked Animation is not ticked, then none of the other animation options are available. So far, none of those other options have been found useful.

Files created during the export and import process

The Blender exporter creates a binary file with the name of your choosing plus an FBX suffix. For animation, the exporter creates an internal name that the TANE importer uses for an animation (KIN) file.

If you choose Baked Animation (recommended), then the animation name is comprised of the FBX name and the word "_scene". So, if you export a model called "box.fbx" with animation, then the importer creates a "box.trainsmesh" and "box_scene.fbx".

If you don't choose Baked Animation, then the TANE importer uses the name of the animation channel so you might get names like "b.r.main-b.r.mainAction.kin".

Config.txt - Animation

The names of mesh and KIN files may not be obvious so you may need to create some dummy names for your mesh and KIN files. After importing into TANE, open the asset for editing and look for the files created. Then go back and correct entries in the config.txt.

Sample mesh-table entry with animation:

mesh-table {
 default {
   auto-create                           1
   mesh                                  "box.trainzmesh"
   anim                                  "box_scene.kin"
   animation-loop-speed                  1.00
 }

Animation warnings and errors

Sample animations

The following samples are provided to demonstrate different types of Blender FBX animations. You are free to use them for any purpose - i.e. no copyright!

Simple Animation 1 - Uses an empty as animated parent

File:890045 fbx anim1 - empty.zip

This animation rotates a coloured cube around the X axis using an empty as parent b.r.main. The animation action, within Blender, is called b.r.mainAction. The channel has been set to linear interpolation.

When exporting, you must select Empty and Mesh.

Exported names: The Blender FBX exporter creates a file called box.fbx. On commit, TANE creates a mesh file called box.trainzmesh and an animation file called box_scene.kin.

Simple Animation 2 - Uses an armature as animated parent

File:890044 fbx anim1 - armatures.zip

This animation rotates a coloured cube around the X axis using an armature with a single bone as parent b.r.main. The animation rotates anti-clockwise.

This is much the same as Sample 1 but demonstrates that you can use either an empty or an armature for simple animations.

When exporting, you must select Armature and Mesh.

Exported names: The Blender FBX exporter creates a file called box.fbx. On commit, TANE creates a mesh file called box.trainzmesh and an animation file called box_scene.kin.

Simple Animation 3 - Four animated cogs - LOD model

File:4000110 - FBX - anim test 4 - four cogs.zip

This animation simulates four rotating cogs. There are two LOD levels. LOD0 (the high poly version) is in layer 1 and LOD1 (the low poly version) is in layer 2. Layer 11 contains the animated armatures. There are four animation tracks.

To export LOD0, select all the objects in layers 1 and 11 so the LOD0 meshes and the armatures are all selected. On export, ensure Empty, Armature and Mesh are selected and use the name "4cogs-lod0.fbx". b.r.main is an empty so Empty must be selected.

To export LOD1, select all the objects in layers 2 and 11 so the LOD1 meshes and the armatures are all selected. On export, ensure Empty, Armature and Mesh are selected and use the name "4cogs-lod1.fbx".

You can choose any names you want but a meaningful name is useful.

This is the relevant section of config.txt:

mesh-table {

 gears-lod0 {
   auto-create                           1
   mesh                                  "4cogs-lod0.trainzmesh"
   lod-level                             0
   anim                                  "4cogs-lod0_scene.kin"
   animation-loop-speed                  1.00
 }
 gears-lod1 {
   auto-create                           1
   mesh                                  "4cogs-lod1.trainzmesh"
   lod-level                             1
   anim                                  "4cogs-lod0_scene.kin"
   animation-loop-speed                  1.00
 }

} mesh-detail-level-count 2

Note that the transition from LOD0 to LOD1 is obvious.

More complex animations

A Sample Steam Piston Animation

File:Bsa.zip

This example shows how to animate a steam piston and crankshaft using a circle to guide the location of the piston shaft. This is a variation of Torsten's sample for the XML exporter. General instructions for export are contained in the Blender file as a text object.

Materials

This section identifies the material options used by the FBX exporter. For detailed descriptions on how Trainz uses material types see Material Types and the child pages detailing different Trainz material types.

The exporter treats material options based on the chosen material shader model. Even though Trainz uses its own shaders, it may be worthwhile selecting different shader models in Blender to see the effect. In particular, choosing the Phong model for the specular shader will enable the export of a number of extra material options. These may, or may not, actually result in observable changes in Trainz.

The FBX exporter uses the following material options:

Be wary of checking Shading->Shadeless as this stops the export of several attributes including: Specular Color, Specular Factor, Shininess Exponent, Reflection Color, Reflection Factor, Specular, and Shininess.

In summary, material values you can play with in any material include:

• Diffuse colour
• Diffuse specular
• Transparency
• Specular colour
• Specular intensity
• Specular hardness
• Shading Emit
• Mirror
• Ambient (in World)

Textures

This section identifies the texture options used by the FBX exporter. Very few of the available options are actually exported and the only exported item relevant to normal/bump maps is the Mapping->Coordinates value. In practice, this isn't an issue as test assets using Trainz bump mapped materials work fine. You might need to provide your own texture.txt files when normal maps are required.

The FBX exporter uses the following texture slot options: