2016年5月14日土曜日

【Unity】コルーチンに登場するIEnumeratorとはなんぞや

Unityには処理をフレームごとに分割するコルーチン(Coroutine)という仕組みがある。

理解するためのキーワードが IEnumerator というクラス。
これは、yield return 文とセットで使われる。
これは、Listなどのコレクションに関連するクラスだが、コレクションそのものではなく、JavaでいうIterator のように「元となるコレクションがまずあり、それを反復処理するときに使う」クラス。

コルーチンのためのメソッドというものがまず作られる。
これは、返り値がIEnumeratorになるメソッド。

------------------------------------------------------------------------
using UnityEngine;
using System.Collections;

public class CoroutineTest : MonoBehaviour {
    //コルーチンで書き換える文字列
    private string text_to_show;

    //////////////////////////////
    /**
     * スタート
     */
    void Start () {
        //コルーチンをスタート
        StartCoroutine(
            SampleCoroutine()
        );
    }//Start

    //////////////////////////////
    /**
     * コルーチンのテスト
     * このメソッドはUnityで追加されたスクリプト(MonoBehaviour継承クラス)内に書かれる想定
     */
    private IEnumerator SampleCoroutine() {
        int i = 0;
        while(true){
            this.text_to_show = "test " + i;
            i++;
            //コンソールに出力
            Debug.Log("text_to_show : " + this.text_to_show);

            //2秒待つ
            //n秒待たせるには、yield return 文でnew WaitForSeconds(n)を戻させなくてはならない。
            yield return new WaitForSeconds(2);
        }//while

    }//function
}//class
------------------------------------------------------------------------

while(true) があるから無限ループのように見える、もしくは (yield) return のところで処理が終わってそうに見える。
実際には、yield return のところで処理が呼び出し元に帰る。
そして、このメソッドの返り値であるIEnumeratorのインスタンスがMoveNext()を実行すると、前回 yield return した続きから処理が再開され、次の yield return まで処理が走る。
Unityの場合、この MoveNext() は明示的には書かれず、Unityが見えないところで自動で実行する。
その仕組が、Unityの持つ「StartCoroutine(コルーチンメソッド)」という命令。
これは、Unity によって毎フレーム「MoveNext()」が実行されるというもの。

IEnumerator とは、Iterator のような、コレクションを反復処理する際に使う反復子というインターフェイスの一種。
MoveNext() というメソッドを持っているのが特徴。

IEnumerator というのはつまり、元になるコレクションを持ってて(IEnumerator がコレクションから取り出されるとも言える)、MoveNext() によって次の値次の値とアクセスできるということ。
で、IEnumerator を返り値としてyield return するメソッドというのは、MoveNext()によって次の値を返す(次のyield returnの戻り値を返す)コレクションであると見ればいい。

IEnumeratorの元(持ち主)に2つの系統があると考える。
■Listなどのコレクションインスタンス
■yield return を持ち、IEnumerator を戻り値とするメソッド(コルーチン)

以下の変数とメソッドとは、似たようなことをやろうとしている。

------------------------------------------------------------------------
変数 test_list(コレクションのインスタンス)
------------------------------------------------------------------------
using UnityEngine;
using UnityEngine.UI;
using System.Collections;
using System.Collections.Generic;

public class IEnumeratorTest01 : MonoBehaviour {
    void Start () {
        //IEnumerator のインスタンス(コレクション変数)
        List<string> test_list = new List<string>();
        test_list.Add("test01");
        test_list.Add("test02");
        test_list.Add("test03");

        //コレクションからIEnumerator を取得
        IEnumerator test_ienumerator = test_list.GetEnumerator();
        while (test_ienumerator.MoveNext()) {
            Debug.Log(test_ienumerator.Current);
        }//while
    }//Start
}//class

------------------------------------------------------------------------
メソッド TestIenumeratorMethod()
------------------------------------------------------------------------
using UnityEngine;
using UnityEngine.UI;
using System.Collections;
using System.Collections.Generic;

public class IEnumeratorTest02 : MonoBehaviour {
    void Start () {
        //IEnumerator のインスタンス(yield return を持つメソッドからの戻り値)
        IEnumerator test_ienumerator_by_method = this.TestIenumeratorMethod("test");
        while (test_ienumerator_by_method.MoveNext()) {
            Debug.Log(test_ienumerator_by_method.Current);
        }//while

    }//Start

    //////////////////////////////
    /**
     * IEnumeratorの元となるコレクションに相当するメソッド
     */
    public IEnumerator TestIenumeratorMethod(string str){
        yield return str + "01";
        yield return str + "02";
        yield return str + "03";
    }//function
}//class

------------------------------------------------------------------------
IEnumerator.Current コレクションの中での現在地のオブジェクトを返す。
IEnumerator.MoveNext() boolean を返す。コレクションの現在地(Current)を次の要素に移動させ、次の要素がある場合はtrueを、ない場合はfalseを返す。

0 件のコメント:

コメントを投稿