[ActionScript 3.0] Event.RENDERとinvalidateでタイムラインが進む直前で描画する

[ActionScript 3.0] Event.RENDERとinvalidateでタイムラインが進む直前で描画する

AS3.0で、表示リストをレンダリングする必要のある次の機会に、表示オブジェクトに通知する方法です。

Event.RENDER と invalidate について

どういうことかというと、AS3.0の独自で作ったクラスに、widthプロパティをオーバーライドしたり backgroundColorプロパティを用意して背景に色を塗ったりしたいとき、「幅の値 → 背景色の色」と値を指定していくと 2回レンダリングしてしまうわけで、それを避ける方法として Event.RENDERinvalidateメソッドがあります。

この方法を使うと、Flashが次のタイムラインにレンダリングする直前のタイミングで処理してくれるので、タイムラインが進む前に設定がかぶっても処理は一回で済むのだ。

使い方

使い方は、設定するメソッド(例えば widthプロパティ や backgroundColorプロパティ)に stage.invalidate() を置き、コンストラクタに addEventListener(Event.RENDER, draw) と書いて、drawメソッド内に処理を付け加える。

例えば、縦横100pxの黄色い背景みたいな指定の場合、それぞれのメソッドが高さ、横幅、背景色と3回あるので stage.invalidate() も3回叩かれるが、drawメソッドの処理はタイムラインが進むタイミングのときに一回だけ走る。

以下のソースコードは、指定されたサイズと色の矩形を描画するサンプルです。
drawメソッド内は好きなようにごにょごにょしてくだされ。

  1. package {
  2.     import flash.display.Sprite;
  3.     import flash.events.Event;
  4.     public class Example extends Sprite {
  5.         private var _width:Number = 0;
  6.         private var _height:Number = 0;
  7.         private var _backgroundColor:uint = 0;

  8.         public function Example() {
  9.             addEventListener(Event.RENDER, draw, false, 0, true);
  10.         }

  11.         /**
  12.          * 表示オブジェクトの幅を示します(ピクセル単位)。
  13.          */
  14.         public override function get width():Number {return _width;}

  15.         /**
  16.          * @private
  17.          */
  18.         public function set width(value:Number):void {
  19.             _width = value;

  20.             // 表示リストをレンダリングする必要のある次の機会に、表示オブジェクトに通知する。
  21.             if (stage) stage.invalidate();
  22.         }

  23.         /**
  24.          * 表示オブジェクトの高さを示します(ピクセル単位)。
  25.          */
  26.         public override function get height():Number {return _height;}

  27.         /**
  28.          * @private
  29.          */
  30.         public function set height(value:Number):void {
  31.             _height = value;

  32.             // 表示リストをレンダリングする必要のある次の機会に、表示オブジェクトに通知する。
  33.             if (stage) stage.invalidate();
  34.         }

  35.         /**
  36.          * 背景色を指定します。
  37.          */
  38.         public function get backgroundColor():uint { return _backgroundColor; }

  39.         /**
  40.          * @private
  41.          */
  42.         public function set backgroundColor(color:uint):void {
  43.             _backgroundColor = color;

  44.             // 表示リストをレンダリングする必要のある次の機会に、表示オブジェクトに通知する。
  45.             if (stage) stage.invalidate();
  46.         }

  47.         /**
  48.          * タイムラインが進む直前で描画します。
  49.          * @param event
  50.          */
  51.         private function draw(event:Event):void {
  52.             if (_width == 0 || _height == 0) return;
  53.             graphics.clear();
  54.             graphics.beginFill(_backgroundColor);
  55.             graphics.drawRect(0, 0, _width, _height);
  56.             graphics.endFill();
  57.         }
  58.     }
  59. }

最後に

AS2.0のときはあまり気にしなかったタイムラインのライフサイクルだけど、AS3.0だとそこら辺が有効に制御できます。
ちょいと難しいけど、覚えておくとちょっとだけ幸せになれます。