.. _animationBaker:

Animation Baker
=====

.. contents::
   :local:


.. _animationBakerHowTo:

How To Bake
------------

	#. Open `Baker` from the `Unity` toolbar.
	
		``Spirit604/Animation Baker``
		
	#. Create :ref:`Animation Collection <animationGPUAnimationCollection>` from the project context, or use existing one (**optional step**).
	
		``Spirit604/Animation Baker/Animation Collection``
	
		.. image:: /images/pedestrian/baker/animator/AnimationCollectionExample.png
			:scale: 50%
	
	#. Add and customize desired animations data.
	#. Assign collection in the `Animation collection` field.
	
		.. image:: /images/pedestrian/baker/window/animBaker1.png
	
	#. Customize texture & save path :ref:`settings <animationBakerSettings>`.
	#. Drag & drop selected `SkinnedMeshRenderer` of pedestrians into `Skins` :ref:`field <animationBakedSourceData>`.
	#. By default, animations are taken from `TemplateClipData Interpolated` template when selected template type. Select the `Custom` type in the `Clip data source` to add new animations or override the existing template.
	
		.. image:: /images/pedestrian/baker/window/animBaker1_1.png
	
	#. Drag & drop selected animations of pedestrians into the `Clips` :ref:`field <animationBakedSourceData>`.
	
		.. image:: /images/pedestrian/baker/window/SourceDataExample.png
		`Drag & drop example.`

	#. Press the `Create new` button.
	
		.. image:: /images/pedestrian/baker/window/SourceDataResult1.png
		`Multiple animation result example.`
		
	#. Enable `Animation binding` flag in the `Settings type`.
	
		.. image:: /images/pedestrian/baker/window/animBaker2.png
		
	#. In the `Clip data` section, select each animation according to the :ref:`Animation Collection <animationGPUAnimationCollection>`.
	
		.. image:: /images/pedestrian/baker/window/animBaker3.png
		
	#. If you edit any settings, press the `Update texture` button.
	#. After customizing all settings, press the `Save as new` button.
	#. In the project view, check the prefab result.
	
		.. image:: /images/pedestrian/baker/window/ResultExample.png
		`Prefab result example.`
		
.. _animationBakerHowToMulti:
		
How To Bake Multi-Mesh
------------

	#. This only works for vertex skinning method.
	#. Enable `Multimesh` type in the :ref:`Settings type <animationBakerSettings>`.
	#. Customize modular character with desired skinned mesh renderers.
	#. Add gameobjects with the desired attachments to the child of the desired bone **[optional]**.
	#. Drag & drop character parent to source skin list.
	#. Make the same :ref:`steps <animationBakerHowTo>` for baking.
		
Baker Window
------------

.. _animationBakerSettings:

Settings
~~~~~~~~~~~~

	.. image:: /images/pedestrian/baker/window/Settings.png
	
| **Animation material base** : base animation material.
| **Frame rate** : frame rate of baked animation.

**Settings type:** 
	* **Frame rate** : shows frame rate settings.
	* **Common** : shows common settings (custom offset & custom animation name).
	* **Transition mode** : allows you to preview the transition from one animation to another in the editor.
	* **Animation binding** : shows binding settings of the :ref:`Animation collection <animationGPUAnimationCollection>`.
	* **Multimesh** : allows you to bake animations with multi-skin renderers or with custom attachments **[vertex skinning method only]**.

| **Add normal texture** : add normal texture.

**Compression type:**
	* **Uncompressed** : uncompressed format of baked texture.
	* **Compressed** : compressed format of baked texture. **[currently not available]**

**Texture bake type:**
	* **Single texture** : bake all characters to single texture.
	* **Multiple textures** : bake each character to unique texture.
	
| **Clip data template path** : path to clip templates.
| **Save texture data path** : creating path of :ref:`texture animation data <animationBakedAnimationData>`.
| **Save texture path** : creating path of baked textures.
	
.. _animationBakedSourceData:

Source Data
~~~~~~~~~~~~
	
