Progression を使った時の root について

Progression を使っていると、”root” が一体何を指しているのかに戸惑います。ました。一回覚えればいいのでメモしておきます。

事前知識

このエントリでは、あるクラスで設定した変数に、他のクラスからアクセスするケースを紹介します。なので、変数を設定する際には外からでも見えるように public に設定されているか、あるいは getter/setter を使って明示的にアクセス権を設定してあるものとします。getter/setter って、_hoge という private な変数に下のようなアクセス設定をするやつです。こうしておけば外のクラスから hoge という変数のように扱えるってやつです。

public function get hoge():String{ return _hoge; }
public function set hoge(value:String):void {
_hoge = value;
}

Index.as 上の変数にアクセス

fla 上で「ドキュメントクラス」として設定している Index.as クラス上で設定した変数 hoge にアクセスしたい時。つまり従来の Flash の概念における root にアクセスしたい>時は「CastDocument.root」を使う。さらに、AS3 では外部クラスから別のクラスの値にアクセスする時はキャスト（型を明示的に宣言しておく）する必要がある。
つまり、外部のあるクラスから Index.as 上の変数 hoge にアクセスするには：

trace(Index(CastDocument.root).hoge); //hoge の値が出力される

IndexScene.as 上の変数にアクセス

Progression のシーン構造における起点となる「”Index”シーン」は IndexScene.as です。Progression 的にはここが起点、つまり「root」的な扱いにされています。この IndexScene.as クラス上で設定した変数 foo に外部クラスからアクセスしたい時は：

trace(IndexScene(progression.root).foo); //foo の値が出力される

注意点は”root”も Index.as ではなく、IndexScene.as を指すように予め Progression 側で設定されているということ。つまり以下の記述でも同様にIndexScene の変数にアクセスできる。

trace(IndexScene(root).foo); //foo の値が出力される

なので、IndexScene.as に設定した変数やインスタンスにアクセスするには上の 2通りのアプローチがあるので好きな方を使えばいいっぽい。（他にもあったら教えてください。）

僕のつまづきかた

FlashDevelop にはコード補完機能があり、”Index(instance)”とキャストして直後にドットをタイプすると、Index.as に設定されている変数やメソッドがズラーっと候補でリストアップされます。でも

Index(root).hoge

は上のメモをご覧のとおり、root は IndexScene を指すので、パブリッシュ時にエラーになります。補完候補にリストされているのに hoge なんてないよと怒られて途方に暮れたのでした。

Progression ノウハウ

ｘｍｌ読み込みはIndexSceneのonLoadでやる。ロード待ちはFuncのdispatcherなどなど使って待機させるように。ってのがむらけんさんノウハウ。どっちみち IndexScene は通るわけだから、僕もできる限りは Index.as はシンプルにしておき、IndexScene.as 側でやるようにしたい。
とはいえ、僕の Progression デビュー作は Index.as で xml ロードしてたりするけど。。

ただし、Google Analytics Tracking for Adobe Flash を使おうとすると、IndexScene.as よりも Index.as 上にトラッキング用インスタンスを作ってやる方がよさそう（IndexScene は DisplayObject じゃないから生成できないと怒られる）。
さらに、Analytics デバッグ確認用のコンポーネントは通常は最上位層に配置される仕様になっているのだけど、Progression の表示階層の管理は Flash のそれとはちょっと別世界なので、Analytics パネルが最下層に来てしまう。これを一番上にもってくる方法はまだ見つけられていないので、とりあえず Progression のコンテナ全体を y座標を下げたりして対応してますｗ。

※Google Analytics Tracking for Adobe Flash は、どのページにアクセスしたかを swf 上でデバッグ確認できる用のパネルがデデーンと表示されるのです。これは別エントリで。