AS3が便利すぎてAS3ライクにコードが書けるopenFrameworksアドオン作った。

この記事は FLASHer Advent Calendar 2016 11日目の記事です。

こんばんわ。selflashと言います。


##__思い出話__
***
本題に入る前にFlash全盛期の「あの人は今」というキーワードを見かけたので少し思い出話(雑談)を。

当時のフルFlashサイトといえばどんどんリッチWebサイトになればなるほど、次第に
3D的な表現が多用されるようになりましたね。
PaperVision3D, Away3D, Alternativa3Dから始まりついには時代は自作3Dエンジンへ！
と時代は戦国時代へと突入したのですが、、
その時代に１人ずば抜けた伝説的なFlasherがいました。

そうです。　誰もがそこに痺れる憧れる伝説のFlasher城戸さん！！
城戸さんのサイトはいつもどうやって作っているのかわからないようなサイトばかりでした。

[エコだ！動物園]
(http://roxik.com/v/6/)

[バーベイタム選手権(サービス終了)]
(http://roxik.com/v/8/)

[The Planet Zero]
(http://roxik.com/v/11/)


僕がFlasherとしての駆け出しの頃は、毎回城戸さんの新作コンテンツを見る度に心を躍らせ、
その数分後には

「そっか、この人だけ1日が48時間くらいあるんだろうぁ。。(ひとり精神と時の部屋マン)」

と自分に言い聞かせて心を落ち着かせていた思い出があります。(遠い目)


時を同じくして、僕が今の会社に入社したての頃、社内でも自社サイトを3D格闘ゲームのコンテンツへと
リニューアルする為の開発の真っ最中でした。
僕はWeb上のFlashでこんな3D格闘ゲームが作れるのか！！！と度肝を抜かれましたし、
開発が進んでいく様子を見るのが楽しみでもありました。
そのサイトが僕も大好きな

[CREATIVE IS ENDLESS BATTLE]
(http://www.1-10.com/design/)

です。
このサイトの3D格闘する部分のFlash製の独自3Dエンジンを制作した大先輩が
何日か後にこのFLASHEer Advent Calendarに記事を投稿してくれるらしいです。
超絶クオリティの3Dサイトを生み出してきた城戸さんや僕もお世話になったProgressionフレームワークのniumさん等、フルFlashサイト黄金期を賑わせた有名Flasher達は今どうしているんだろう。。と気になる人達もいると思います。
その中で、当時の貧弱なPCでのWebブラウザ環境で3D格闘ゲームを実現させたFlasherは今どこで何をしているのだろうと。。。
その先輩は今でも僕の隣の席で仕事をばりばりこなしているわけですが、あのサイト以降今日までどんな仕事をしてきたのかの日記でもいいので是非Calendarに投稿してくださいよ！と懇願したら、いやいや引き受けてくれました！
こうした場に出てくる事なんてめったにないツチノコFlasherな方なので僕も今から楽しみにしてます。


##__本題__
***
さて、ここからが本題なのですが。
僕は5年程前から、WebでのフルFlashコンテンツからインスタレーションと自身
フィールドを変えた来たのですがその際に初めてopenFrameworks(以下 oF)というものを触りました。
AS3からプログラミングを始めた僕にとって、初めてのC++(oF)というのはもの凄く
難しかったし、今でも全然理解ができてませんで、なんとなくでコードを書いている毎日です・・

当時は「Flashのディスプレイオブジェクトツリーはなんて素晴らしいんだろう・・」と
噛み締めながらoF(C++)の勉強をしていました。
oF上で少し複雑な構造の表示物を(UI等)を
作ろうとするとAS3の時のようにいかずかなり手こずります、、
そしてデバッグ用に微調整するUIが欲しくてとうとうこんなものを作りました。

__[oF上でAS3ライクな記述ができるアドオン「ofxSelflash」](https://github.com/selflash/ofxSelflash)__

アドオンというよりもはやフレームワークに近いような大きさになってしまったので、
作り始めた当時はFlashFrameworks（仮)という名前でこんな感じにコツコツ作ってました。

[TEST01 Multilight - flashFramework for openFrameworks  (3年前)]
(https://player.vimeo.com/video/74111230)
[TEST02 Mesh field - flashFramework for openFrameworks  (3年前)]
(https://player.vimeo.com/video/76513715)


過去の実案件でもちょくちょく投入してたり
[REAL INVADER developer&#039;s view  (3年前)] 
(https://player.vimeo.com/video/73204777)
[InkShader-1  (2年前)] 
(https://player.vimeo.com/video/134059992)
[InkShader-2  (2年前)] 
(https://player.vimeo.com/video/134058609)

いろいろと未実装箇所が多すぎるのとバギー過ぎた為、公開してなかったのですが、
安定して少し落ち着いてきたので思い切ってアドオン化してgithubにて公開してます。


##__特徴__
***

__+ インタラクティブオブジェクトが使える。(AS3でのマウスイベント周りの挙動を再現)__
__+ ディスプレイオブジェクトツリーが使える。(AS3での表示オブジェクトの重なり順の挙動を再現)__

oFは描画は高速なのですが、独自UIを作りたいという場合にこれら2つの機構が必須だった
のですが、やっぱりAS3の挙動を真似るのが早いと思い作りました。
oF上でAS3まがいを実装してて思った事は、まぁこれは確かにAS3って重くなるよね・・って感じました。
(オブジェクトと常時監視する部分だったりとか)
凄く便利なんですけどねAS3！
もともとAS3のビルドインクラスをまるっと移植しようと思ってたわけじゃなく、
僕自身がInteractiveObject、DisplayObjectContainerの機能がまるっと欲しかっただけなので、
下記のような表示系クラスには全然力入れてません。というより中途半端 or ほぼ未実装です、、

+ MovieClip(初期には作ってたが早い段階で開発中断の為どこまで実装したかも覚えてない)
+ BitmapData(未実装。いらないでしょ)
+ GraphicsクラスのAPIは不十分(CurveToやDrawTrianglesは未実装)

さらに下記の機能は未実装です。
+ フィルターまわり(これはいらないかと。。実装予定なし！ 各自GLSLでやるでしょ)
+ マスクまわり(スクロールバー系のUIが欲しいからいつか実装しようとは思ってる)
+ ブレンドモードまわり(実装途中。というかどこまで実装してたか忘れた)
+ カラートランスフォームとかとか





もし、それでも興味があるという少数派の方の為に使い方を書いておきます。
※Windows10でも動作は確認していますが、今回はMacでの場合

ProjectGeneratorを使ってアドオンして新規プロジェクトを作成します。
<img width="612" alt="スクリーンショット 2016-12-05 15.22.14.png" src="https://qiita-image-store.s3.amazonaws.com/0/21126/404b6632-ce25-ec54-e382-4d021ff80eca.png">


生成されたプロジェクトフォルダ内のbin/dataフォルダ内に
ofxSelflashのアドオンフォルダ内にあるbin/data/flフォルダをコピーします。
![スクリーンショット 2016-12-05 15.42.31.png](https://qiita-image-store.s3.amazonaws.com/0/21126/1c0de686-006e-861e-a3a7-03d5775eea05.png)

プロジェクトを開いてビルド時すると下記のようなエラーがでると思います。
<img width="1512" alt="スクリーンショット 2016-12-05 15.35.24.png" src="https://qiita-image-store.s3.amazonaws.com/0/21126/8739b166-2c0a-2d4e-6265-8d2f0d5a6fd2.png">



これはアドオン内のfl2d/ui/Mouse.cppとutils/NativeWindow.cpp内で
ObjectiveC++のコードが使われている為です。
なのでこの２つのcppファイルのTypeを C++ Source から Objective C++ Srouce に変更しましょう。

![_スクリーンショット-2016-12-05-15.35.55.png](https://qiita-image-store.s3.amazonaws.com/0/21126/24bf4a89-18a5-2c54-4322-d3d5cb4b31e7.png)

![__スクリーンショット-2016-12-05-15.35.55.png](https://qiita-image-store.s3.amazonaws.com/0/21126/5c9749f4-e536-e493-cbcd-2fc3c11dc209.png)

これで無事にビルドできると思います。


##__記述の際の基本__

次に実際のコードについてなのですが、
このアドオンを使うにあたって、記述方法がC++をごりごり書く人にとっては
到底受けいられない様な記述方法を強いられます・・（むやみやたらにポインタ使うな。とか)

が、あくまでAS3に慣れ親しんだ人がC++わかんなくてopenFrameworks使えないよ・・
って人の為のアドオンだと割り切っていますのでご了承ください！ orz




+基本的にポインタを使った宣言をする事

```cpp
flSprite* sprite = NULL;
sprite = new Sprite();
```

+なのでシェアードポインタを未使用な分、AS3と同じでメモリリークは自己管理で

```cpp
delete sprite;
sprite = NULL;
```

+C++にはセッター、ゲッターのサクセサがありません。
なのでプロパティへのアクセスは全て関数を通して行います。
引数を渡せばセッター、引数を渡さなければ値を返すゲッターとしての役割を果たします。

```cpp
//ゲッター
float x = sprite->x();

//セッター
sprite->x(100);
```
---------------------------------


この時点でC++使いの人達からの怒号が聞こえてきそうですが・・
AS3の人たちにとってはそこまで抵抗ないはず、、(多分)
ソースを見られると「こんなウンコードなC++書きやがって！！」とか思われると
思いますが、バグなくそとづらの挙動がAS3であればOK。なアドオンです。
シェアードポインタに頼らなくても、AS3な人達はメモリー管理も自前でやってきたから大丈夫ですよね(遠い目)


##__サンプルコード__
続いてサンプルの最小コードです。
ヘッダーファイル内でアドオンをインクルードします。
Stageはシングルトン的な扱いなのでインスタンスを作成する事はできません。
スタティックなStageへの参照に対してSpriteを一つ作ってaddChildし、
そのSpriteのグラフィックスに矩形を描く
といったコードになってます。
Stage.hを覗くとわかりますが、AS3でのstage.rootも用意してたのですが、MovieClipクラスが
まだ実装を途中でやめてしまったのでまだ使用不可です。

```cpp:ofApp.h
#include "ofxSelflash.h"
```
```cpp:ofApp.cpp
void ofApp::setup() {
    //Ready ofxSelflash
    ofxSelflash::setup();

    //Get Stage Reference
    flStage* stage = ofxSelflash::stage();

    //Create New Sprite
    flSprite* sprite = new flSprite();

    //Set Position
    sprite->x(100);
    sprite->y(200);

    //Draw Graphics
    flGraphics* g;
    g = sprite->graphics();
    g->clear();
    g->lineStyle(1, 0xff0000);
    g->beginFill(0xffffff);
    g->drawRect(0, 0, 100, 100);
    g->endFill();

    //Add to Display-Object-Tree
    stage->addChild(sprite);
}
```


続いてみんな大好きaddEventListenerの書き方はこんな感じ。

```cpp:ofApp.h
void eventHandler(flEvent& event);
```

```cpp:ofApp.cpp
void ofApp::setup() {
    sprite.addEventListener(flEvent::ENTER_FRAME, this, &ofApp::eventHandler);
}

void ofApp::eventHandler(flEvent& event) {
    cout << "イベントタイプ = " << event.type() << endl;
    cout << "カレントターゲットのアドレス = " << event.currentTarget() << endl;
    cout << "カレントターゲット名 = " << ((flDisplayObject*) event.currentTarget())->name() << endl;
    cout << "ターゲットのアドレス = " << event.target() << endl;
    cout << "ターゲット名 = " << ((flDisplayObject*) event.target())->name() << endl;

    if(event.type() == flEvent::ENTER_FRAME) {
        cout << "エンターフレームイベント" << endl;
    }
}
```

AS3に馴染みのある人にとっては大分取っつきやすい記述になっているかと思います。
イベントのターゲット、カレントターゲットも実装してます。
(※実際使った時にAS3と返り値が違うよって時にはおしらせください)



##__サンプルプロジェクト__
ofxSelflashではいくつかのサンプルプロジェクトも用意してます。

###ディスプレイオブジェクトツリーの挙動と記述のサンプル
***
example-DisplayObjectTree
<blockquote class="twitter-tweet" data-lang="ja"><p lang="en" dir="ltr">example-DisplayObjectTree <a href="https://t.co/1FRZUbUy5b">pic.twitter.com/1FRZUbUy5b</a></p>&mdash; selflash (@selflash) <a href="https://twitter.com/selflash/status/807598506303074304">2016年12月10日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>


###ヒットエリアプロパティの挙動と記述のサンプル
***
example-HitArea
<blockquote class="twitter-tweet" data-lang="ja"><p lang="en" dir="ltr">example-HitArea <a href="https://t.co/wYgf00qaqx">pic.twitter.com/wYgf00qaqx</a></p>&mdash; selflash (@selflash) <a href="https://twitter.com/selflash/status/807504183251243008">2016年12月10日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>


###各UIコンポーネントの挙動と記述のサンプル
***
example-UIComponents-1
<blockquote class="twitter-tweet" data-lang="ja"><p lang="en" dir="ltr">example-UIComponents-1 <a href="https://t.co/Zj2zFnd2kV">pic.twitter.com/Zj2zFnd2kV</a></p>&mdash; selflash (@selflash) <a href="https://twitter.com/selflash/status/807504952729878528">2016年12月10日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>



###テンプレートとして用意されているBasicControllerクラスのサンプル
***
example-BasicController
<blockquote class="twitter-tweet" data-lang="ja"><p lang="en" dir="ltr">example-BasicController <a href="https://t.co/9ggL2QM6ml">pic.twitter.com/9ggL2QM6ml</a></p>&mdash; selflash (@selflash) <a href="https://twitter.com/selflash/status/807505235602063360">2016年12月10日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>


###テンプレートとして用意されているBasicDraggableObjectクラスのサンプル
***
example-BasicDraggableObject
<blockquote class="twitter-tweet" data-lang="ja"><p lang="en" dir="ltr">example-BasicDraggableObject <a href="https://t.co/RGjOP4LSBX">pic.twitter.com/RGjOP4LSBX</a></p>&mdash; selflash (@selflash) <a href="https://twitter.com/selflash/status/807129894060601344">2016年12月9日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>


###Spriteを継承して生のoFのコードと組み合わせるサンプル
***
<blockquote class="twitter-tweet" data-lang="ja"><p lang="en" dir="ltr">example-ExtendsSprite <a href="https://t.co/HMD3ZBvnQk">pic.twitter.com/HMD3ZBvnQk</a></p>&mdash; selflash (@selflash) <a href="https://twitter.com/selflash/status/807503741108654080">2016年12月10日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
このサンプルに関しては補足を。
基本的にはofxSelflash上のクラスがprotected virtualとして宣言されている
_setup, _update, _draw関数がありますのでそちらの中にいつものoFの記述をすれば大丈夫です。
クラスの外からはsetup(), update(), draw()を呼ばれた時に適時これらの関数が呼ばれます。
継承する時にひとつ気をつけなければいけないのはwidth,heightです。
Bitmapクラスを使わずに_draw関数内で自分でofImageなどを描画した場合widthとheightが適切に更新されません。
マウスによるインタラクティブ周りを司っているInteractiveObjectクラスの恩恵を受ける必要がないならそれでもいいのですが、
もし必要であれば、透明なGraphicsで塗る事で自分で拡張したSpriteクラスでも
マウスイベント周りが適切に動作します。具体的には以下の様な感じです。


```cpp:ofApp.h
ofImage image;
```
```cpp:ofApp.cpp
void MySprite::_draw() {
    image.draw(0, 0, 500, 500);

    //--------------------------------------
    //ヒットエリアとしてofImageの描画した領域と
    //同じ面積分透明のグラフィックスを塗る
    flGraphics* g;
    g = graphics();
    g->clear();    
    g->beginFill(0x0000cc, 0);
    g->drawRect(0, 0, 500, 500);
    g->endFill();
    //--------------------------------------
}
```

##__最後に__
本アドオンは基本的に僕が案件で使いたいAS3のクラスやプロパティをごりごり実装してきたので、
裏を返せば僕が案件で困らなかったAS3のビルドインクラスの実装にはあまり前向きじゃありません。
ですが、もし「AS3のこれを是非移植してほしい・・」などの要望があれば対応出来る範囲ではこつこつやっていこうかなとは思ってます。
(むしろAS3大好きな有志を募ってみんなで完成させませんかね・・？　デバッグ協力隊でも助かります・・)
AS3のビルドインンクラスのほとんどが再現できればofxProgressionも作れますね！

なにはともあれ、お気軽にご相談ください！
バグやC++的な書き方で間違っているなどのFBの方もお待ちしております。

という事でメリークリスマス！
良いAS3ライフを！