.. _animationBakerToolbar:
	
Toolbar
""""""""""""""

	.. image:: /images/pedestrian/baker/window/Toolbar.png
	
| **Skins** : source `SkinnedMeshRenderer` of characters.
| **Skin toolbar** : character selection toolbar for selecting preview animation.
	
Clip Data
""""""""""""""

	.. image:: /images/pedestrian/baker/window/ClipData.png

* **Clip** : reference to the clip.
* **Custom frame rate** : custom frame rate of the clip.
* **Interpolate** : on/off interpolation feature for the clip.
* **Offset** : local offset of vertices in baked animation.
* **Custom animation name** : custom animation name (if the field is empty the name from the clip will be taken).
* **Preview** : on/off preview playback of baked animation (make sure the texture is created and any character is selected in the :ref:`toolbar <animationBakerToolbar>`).
		
How To Preview
^^^^^^^^^^^^^^^^^^^^^^

#. :ref:`Bake <animationBakerHowTo>` the texture.
#. Select any character (for example `Character1`).
#. Press the `Preview` button.
#. Make sure that `Refresh Always` option is enabled in the editor.

	.. image:: /images/pedestrian/baker/window/RefreshAlways.png

Texture Data
""""""""""""""

Shows a preview of the created texture.

	.. image:: /images/pedestrian/baker/window/TextureData.png
	
Transition Data
""""""""""""""

Shows a preview of the transition animation between two selected animations.

	.. image:: /images/pedestrian/baker/window/TransitionData.png
	
* **Transition type:**
	* **Play once** : animation plays only once. 
	* **Play forever** : animation looped forever. 
	
* **Transition duration** : time to end of current animation when interpolation transition between animations is enabled.
	
.. _animationTransitionEditor:
	
How To Use
^^^^^^^^^^^^^^^^^^^^^^

#. Enable :ref:`Transition mode <animationBakerSettings>` in the settings.
#. :ref:`Bake <animationBakerHowTo>` the texture.
#. Select any character (for example `Character1`).
#. Press the `Preview` button for the source transition animation.
#. Then, press the `To` button next to the animation you want to target.
#. Adjust the `Transition duration` if required.

Buttons
""""""""""""""

| **Create new** : create a new texture.
| **Save as new** : save the texture as a new asset.
| **Override exist** : overrides existing texture & data.
| **Clear** : clean up the texture.

Crowd GPU Animator
------------

The `Crowd GPU Animator` is used for transitions between GPU animations.
	
How To
~~~~~~~~~~~~

Open
""""""""""""""

Open in the scene `CrowdGPUAnimatorAuthoring`.

	``Hub/Configs/BakerRefs/Settings/CrowdGPUAnimatorAuthoring``
		
	.. image:: /images/pedestrian/baker/animator/CrowdGPUAnimatorAuthoring.png
	
Initial Set Up
""""""""""""""

**Steps:**
	#. Create an :ref:`Animator Data Container <animationGPUAnimatorContainer>` from the project context  and assign it to the custom animator (if necessary).
	#. Create (if necessary) and assign :ref:`Animation Collection <animationGPUAnimationCollection>` the same as in the :ref:`PedestrianCrowdSkinFactory <crowdSkinFactory>`.

	.. image:: /images/pedestrian/baker/animator/CrowdGPUAnimatorAuthoring.png
	
Create Node
""""""""""""""

Right-click in the window and select the :ref:`desired node<animationBakerAnimatorNodeTypes>` from the context menu.

Create Transition
""""""""""""""
	
Transition is a sequential set of nodes StartNode-->AnimNode-->TransitionNode-->AnimNode-->TransitionNode-->AnimNode-->... (:ref:`example <animationBakerAnimatorTransitionExample>`).
	
**Steps:**
	#. Create a :ref:`new transition layer <animationBakerAnimatorNewTransitionLayer>` (if required).
	#. Enter the name of the trigger in the :ref:`StartNode <animationBakerAnimatorStartNode>`.
	#. Create and connect :ref:`AnimationNodes <animationBakerAnimatorAnimationNode>` and :ref:`TransitionNodes <animationBakerAnimatorTransitionNode>`.
	
