while文の中のWaitForEndOfFrameの理解

Question

unity公式の2Dshootingチュートリアルの敵集団をwaveを作る仕組みの中で、下記スクリプトが出てきました。

using UnityEngine;
using System.Collections;

public class Emitter : MonoBehaviour
{
    // Waveプレハブを格納する
    public GameObject[] waves;

    // 現在のWave
    private int currentWave;

    IEnumerator Start ()
    {

        // Waveが存在しなければコルーチンを終了する
        if (waves.Length == 0) {
            yield break;
        }

        while (true) {

            // Waveを作成する
            GameObject wave = (GameObject)Instantiate (waves [currentWave], transform.position, Quaternion.identity);

            // WaveをEmitterの子要素にする
            wave.transform.parent = transform;

            // Waveの子要素のEnemyが全て削除されるまで待機する
            while (wave.transform.childCount != 0) {
                yield return new WaitForEndOfFrame ();
            }

            // Waveの削除
            Destroy (wave);

            // 格納されているWaveを全て実行したらcurrentWaveを0にする（最初から -> ループ）
            if (waves.Length <= ++currentWave) {
                currentWave = 0;
            }

        }
    }
}

この中の、

while (wave.transform.childCount != 0) {
                yield return new WaitForEndOfFrame ();
            }

の部分ですが、wave.transform.childCount != 0がfalseになった時に次のDestroy (wave);まで進むことができるという機能になっているかと思います。

しかし、このwhile文でなぜそうなるのか、ということが理解できません。

WaitForEndOfFrame のドキュメントの説明を見ると、「スクリーン上のレンダリングが完了するまで待ちます。」とあります。なぜレンダリングの話がでてくるのでしょうか。

また、wave.transform.childCount != 0がfalseになった時にDestroy (wave);に移るということは、もしかするとtrueの間はyield return new WaitForEndOfFrame ();はcontinueのような使われ方で、ループの先頭に戻る役割を担っているのでしょうか。つまり、falseになった瞬間にcontinueしなくなったので、次に進めたということかな、と。（だとしてもドキュメントの説明とつながらないように思えます）

何卒ご教授頂けると嬉しいです。

Answer 1

質問主さんの仰る通り、「IEnumerator Start()」がコルーチンです。

「WaitForEndOfFrame」はレンダリング完了までの時間を指しますが、
このレンダリングというのは、いわゆる「フレーム」とほぼ同義です。
60fpsなら約0.016秒、30fpsなら0.033秒となります。

「yield return」は「一旦処理を中断し、returnの後ろに書かれた時間だけ待機し、その後次の行から再開する（＝待機する）」命令です。

もしyield returnを挟まない場合、ずっと処理が続く為、それが完了するまで入力を受け付けることも出来ず画面が固まることになります。
（Unityの仕様上１つのプログラムの動作中は基本的に他のプログラムは動作せず、画面再描画（＝レンダリング）もされない為）

なので実際の挙動は
「(wave.transform.childCount != 0)を判定→trueだった→yield returnで処理中断→レンダリングや入力を待つ→レンダリング完了（＝1フレーム経過）→(wave.transform.childCount != 0)を再判定→trueだった→処理中断→レンダリングを待つ→……」
という繰り返しになり、結果的に
「Waveの子要素のEnemyが全て削除されるまで待機する」という処理になります。

こちらも参考になるかと思います。
Unity - マニュアル: イベント関数の実行順

Comments

[GeeChiki]

非常にわかりやすいご回答、ありがとうございます！
私がちゃんと理解できているか、図を添付してみました。
(※1）が、１回目のyield returnの再開タイミング（レンタリング終了のタイミング）。その後、同じ0フレーム内で２回目のwhile (wave.transform.childCount != 0) {};に突入し、(※2)のタイミングで、次のレンダリング終了まで中断する。
という流れあっていますでしょうか。
もし正しいとすると、理解しづらかった理由は、１回目の中断はフレームをまたがず、2回目以降の中断ではフレームをまたいでいる点でした。yield return new WaitForEndOfFrame ();がフレーム単位で見た時に1回目も2回目も同じような処理になると勝手に思い込んでいたためです。

[sakura_hana]

私も正確に理解している保証は無い前提でお答えしますと……

「１フレーム」を「回答内のリンク先で言うPhysics〜Pausingまで」とするならば、図の解釈で合っています。

フレーム０：ゲーム起動（Editor→Initializationと進行）
フレーム０：Start()内で１回目のWhile判定、yield return開始
フレーム０：Initialization終了

フレーム１：フレーム開始（Physics→Input events→……と進行）
フレーム１：End of frame到達時にyield return終了、２回目のWhile判定、yield return開始
フレーム１：Pausing完了、フレーム終了

フレーム２：フレーム開始（Physics→Input events→……と進行）
フレーム２：End of frame到達時にyield return終了、３回目のWhile判定、yield return開始
フレーム２：Pausing完了、フレーム終了

（以降繰り返し）

「１回目のWhile判定はそもそもフレームのカウントが開始する前に行われる（＝便宜上フレーム０としたが本当はフレームと呼べない＝なのでフレームをまたぐこともない）」
「yield WaitForEndOfFrameは『常にEnd of frameタイミングまで待つ』（＝１回目も２回目も同じ処理である）」
どちらも正しい認識だと思います。

[GeeChiki]

なるほど！とても分かりやすいです。ありがとうございます。