Mtk's Blog: [Unity3D] ユニティちゃんたちのアニメーションを分離するスクリプト

2015年11月15日日曜日

[Unity3D] ユニティちゃんたちのアニメーションを分離するスクリプト

Animation Duplicator for Unity

ゲームエンジン・Unity3D(以下Unity)のエディターを拡張するスクリプト Animation Duplicator をつくりました。
Animation Duplicator はUnityのアニメーションのコピーを作成するツールです。

開発のきっかけ

Unityにアニメーション付きFBXをインポートするとアニメーションにRead Onlyのロックがかかり編集出来ません。

アニメーションを選択してCtrlキーを押しながらDキーを押すとアニメーションのコピーが作られ編集出来るらしいのですが、Blenderで自作したアニメーションは自分の環境ではコピーできませんでした。
Ctrl + Dでコピーできないアニメーションもコピーしたかったので作ってみました。

インストール

C#のスクリプトをUnityのプロジェクトに追加します。

AnimationsDuplicator.cs

using UnityEngine;
using UnityEditor;
using System.IO;
using System.Text.RegularExpressions;

namespace JpFujiuMascotAppsContest2015 
{
    public class AnimationsDuplicator
        : EditorWindow
    {
        private const string CLASS_NAME = "AnimationsDuplicator";
        private const string TITLE = "Animations Duplicator";
        private const string BUTTON_TEXT = "Duplicate";
        private const string INVALID_CHAR = "[\\\\/?:*\"><|]";
        private static GameObject srcObject;

        [MenuItem("Window/" + TITLE)]
        public static void ShowWindow()
        {
            EditorWindow.GetWindow(typeof(AnimationsDuplicator), false, CLASS_NAME);
        }

        void OnGUI()
        {
            GUILayout.Label(TITLE, EditorStyles.boldLabel);
            srcObject = EditorGUILayout.ObjectField("Source Object", srcObject, typeof(GameObject), false) as GameObject;
            GUILayout.BeginHorizontal();
            GUILayout.FlexibleSpace();
            if (GUILayout.Button(BUTTON_TEXT))
            {
                Duplicate();
            }
            GUILayout.EndHorizontal();
        }

        private void Duplicate()
        {
            if (srcObject == null)
            {
                Debug.LogWarning("Set source object!");
                return;
            }

            var srcPathName = AssetDatabase.GetAssetPath(srcObject);
            var srcAssets = AssetDatabase.LoadAllAssetsAtPath(srcPathName);
            var srcAnimationClips = System.Array.FindAll<Object>(
                srcAssets, obj =>
                obj is AnimationClip 
                && obj.name.IndexOf("__preview__") == -1
            );

            int pathLength = srcPathName.LastIndexOf('/') + 1;
            var dstPath = srcPathName.Substring(0, pathLength);

            var rgx = new Regex(INVALID_CHAR);
            int count = 0;
            foreach (var srcAnimationClip in srcAnimationClips)
            {
                var dstFilePath 
                    = dstPath + rgx.Replace(srcAnimationClip.name, "_") + "_1.anim";

                if (File.Exists(dstFilePath))
                {
                    Debug.LogError("Same filename exists. :" + dstFilePath);
                } 
                else 
                {
                    var dstAnimationClip = Object.Instantiate(srcAnimationClip);
                    AssetDatabase.CreateAsset(dstAnimationClip, dstFilePath);
                    count++;
                }
            } // foreach.

            switch (count)
            {
            case 0:
                Debug.LogWarning("No animation.");
                break;
            case 1:
                Debug.Log(count + " animation was duplicated.");
                break;
            default:
                Debug.Log(count + " animations were duplicated.");
                break;
            } // switch.

            AssetDatabase.Refresh();
        }
    } // class.
} // namespace.

このスクリプトをAnimationsDuplicator.csというファイル名でUnity EditorのProjectウィンドウに追加するとWindowメニューに Animations Duplicator が追加されます。

使い方

Windowメニューから Animations Duplicator を起動します。

"Source Object" にアニメーションを含むゲームオブジェクトをドラッグ＆ドロップしてDuplicate ボタンをクリックするとAnimationだけのファイルが保存されます。

下の画像はBlendeで10個のアクションを含むFBXファイルをUnityにインポートしたものです。
Ctrl + Dで分離できなかったオブジェクトです。

Animation DuplicatorでDuplicateしました。同じフォルダーに「元のアニメーション名_1」というファイルを作りました。
既に「元のアニメーション名_1」と同じファイル名がある場合は上書き防止のためファイルを作りません。

Unityちゃん付属のアニメーションのコピーも作りました。

これで「Read Only」が解除されて編集できるようになりました。

マスコットアプリ文化祭2015バージョン

公開終了しました。

字下げスタイルの宗教戦争

Animation Duplicator を公開するにあたり、C# のコーディング規則を可能な限り遵守しました。
C# のコーディング規則
https://msdn.microsoft.com/ja-jp/library/vstudio/ff926074.aspx
個人的にはブロック開始の中括弧「{」で改行するコーディングはしません。
改行が多くてソースを読むのにスクロール操作を多用するのが嫌でVisual Studioを自動改行禁止に設定しています。

突然ですが、Unityアセットをたくさんインポートしたら同じクラス名のスクリプトが名前衝突してゲームが動かなくなってしまった経験はないでしょうか？
スクリプトにnamespace(名前空間)さえ設定されていたらクラス名の名前衝突によるトラブルは防げたはずです。

しかしクラス名が重複してゲームが動かなくなるUnityアセットのように、Animation Duplicator が使う人の環境を壊してしまっては大変です。(壊すことはないと思いますが)
自分の好みに拘りすぎて中括弧を改行しなかった結果、スクリプトに綻びができては意味がありません。
今回は公開するにあたり、自分の好みを曲げて Animation Duplicator にC# のコーディング規則を適用し中括弧を改行することにしました。
※ただし中括弧改行派に改宗したわけではありません。

Mtk's Blog

新アプリケーション