.. _animationBakerAnimatorNewTransitionLayer:

Create Transition Layer
""""""""""""""

Press the `+` button on the main toolbar at custom animator to create a new layer, or press `-` to delete the currently selected layer.

Test
""""""""""""""

You can test the transition between two animations & adjust the transition duration in the editor in :ref:`AnimationBakerWindow <animationTransitionEditor>`.

.. _animationBakerAnimatorNodeTypes:

Graph Nodes
~~~~~~~~~~~~

.. _animationBakerAnimatorStartNode:

Start Node
""""""""""""""

Node where the transition begins by trigger.

	.. image:: /images/pedestrian/baker/animator/StartNodeExample.png	
		
| **Trigger name** : name of the trigger on which the transition starts.
| **Hash** : hash of the trigger on which the transition starts.

.. _animationBakerAnimatorTriggerHash:

	.. note:: Hash from trigger name generated by Unity method `Animator.StringToHash <https://docs.unity3d.com/ScriptReference/Animator.StringToHash.html>`_  

.. _animationBakerAnimatorAnimationNode:

Animation Node
""""""""""""""

Animation playback node.

	.. image:: /images/pedestrian/baker/animator/AnimationNodeExample.png

| **Asset name** : asset data name.
| **Anim name** : animation name (by default is taken from `Anim enum`).
| **Anim enum** : list of available animations in the :ref:`Animation Collection <animationGPUAnimationCollection>`
| **Unique animation** : unique animation mesh instance will be created for this animation.

.. _animationBakerAnimatorTransitionNode:

Transition Node
""""""""""""""

Node with settings for switching between animations.

**Node Type:**

	* **Default** : animations play sequentially one by one without interpolation.
		.. image:: /images/pedestrian/baker/animator/TransitionNodeDefaultExample.png	
		
	* **To Start** : the previous animation is interpolated to the beginning of the next animation with the set duration.
		.. image:: /images/pedestrian/baker/animator/TransitionNodeToStartExample.png
		
	* **To Global Sync** : the previous animation is interpolated to the global playback time of the next animation with the set duration.
		.. image:: /images/pedestrian/baker/animator/TransitionNodeToGlobalSyncExample.png


.. _animationBakerAnimatorTransitionExample:

Transition example
""""""""""""""

	.. image:: /images/pedestrian/baker/animator/StartSitTransitionExample.png
	`Start sit transition example.`
		
	.. image:: /images/pedestrian/baker/animator/SitoutTransitionExample.png		
	`Sitout transition example.`

.. _animationGPUAnimationCollection:

Animation Collection
------------

Contains meta-data of existing animations for the pedestrians.

How To Create
~~~~~~~~~~~~

From the project context :
	
	``Spirit604/Animation Baker/Animation Collection``

Settings
~~~~~~~~~~~~
	
	.. image:: /images/pedestrian/baker/animator/AnimationCollectionExample.png

| **Name** : animation name.

**Unique animation** : a unique animation mesh instance pool will be created for this animation.
	* **Allow duplicate** : is it allowed to take an animation from the pool if it is already being used by another character.
	* **Instance count** : animation pool size.
	
**Animation type:** 
	* **Mandatory** : each entity of the crowd must have this animation.
	* **Optional** : each entity of the crowd doesn't necessarily have to have this animation [:ref:`step 16 <crowdSkinFactory>`].

.. _animationGPUAnimatorContainer:

Animator Data Container
------------

Contains data about animation transitions.

	.. image:: /images/pedestrian/baker/animator/AnimatorContainerExampleSource.png
	
**Layer Data** : contains data about transition.
	* **Entry node** : asset node where the transition begins.
	* **Activate trigger** : name of the transition activation trigger.
	* **Activate trigger hash** : hash of the transition activation trigger.
	* **All nodes** : all transition nodes.