Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Rig tab Import Settings reference

Reference information for the Rig tab in the Model Import Settings window.
Read time 7 minutesLast updated a month ago

The settings on the Rig tab define how Unity maps the deformers to the mesh in the imported model so that you can animate it. For humanoid characters, this means assigning or creating an avatar. For non-humanoid (generic) characters, this means identifying a root bone in the skeleton.
To open the Rig tab, select a mesh, and in the Inspector select the Rig tab.

Animation Type

The value you select for the Animation Type determines the layout for the Rig tab.
By default, when you select a model in the Project view, Unity determines which Animation Type best matches the selected model and displays it in the Rig tab. If Unity has never imported the file, the Animation Type is set to None.

Property

Description

NoneNo animation present.
LegacyUse the Legacy Animation System. Import and use animations as with Unity version 3.x and earlier.
GenericUse the Generic Animation System if your rig is non-humanoid (quadruped or any entity to be animated). Unity picks a root node automatically but you can identify another bone to use as the Root node instead.
HumanoidUse the Humanoid Animation System if your rig is humanoid (it has two legs, two arms and a head). Unity usually detects the skeleton and maps it to the Avatar correctly. In some cases, you may need to set the Avatar Definition and configure the mapping manually.

Generic animation types

Generic Animations do not use Avatars like Humanoid animations do. Since the skeleton can be arbitrary, you must specify which bone is the
Root node

?

. The Root node allows Unity to establish consistency between Animation clips for a generic model, and blend properly between Animations that have not been authored "in place" (that is, where the whole model moves its world position while animating).
Specifying the root node helps Unity determine between movement of the bones relative to each other, and motion of the Root node in the world (controlled from OnAnimatorMove).

Property

Description

Avatar DefinitionChoose where to get the Avatar definition. The following options are available:
  • Create from this model - Create an Avatar based on this model
  • Copy from Other Avatar - Point to an Avatar set up on another model.
Root nodeSelect the bone to use as a root node for this Avatar.

This setting is only available if you set the Avatar Definition to Create From This Model.
SourceCopy another Avatar with an identical rig to import its animation clips.

This setting is only available if you set the Avatar Definition to Copy from Other Avatar.
Skin WeightsSet the maximum number of bones that can influence a single vertex. The following options are available:
  • Standard (4 Bones) - Use a maximum influence of four bones. This is the default, and is recommended for performance.
  • Custom - Set your own maximum number of bones. When you select this option, the Max Bones/Vertex and Max Bone Weight properties appear.
Max Bones/VertexSet the maximum number of bones per vertex to influence a given vertex. You can set between 1 and 32 bones per vertex, but the higher the number of bones you use to influence a vertex, the greater the performance cost.

This setting is only available you set the Skin Weights property to Custom.
Max Bone WeightSet the bottom threshold for considering bone weights. The weighting calculation ignores anything smaller than this value, and Unity scales up the bone weights higher than this value to a total of 1.0.

This setting is only available if the Skin Weights property is set to Custom.
Strip BonesEnable to only add bones to Skinned Mesh Renderers that have skin weights assigned to them.
Optimize Game ObjectRemove and store the GameObject Transform hierarchy of the imported character in the Avatar and Animator component. If enabled, the SkinnedMeshRenderers of the character use the Unity animation system's internal skeleton, which improves the performance of the animated characters.

Only available if the Avatar Definition is set to Create From This Model.
Extra Transforms to ExposeSpecify which Transform paths you want Unity to ignore when Optimize Game Object is enabled. For more information, see Including extra Transforms.

This section only appears when Optimize Game Object is enabled.

Humanoid animation types

Your rig is humanoid (it has two legs, two arms and a head)

With rare exceptions, humanoid models have the same basic structure. This structure represents the major articulated parts of the body: the head and limbs. The first step to using Unity's Humanoid animation features is to set up and configure an
Avatar

?

. Unity uses the Avatar to map the simplified humanoid bone structure to the actual bones present in the Model's skeleton.

Property

Description

Avatar DefinitionChoose where to get the Avatar definition. The following options are available:
  • Create from this model - Create an Avatar based on this model
  • Copy from Other Avatar - Point to an Avatar set up on another model.
SourceCopy another Avatar with an identical rig to import its animation clips.

Only available if the Avatar Definition is set to Copy from Other Avatar.
ConfigureOpen the Avatar configuration.

Only available if the Avatar Definition is set to Create From This Model.
Skin WeightsThis property is identical for both Humanoid and Generic Models. Refer to the Skin Weights property for Generic models above for more information.
Strip BonesEnable to only add bones to Skinned Mesh Renderers that have skin weights assigned to them.
Optimize Game ObjectRemove and store the GameObject Transform hierarchy of the imported character in the Avatar and Animator component. If enabled, the SkinnedMeshRenderers of the character use the Unity animation system's internal skeleton, which improves the performance of the animated characters.

Only available if the Avatar Definition is set to Create From This Model.
Extra Transforms to ExposeSpecify which Transform paths you want Unity to ignore when Optimize Game Object is enabled. For more information, see Including extra Transforms.

This section only appears when Optimize Game Object is enabled.

Including extra Transforms

When you enable the Optimize Game Object property, Unity ignores any Transform which is part of the hierarchy but is not mapped in the Avatar, in order to improve CPU performance. However, you can mark specific nodes in the GameObject hierarchy to include in calculations using the Extra Transforms to Expose section:

The Extra Transforms to Expose property appears when Optimize Game Objects is enabled

(A) Enter the full or partial name in the search box to filter the list of Transforms. This makes it easier to navigate through characters with a large number of bones.
(B) Enable each Transform (bones of a skeleton) you want Unity to include in calculations.
(C) Use the buttons to help select specific Transforms. For example, the Toggle All button selects or deselects everything at once (regardless of the current selection, including filtered items).
(D) Use the Revert button to undo your selections or the Apply button to apply the exceptions to the Model.
Note
In optimized mode, skinned Mesh matrix extraction is multi-threaded.

Legacy animation types

Property

Description

GenerationSelect the animation import method. The following options are available:
  • Don't Import - Do not import animation
  • Store in Original Roots (Deprecated) - Deprecated. Do not use.
  • Store in Nodes (Deprecated) - Deprecated. Do not use.
  • Store in Root (Deprecated) - Deprecated. Do not use.
  • Store in Root (New) - Import the animation and store it in the Model's root node. This is the default setting.
Skin WeightsThis property is the same for Legacy as for Humanoid and Generic Models. Refer to the Skin Weights property for Generic models above for more information.
Strip BonesEnable to only add bones to Skinned Mesh Renderers that have skin weights assigned to them.
For more information about legacy animation, refer to the documentation for Legacy Animation System.