FinalIK.VRIK.GuessHandOrientations()でアバターの手首の回転を調整する

#概要
ハンドコントローラの動きに合わせてIKでアバターを動かそうとするとき、ランタイムでアバターを切り替える場合は特に、**各アバターによって手のボーンの初期姿勢が異なるために両手があらぬ方向を向く**という問題がある気がします。

今回は、VRoomというHMDを被りながら作業通話やゲームをするツールを作っている過程で、上記の問題にどのように対処したのか、書きながら整理しようと思います。
かなり手探りで進めているので、いろいろ教えていただければ幸いです…

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">HMDを被ったままビデオ通話に参加するための環境ができつつある（嬉しい）<br>・HMDを被ったままでのモニター操作<br>・コントローラーとマウスの持ち換え<br>・内部でのカメラスイッチ<br>・楽しい室内移動…などが、とりあえず欲しかった <a href="https://t.co/nVjCXWbuQq">pic.twitter.com/nVjCXWbuQq</a></p>&mdash; Ytomi (@kanmichun) <a href="https://twitter.com/kanmichun/status/1254328444042665985?ref_src=twsrc%5Etfw">April 26, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

GitHub : [Ytomi4/VRoom](https://github.com/Ytomi4/VRoom)

####環境
- Unity 2019.3.10
- FinalIK ver1.9

####目指すところ
**アプリ内でアバターを自由に切り替えることを前提に、プレイヤーの手にアバターの手が重なるよう、ボーンの初期姿勢が異なる様々なアバターに対応可能な調整方法を考える。**


#解決したい問題の特定
便宜的に、アバターによって手首のボーンの初期姿勢が異なることから起こる問題と表現しましたが、具体的には下画像のような状況を指しています。
![FinalIK_HandTransform.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/643215/9cf1fb97-d38d-ac51-453a-a2480be29e90.png)

画像上段は、各アバターの左手にあたるボーン（VRIK.referencesのLeftHandに格納されるGameObject）の姿勢をGizmoで表示したものです。
左手ボーンのローカル空間において、赤が右方向(1,0,0)、緑が上方向(0,1,0)、青が前方向(0,0,1)であることを示しています。

上の例が示す通り、**アバターの左手（掌）が左手ボーンのローカル空間でどの方向を向いているかは様々です**（モデラーの方の出力による）。

Unitychan（画像左上）[^1]では、左手が左手ボーンのローカル空間における左方向(-1,0,0)を向いており、Cygnet（画像中央上）[^2]では左手ボーンのローカル空間における上方向(0,1,0)を向いています。Unitychan（画像左上）とVita（画像右上）[^3]は、手がそれぞれのボーンのローカル空間で左方向(-1,0,0)を向いているという点では同じですが、x軸（赤）を中心に90°回転させたようになっており、たとえば手のひらに対する親指の方向の表現が異なります。

これにより、読み込んだアバターに単純にVRIKコンポーネントをアタッチするだけでは手首があらぬ方向を向きます（画像下段）。
Weightを1にして左手のボーンの回転RotationをTarget（画像ではVIVEコントローラーのモデルの先端）に完全に追従させると、**「左手ボーンのローカル空間における右・上・前方向」と「コントローラーのローカル空間における右・上・前方向」とがぴったり重なるように左手ボーンが回転する**ため、アバターの手があらぬ方向を向いてしまう、と理解しました。

上記の理由からアバターによって種々の方向を向く手首を、なんとかコントローラーの前方向を向くようにしたいというのが今回の問題となります。

#解決の指針
たとえば、VRIKの公式チュートリアル動画（[1:39~](https://youtu.be/6Pfx7lYQiIA?t=96)）では、コントローラーの位置と回転を反映させたシーン内のGameObjectの子オブジェクトをTargetに設定し、Transformを直接Inspectorからいじるという形で調整しています。

ただし、今回のケースでは、プレイ中のアバターの切り替えを前提としているのでInspectorから直接調整するという手法はとれず、アバター読み込み時に**アバターの手のボーンの状態から適当な回転を計算し、親（コントローラー）に対してTargetを回転させる**必要があります。

ここでかなり役に立ったのがGuessHandOrientations()でした（[リファレンス](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_v_r_i_k_ad544ce681c80087128d89af761f61617.html#ad544ce681c80087128d89af761f61617)）。これによって、回転を計算するのに必要な情報である、**手首から手のひら方向**と**手のひらから親指方向**とみなせる手のボーンのローカル空間における軸を求められます。内容は決して複雑ではないのですが、言及している記事を自分が見つけられなかった、かつ公式のリファレンスがスカスカだったので、次の話に入る前に少しまとめておきます。

###VRIK.GuessHandOrientations()
```C#:VRIK.cs
public void GuessHandOrientations() {
			solver.GuessHandOrientations(references, false);
}
```

まず一次的な処理としては、IKSolverVRクラスのインスタンスsolverから`GuessHandOrientations (VRIK.References references, bool onlyIfZero)`を呼び出し、次にsolver.rightHandとsolver.leftHandの`wristToPalmAxis`と`palmToThumbAxis`に代入する値（Vector3）を計算しています。それぞれ、**手首から手のひら方向**・**手のひらから親指方向**とみなせる手のボーンのローカル空間における軸を意味します。
![FinalIK_HandTransform_cyg.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/643215/bc41336d-e0a3-d035-97c3-864971e4501d.png)
上の画像の例では、`wristToPalmAxis`が(0,1,0)、`palmToThumbAxis`が(0,0,1)です。

もう少し詳しく見ると、`wristToPalmAxis`は手のボーンから肘にあたる場所のボーンへのベクトルtoForearmと、手のボーンのローカル空間におけるXYZ軸それぞれとの内積を取り、内積が最も小さくなる軸をVector3で返した後で、肘とは反対側を指すようひっくり返した(-1倍した)ものであると説明できます。Final IKのスクリプトから一部抜粋して引用します。

```C#:IKSolverVR.cs
leftArm.wristToPalmAxis = GuessWristToPalmAxis(references.leftHand, references.leftForearm);
```

```C#:IKSolverVR.cs
private Vector3 GuessWristToPalmAxis(Transform hand, Transform forearm) {
			Vector3 toForearm = forearm.position -hand.position;
			Vector3 axis = AxisTools.ToVector3(AxisTools.GetAxisToDirection(hand, toForearm));
			if (Vector3.Dot(toForearm, hand.rotation * axis) > 0f) axis = -axis;
			return axis;
		}
```

余談ですが、先の説明と引用したコードが示す通り、`wristToPalmAxis`は肘と手首の関係のみから求められ、手のひらと手首の位置関係は関係ないため、たとえば手首が小さく丸まっているようなアバターを想定した場合でも、`wristToPalmAxis`がコントローラーの前方向を向くように回転させれば、手首の丸まりを保持したままコントローラーに沿った手のかたちになるといえそうです。
モデラ―の方が出力してくれた肘から手にかけてのニュアンスを（極力）維持したまま、向きをコントローラーにあわせてそれらしく調整できるようになっているかというのはかなり重要な部分だと思います。


#具体的な解決方法
VRoomのCharacterControl.csでは、アバター読み込み時に以下のような処理を行うことにしました。

- 読み込んだアバターにVRIKコンポーネントをアタッチする
- AutoDetectReferences()でリファレンスを埋める
- **AdjustIKTargetsToAvatarsHands()でアバターに合わせてIKTargetの位置・回転を変える**
    - `GuessHandOrientations()`で、`solver.rightHand`と`solver.leftHand`それぞれの`wristToPalmAxis`と`palmToThumbAxis`を求める
    - `wristToPalmAxis`がコントローラーの前方向(0,0,1)を向くような回転`leftWristRot`を求め、IKTargetを回転させる
        - このとき、あくまで回転させるのはコントローラーの子オブジェクトであるIKTargetのlocalRotationであるため、`wristToPalmAxis`（あるいは回転後の`palmToThumbAxis`）と比較するコントローラーの前方向は常に(0.0,1)と表現できる　
    - コントローラーの前方向(0,0,1)を軸として、`leftWristRot`で回転した`palmToThumbAxis`が、コントローラーの右方向(1,0,0)となす角だけ回る回転`leftPalmRotAngle`を求め、IKTargetを回転させる（左手の場合）
    - さらに回転した`palmToThumbAxis`が左方向(-1,0,0)を向いている場合は、前方向(0,0,1)を軸に180°回転（左手の場合）
       - Vector3.Angleの返す`leftPalmRotAngle`はあくまで角度差であるため、90°反対に回転して`palmToThumbAxis`と向くべき方向との間で180°の開きが生まれるパターンがある
    - 手の位置にオフセットを加える
       - オフセットを加えない場合、コントローラーの先端がアバターの手首の位置にあり、不自然に感じる
       - オフセットを加える方向はアバターによって異なるので、毎回TargetのlocalPositionはVector3.zeroに戻しておく必要がある
- IKTargetの代入やstretchCurveの初期化など…


```C#:CharacterControl.cs
private void AdjustIKTargetsToAvatarsHands()
{
        _vrik.GuessHandOrientations();

        //Targetのローカルポジションを(0,0,0)に戻しておく
        _leftHandIKTarget.transform.localPosition = Vector3.zero;
        _rightHandIKTarget.transform.localPosition = Vector3.zero;

        //左手
        //wristToPalmAxisがコントローラーの前方向(0,0,1)を向くよう回転
        Quaternion leftWristRot = Quaternion.FromToRotation(_vrik.solver.leftArm.wristToPalmAxis, Vector3.forward);
        _leftHandIKTarget.transform.localRotation = leftWristRot * Quaternion.identity;

        //palmToThumbAxisがコントローラーの右方向(1,0,0)となす角だけ前方向(0,0,1)を軸に回転
        float leftPalmRotAngle = Vector3.Angle(leftWristRot * _vrik.solver.leftArm.palmToThumbAxis, Vector3.right);
        Quaternion leftPalmRot = Quaternion.AngleAxis(leftPalmRotAngle, Vector3.forward);
        _leftHandIKTarget.transform.localRotation = leftPalmRot * _leftHandIKTarget.transform.localRotation;

        //palmToThumbAxisが左方向(-1,0,0)を向いている場合は、前方向(0,0,1)を軸に180°回転
        Vector3 leftThumbDirRotated = leftPalmRot * (leftWristRot * _vrik.solver.leftArm.palmToThumbAxis);
        if (Vector3.Dot(leftThumbDirRotated, Vector3.right) < 0)
        {
            _leftHandIKTarget.transform.localRotation = Quaternion.AngleAxis(180, Vector3.forward) * _leftHandIKTarget.transform.localRotation;
        }

        //手の位置にオフセットを加える
        _leftHandIKTarget.transform.localPosition -= _handOffset * Vector3.forward;


        //右手
        //wristToPalmAxisがコントローラーの前方向(0,0,1)を向くよう回転
        Quaternion rightWristRot = Quaternion.FromToRotation(_vrik.solver.rightArm.wristToPalmAxis, Vector3.forward);
        _rightHandIKTarget.transform.localRotation = rightWristRot * Quaternion.identity;

        //palmToThumbAxisがコントローラーの左方向(1,0,0)となす角だけ前方向(0,0,1)を軸に回転
        float rightPalmAngle = Vector3.Angle(rightWristRot * _vrik.solver.rightArm.palmToThumbAxis, Vector3.left);
        Quaternion rightPalmRot = Quaternion.AngleAxis(rightPalmAngle, Vector3.forward);
        _rightHandIKTarget.transform.localRotation = rightPalmRot * _rightHandIKTarget.transform.localRotation;

        //palmToThumbAxisが右方向(1,0,0)を向いている場合は、前方向(0,0,1)を軸に180°回転
        Vector3 rightThumbDirRoted = rightPalmRot * (rightWristRot * _vrik.solver.rightArm.palmToThumbAxis);
        if (Vector3.Dot(rightThumbDirRoted, Vector3.left) < 0)
        {
            _rightHandIKTarget.transform.localRotation = Quaternion.AngleAxis(180, Vector3.forward) * _rightHandIKTarget.transform.localRotation;
        }

        //手の位置にオフセットを加える
        _rightHandIKTarget.transform.localPosition -= _handOffset * Vector3.forward;
}
```

#実際の動き
![FinalIK_HandTransform_performance.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/643215/dc85f94c-515a-6c8e-de32-57d16221bc7b.png)

例に挙げた3体のアバターで確認したところ、プレイヤー側に操作を強いることなく、どのアバターの手もプレイヤーの手と違和感なく重なるようになっていました。

#課題
- 確実にベストプラクティスがどこかにあるはずなので、調べる&読む 
- 例外をつくらない`leftPalmRot`
- 他のボーンとの位置関係から、特定の部位の向いている方向をとるという考え方は応用が利きそう（たとえば指先前方向にRayを飛ばすなど）
- そもそものアバター間の違いが、作られたモデリングソフトの違いによって発生していると思っているが、どうなのだろう
- Quaternionの理解を深めたい


[^1]: https://unity-chan.com/contents/guideline/
[^2]: https://booth.pm/ja/items/1870320
[^3]: https://hub.vroid.com/characters/6193066630030526355/models/3525604181073039892