View on GitHub

ezEngine Documentation

The documentation for ezEngine

Authoring and Exporting Animations with Blender

This page contains various pieces of information that are good to know when one uses Blender to build and export animated meshes. It is assumed that you know Blender well enough to create animated meshes.

Exporting Animated Meshes

  1. To get animated meshes out of Blender and into ezEngine, export the animated mesh to a binary GLTF file (.glb).
  2. You can enable +Y up or not. In both cases you need to adjust the transformation on the skeleton asset.
  3. Make sure that the GLTF export contains Animations and Skinning information.
  4. Don’t disable animation sampling on export.
  5. Be aware that GLTF uses 1000 frames per second for all exported animation clips. Blender, by default, uses 24 frames per second. If you want to only use a sub-range of an animation in EZ, you will need to re-calculate the frame indices accordingly. You can set Blender to use 25 or 50 frames per second to make this calculation easier.
  6. Enable Export Deformation Bones Only to strip IK pole targets and other unnecessary bones from the file.

GLB export settings

Importing Meshes into EZ

When importing a mesh, EZ remaps the model space to its own convention. You may need to change the mapping, to get the desired result. For static meshes, this is configure on the mesh asset. For animated models, the mapping is chosen on the root node of the corresponding skeleton asset.

EZ uses the following convention:

  1. +X is the forward axis
  2. +Y is the right axis
  3. +Z is the up axis

By default all code uses +X as its main direction. For example AI nodes move characters forwards along the +X axis, spot lights and cameras “look” into the +X direction and so on.

In Blender it is common to have a character look along the -Y axis so that it faces the user when pressing Numpad 1. This also means that the right side of the character will be along the -X axis.

If you export such a mesh to a GLB and enable Y UP convention, you need to configure the mapping this way:

Authoring Meshes

  1. Make sure all triangles face into the same direction. Use Blender’s Face Orientation viewport option to see whether there are flipped triangles. If there are flipped triangles, they will show up incorrectly in EZ. Face Orientation

Authoring Animations

  1. EZ only supports skeletal animations via skinned meshes. That means every vertex in the mesh needs to have a bone assigned via vertex weights. Blender can move entire objects through bone animations, but if they are only parented to a bone, and don’t use vertex skinning (vertex weights), EZ will not show those objects as animated. Use the Vertex Group Weights visualization in Blender to inspect which vertices are set up properly and which aren’t.

    Vertex Weights

  2. EZ uses a maximum of 4 bones per vertex. By default Blender’s GLTF export already restricts vertex weights to 4 bones, though there is an option to allow more influences. This won’t have a positive effect in EZ though.

  3. Be aware that Blender exports ALL keyframes of an animation. The preview window of an animation has no effect on the exported animation data.

  4. Blender always sets the first keyframe of all animations to index 1 and that is also how the data is exported. EZ expects the first keyframe to be at index 0, though. So set the animation range in Blender to start at index 0 and put the first keyframe there.

  5. Use the Action Editor in Blender to create and manage multiple animations in a single file. Be sure to set the Fake User flag on all of them to not lose any work.

  6. Now it gets weird: If you add multiple animations in Blender, usually 4 to 6 of them will be exported in the GLTF file. Once you add more animations, seemingly random ones won’t be exported. This is because Blender thinks those animations are unused and won’t export such unreferenced animations. The fix is to fake reference every animation in Blenders NLA editor. The way to do this, is to push the Stash button in the action editor on every animation. Stash action
    You will then see this reference show up in the scene outline/hierarchy window. Stashed actions
    Don’t rename the stashed item! Every animation should be stashed only once, and if you keep the auto-generated name, Blender won’t create another stash reference, if you push the stash button multiple times on the same animation. If you rename the item, that won’t work anymore.

  7. To delete an animation that has been stashed (and thus referenced by the NLA editor), remove the Fake User flag and also open the NLA editor and delete any reference to the animation by pointing with the mouse on a track and pressing X or Del.
    NLA editor
    Once no reference exists anymore, Blender removes the animation when you save and close the program.

Animation Cycles

  1. To create an animation that can be repeated, such as walk cycles, the first and the last keyframe must be identical.
  2. Furthermore, Blender will typically use cubic interpolation between the keyframes. For the first and last keyframe this will result in an interpolation that slows down and speeds up and is therefore not smooth. The simplest solution is to set these (or all) keyframes to use linear interpolation instead.
  3. Another option is to insert duplicated dummy keyframes before the first and after the last keyframe, to force the desired interpolation, but then you need to configure the animation clip in EZ to only use the proper sub-range of keyframes, which can be tricky to figure out.

Rigging Meshes

There are many good tutorials how to rig meshes. However, here are some additional tips, some that are specific to using animated meshes in game engines.

  1. Make sure your mesh is rigged perfectly before you start animating. Even small adjustments to the rig later may require you to redo all your animations.

  2. Make sure that all bones are connected correctly to each other. For example, hand and foot bones MUST be connected to their respective arm and leg bones. You must not have any disconnected bones that would be connected in a real skeleton. Some tutorials suggest to disconnect hand and foot bones and use a copy transform constraint instead, when setting up IK in Blender. This is a really bad practice. It will appear to work at first, but once you use partial animation blending (for example to play an animation only on the upper or lower body), it won’t work, because the disconnected bones are not part of the correct hierarchy. Similarly, setting up rag dolls for physics (currently not available in EZ) requires the bone hierarchy to be correct. Other engines have the same requirement.
    Armature Structure

  3. If you want to add IK to your Blender rig, duplicate the desired bone (for instance the hand bone), then disconnect that bone from the hierarchy (making it a root bone), disable Deformation on that bone, and then use that as the IK target bone. Since Deformation is disabled, this bone won’t be exported to GLTF either, which is what you want. It will only be a control bone.
    IK constraint

  4. If you want your actual hand bone to fully follow your IK target bone, add a Copy Rotation Constraint to it to have it follow both position and rotation animations that you add to the IK target bone.
    Copy rotation constraint

  5. You may also want to hide the original hand bone, such that you don’t accidentally pick and animate it, when instead you want to animate the IK target bone (which will most of the time be in the exact same location).

  6. Be aware though, that once a bone is hidden, it is quite a pain to make any modifications to it, because Blender won’t allow you to select it anymore, not even from the outliner tree view. Instead you must unhide the bone first. Either unhide everything (using ALT+H) or unhide only the desired bone through its context menu in the outliner pane.

  7. For IK bones, make sure your pole targets really work correctly. Most tutorials mention that you need to use a rotation offset of +90, -90 or 180 degree, but I have also observed the need for 45 degrees (and consequently 135 degrees) etc. The best way to check is to toggle between Edit Mode and Pose Mode (with the rest pose active) and check that bones with IK don’t have extreme twist in pose mode. The bones should only slightly move to fulfill their IK configuration, but if for example arm bones twist by a large amount, then your pole target configuration isn’t correct.

  8. If you seem to not get the pole target configuration correct, first make sure the target joint has a slight bend (for instance an elbow shouldn’t be fully straight). Then remove the IK constraint on the bone entirely and set it up from scratch. Blender seems to have internal state that can’t be fixed differently.

See Also