UnityのMecanimでキャラクターを動かす

# 同じ内容を勉強会で解説した動画
- https://livestream.com/accounts/1839740/events/3063002/videos/57077724

# 概要

Unityでアニメーションを制御する際に避けては通れないMecanimの機能を使ってみる。

# Mecanimとは

Unity4から追加されたアニメーションシステム。実際には<code>Animator</code>を使って<code>Avatar</code>や<code>Animation Clip</code>、状態遷移を扱うワークフロー全体のことでありMecanimという機能やコンポーネントがあるわけではない。以前のバージョンから存在するアニメーション機能も残されてはいるが、Mecanimを使う事で下記のメリットがある。

- 人間型のキャラクタ間でモーションデータを共有可能
- 連続するアニメーションの切り替えをGUI上で設定可能
- IK(インバース・キネマティクス)などの高度なアニメーション
- パーツごとに異なるアニメーションを適用する(ボディマスク)

生産性とクオリティを同時に上げる事ができ、デザイナとプログラマの協業も推進できるすごい機能。旧アニメーションシステムを使うメリットはほぼ無い。

## Animatorコンポーネント

![](https://www.evernote.com/shard/s22/sh/7f5dd29d-e4b7-4324-95f1-8aed8d682a15/f6626a67898ef10c5a9eefbfd19de163/deep/0/main.unity---UnityAnimator---Web-Player.png)

Mecanimを使ったアニメーション制御を行うコンポーネント。MecanimあるところにAnimatorあり。スクリプトからAnimatorにアクセスする事で状態の切り替えや現在のアニメーションの再生状況などにアクセスできる。


## Animationコンポーネント

![](https://www.evernote.com/shard/s22/sh/61517332-f54e-4b89-a36e-75fc9b79b440/ae80162a7fbe2df7785e8b349c7aaa57/deep/0/main.unity---UnityAnimator---Web-Player.png)

旧来のアニメーションを司るコンポーネント。複数のアニメーションクリップをリストに登録しておき、再生させる形。古くからあるアセットなどに最初から付いていたりもする。削除してしまって問題ない。名前が似ているので間違って追加しないように注意。


# アニメーションを構成する要素

アニメーションを行うには複数のファイルやコンポーネントが連携して動作する。具体的には下記のような要素がある。

|名前|説明|
|:--|:--|
|メッシュ(モデル)|.fbx形式などの3Dデータ。ストアなどで入手するか、3Dソフトで作成する。|
|アバター|メッシュに対してボーンを埋め、人間型かどうかを設定したインターフェース|
|アニメーションクリップ|アニメーションのモーションデータ。手動で作ったり、モーションキャプチャで作ったりする。|
|アニメーターコントローラー|オブジェクトの状態とアニメーションの対応関係、遷移条件を管理する。|

# 素材の調達

## Robot Kyle

![](https://www.evernote.com/shard/s22/sh/cd32282e-9eb7-46e7-8622-edd64e8c41db/b74d86f82924676bbde1233794c1d29e/deep/0/Asset-Store---Space-Robot-Kyle.png)

アセットストアからダウンロードする。

## Unity Chan

![](https://www.evernote.com/shard/s22/sh/8597c2c4-272c-4bf9-b1ed-4f6604c7e912/4e2db49f8ad17fcb724ac0d853caf286/deep/0/Asset-Store---"Unity-chan!"-model.png)

アセットストア版は声は少ないがモーションデータは入っている。Web版でももちろんOK。今回はモーションデータを使う。	

# モデルの設定

![](https://www.evernote.com/shard/s22/sh/49f47490-dabd-4f78-ac8c-d464b5084700/3bb66da8c4d7e0a2f7fdf9abd06e9079/deep/0/Untitled---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

アセットストアからRobot Kyleをインポートした直後。インスペクタを見るとリグの設定を開くとアニメーションタイプが<code>Legacy</code>、すなわちMecanimを使わない状態になっている。ドロップダウンからGenericないしはHumanoidを選択するとMecanimに向けた設定を行ったAvatarが生成される。今回はユニティちゃんのモーションなどをリターゲティングして使いたいのでHumanoidを選択してApplyする。これでAvatarが生成される。

![](https://www.evernote.com/shard/s22/sh/a9e01c96-6dd3-4127-ba32-fcb82deadb2a/c4c6231d07c721ffe0a94f646729e97c/deep/0/Untitled---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

アバターが生成されている。Configureをクリックするとさらに詳細な設定画面を確認できる。

![](https://www.evernote.com/shard/s22/sh/bde9b8e6-1c01-4dfb-907c-af6960925188/dd3ccb033976d654366707b6a6073c56/deep/0/Untitled---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

この画面ではHumanoidのアバターとして必須のボーンやオプションのボーンがどのメッシュに対応しているかが設定されている。元のメッシュがTポーズを取っていればある程度自動で判定される。この画面で手動でボーンを設定して頑張るよりは元のメッシュデータをTポーズにしたりするといった手間を加えてやるほうが良さそう。


# AnimatorとAnimator Controllerの設定

![](https://www.evernote.com/shard/s22/sh/170b0750-e0cd-40f9-9487-4c7c9156a834/34ec4fb3dfd178082e14eacc6d0c38c6/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

Robot Kyleをシーンに配置する。Avatarを含んでいるので自動でAnimatorコンポーネントが設定されている。Avatarが無いモデルだとAnimationコンポーネントが設定されてしまっている場合がある。その場合は落ち着いてアバターを設定し、Animatorコンポーネントを設定する。アニメーターコンポーネントの設定項目は次のとおり。

|名前|意味|
|:--|:--|
|Controller|アタッチされたコントローラー|
|Avatar|このキャラクタのアバター設定|
|Apply Root Motion|キャラクタの位置をアニメーションで制御する|
|Update Mode|物理演算をするかどうか|
|Culling Mode|表示されていないオブジェクトをアニメーションさせるか|

Controllerはプレハブを利用しているのでなければ自作する。プロジェクトビューから<code>Create > Animator Controller</code>として作成し、モデル名などを元に命名する。


![](https://www.evernote.com/shard/s22/sh/80498781-0bdd-4d44-8aa8-9d9d663f1a05/0899640240b13249b478237c5a62eb80/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)
Animator Controllerを作成したらAnimatorコンポーネントのControllerの部分に適用する。

# Stateの設定

![](https://www.evernote.com/shard/s22/sh/0258f882-effd-49ed-ada4-7c883ff01e76/00992a6c262609e4c3a7abc2883661e1/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

作成したAnimator ControllerをダブルクリックするとAnimator編集のウインドウが開く。最初はAny Stateというアイテムしか無いが、ここにStateを追加し、対応するアニメーションクリップを設定することで動作を設定する。

![](https://www.evernote.com/shard/s22/sh/5919c92b-592c-4f4f-be88-64758b1c4e50/2ced9dfc09282ce6f2fddc41d91b6f32/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone-と-UnityのMecanimでキャラクターを動かす-と-Kobito-と-Facebook.png)

何もないところで右クリックし<code>Create State > Empty</code>とすると新しいStateができる。最初の一つ目は自動的にデフォルトステートとなってオレンジ色になる。作成したステートを選択しインスペクタのMotionの部分をみる。

Noneとなっている部分にHumanoid用のアニメーションクリップを設定する事で自由にステートに動きを設定できる。試しにUnityChanの中にある<code>WIN01</code>を設定して実行してみよう。カメラの位置を調整し、プレイモードにするとロボットがかわいくはしゃぎ始める。

![](https://www.evernote.com/shard/s22/sh/8d4cc99e-d362-48c8-a2f0-54357a399bc1/e0f5a97a2e245fda67691658b1e3bf63/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)


さらにStateを作成しそちらには<code>LOSE01</code>を設定する。これだけでは2つ目のステートは再生されないが、1つめのステートを選択し<code>Make Transition</code>で2つ目のステートへ線を引くと、再生が終わると2つめのステートに遷移する。さらに2つ目のステートから1つ目のステートに線を引けば交互に再生される。

![](https://www.evernote.com/shard/s22/sh/66966116-85e5-4a18-9b49-ee2e39e5e4e6/a5118a56890a20335c3a930e8f55a4c2/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone-と-UnityのMecanimでキャラクターを動かす.png)

# スクリプトからのコントロール

自動でステートが変わるだけではなく、外部のスクリプトから制御したい場合。例えばスペースキーを押すとジャンプするというのを考える。まず状態を管理する為のフラグをAnimator Controllerに追加する。アニメーター設定の左下にある＋をクリックし、BoolタイプでJumpというパラメータを作成。

![](https://www.evernote.com/shard/s22/sh/e6cc22cf-d457-461d-ab54-124c8819fbeb/3925e4c16e26b8dc38399332a1b90b5d/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone-と-Facebook.png)

さらに新しいステートを作成し、Jump00を割り当てる。ジャンプさせたいステートからTransitionを作成し線を引く。ここでジャンプするステートへ向かっている線を選択する。

![](https://www.evernote.com/shard/s22/sh/84dc3dbe-1e0f-4341-979b-394e8c2c3ad7/6575f4ae4858c059a3fa08ca9311ab6d/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone-と-UnityのMecanimでキャラクターを動かす.png)

ここでインスペクタのConditionsの部分、Exit Timeはクリップの再生後に自動で遷移する条件だが、ここをJumpパラメータがTrueの時にというふうに設定する。こうすることでスクリプトからTrueが設定された時にJumpへの遷移が発生する。
Robot KyleにAdd Componetし、New Scriptとして次のスクリプトをアタッチするとスペースキーでジャンプする。

```CSharp:RobotScript.cs
using UnityEngine;
using System.Collections;

public class RoboScript : MonoBehaviour {
	
	void Update () {

		bool jump = false;
		if (Input.GetKeyDown (KeyCode.Space)) {
			jump = true;
		}
		GetComponent<Animator>().SetBool("Jump",jump);

	}
}
```

JavaScriptだとこんな感じ。

```UnityScript:RobotScript.js
#pragma strict

function Update () {

	var jump = false;
	if (Input.GetKeyDown (KeyCode.Space)) {
		jump = true;
	}
	var anim:Animator = GetComponent("Animator");
	anim.SetBool("Jump",jump);

}
```

現状だとLose再生中からしかジャンプできない。さらにWinのステートからも線を引くことでいつジャンプできるのかを表現することができる。このような形でかつてはIf文の集合体で表現されていた状態遷移をデザイナーでも扱える形にできるのがMecanimの強みである。

# スクリプトからアニメーションの状態を取得する。

現在のステートマシンの状態を取得するには<code>Animator</code>から<code>AnimatorStateInfo</code>オブジェクトを取得し、メソッドを通じて状態にアクセスする。

比較を行うにはステート名をハッシュに変換してから比較する必要がある。またステート名にはレイヤー名が含まれるので、記述の方法に注意する。デフォルトのレイヤー名は<code>Base</code>となりドットで区切ってステート名を記述する。

```CSharp:特定のステートの時のみキャラを小さくする-RoboStateC.cs
using UnityEngine;
using System.Collections;

public class RoboStateC : MonoBehaviour {

	// Update is called once per frame
	void Update () {
		AnimatorStateInfo state = GetComponent<Animator> ().GetCurrentAnimatorStateInfo (0);
		if (state.nameHash == Animator.StringToHash("Base Layer.Lose") ) {
			transform.localScale = new Vector3(0.5f, 0.5f, 0.5f);
		} else {
			transform.localScale = new Vector3(1f,1f,1f);
		}
	}
}
```

JavaScriptで記述すると以下のような形。

```UnityScript:特定のステートの時のみキャラを小さくする-RoboState.js
#pragma strict

function Update () {

	var anim:Animator = GetComponent("Animator");
	var state:AnimatorStateInfo = anim.GetCurrentAnimatorStateInfo(0);
	if (state.nameHash == Animator.StringToHash("Base Layer.Lose") ) {
		transform.localScale = Vector3(0.5, 0.5, 0.5);
	} else {
		transform.localScale = Vector3(1,1,1);
	}

}
```

ハッシュにしないでメソッドで確認する事もできる。

```CSharp:メソッドでステートを比較した例
using UnityEngine;
using System.Collections;

public class RoboStateC : MonoBehaviour {

	// Update is called once per frame
	void Update () {
		AnimatorStateInfo state = GetComponent<Animator> ().GetCurrentAnimatorStateInfo (0);
		if (state.IsName("Base Layer.Lose") ) {
			transform.localScale = new Vector3(0.5f, 0.5f, 0.5f);
		} else {
			transform.localScale = new Vector3(1f,1f,1f);
		}
	}
}
```

# スピード変更

<code>Animator</code>を通じてアニメーションの再生速度を変更する事もできる。

```CSharp:右を押している間、3倍速になる。-RoboSpeedC.cs
using UnityEngine;
using System.Collections;

public class RoboSpeedC : MonoBehaviour {
	
	// Update is called once per frame
	void Update () {
		if (Input.GetKey(KeyCode.RightArrow)) {
			GetComponent<Animator>().speed = 3;
		} else {
			GetComponent<Animator>().speed = 1;
		}
	}
}
```

# アニメーションクリップの編集

![](https://www.evernote.com/shard/s22/sh/51fadacd-dba1-4f2b-8309-43629268d635/6cbd2f2b58b48f0200b93bbc50c52db6/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

アセットに含まれているアニメーションクリップは設定変更ができない。EditメニューからDupulicateして新規クリップにするとオプションの編集が可能になる。モデルの移動や回転が意図しない形で起こる場合に設定を見直す必要がある。

|項目|内容|
|:--|:--|
|Root Transform Rotation|Bakeすると回転がクリップの中だけに閉じる|
|Root Transform Position (Y)|Bakeすると上下移動がクリップの中だけに閉じた見た目になる。|
|Root Transform Position (XZ)|Bakeすると平面移動がクリップの中だけに閉じた見た目になる。|

ジャンプや回転などがアニメーションで表現されていた場合に、見た目だけになるか、オブジェクト自体が動くかを左右する項目。

Bake into Poseをしている場合のジャンプ。
![](https://www.evernote.com/shard/s22/sh/02bba008-b112-4eed-9ac8-bfe7b13d3343/4aac102dd1892570e2ca5ccad6ebac78/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

Bake into Poseをしていない場合のジャンプ。
![](https://www.evernote.com/shard/s22/sh/ab4dfb72-0c15-4b45-982f-0caed8640e83/11e2e186d4d11dd010b03147a246f522/deep/0/main.unity---UnityAnim2---PC,-Mac-&-Linux-Standalone.png)

- http://stackoverflow.com/questions/22809514/how-to-make-an-animation-clip-on-unity-to-loop


# アニメーションのブレンド

静止、歩く、走るといった複数のモーションを混ぜあわせて再生させることができる。
アナログな歩きから走りへの移行、方向転換などのミックスに使われる。