KLabGames Tech Blog

KLabは、多くのスマートフォン向けゲームを開発・提供しています。 スマートフォン向けゲームの開発と運用は、Webソーシャルゲームと比べて格段に複雑で、またコンシューマゲーム開発とも異なったノウハウが求められる領域もあります。 このブログでは、KLabのゲーム開発・運用の中で培われた様々な技術や挑戦とそのノウハウについて、広く紹介していきます。

※この記事ではgitのタグ「v2.74」から生成したブランチ上でコードリーディングしています。

前回は流体シミュレーションの実験のためのプロジェクトを作成しました。
( プロジェクトファイルのダウンロードはこちら
今回はこれをもとに流体シミュレーションのコードリーディングをしていきます。

流体シミュレーションの計算が行われるのはDomainタイプのFluidオブジェクトのBakeボタンを押したときです。このときに何が起きるのか探っていきましょう。

流体計算の関数を探す

まずはBakeボタンを押したときに呼ばれる関数を探したいと思います。

どうやって探すか?UIパーツにマウスカーソルを合わせると、そのUIに関するPythonの命令を表示してくれます。Bakeボタンにマウスカーソルを合わせてみると、
bake_python
bpy.ops.fluid.bake() というPythonの命令が出てきます。

ここで余談になるのですが、Blenderはコマンドラインからバックグラウンドで立ち上げる事も出来ます。Mac Proなどハイスペックなマシンをサーバーとして用意しておき、流体シミュレーションのBakeなど長く時間のかかるものはサーバーで起動したBlender上でPythonコマンドを使って自動で処理させておくような事も可能です。

さて、話を元に戻してbpy.ops.fluid.bake()を起点にC<ー>Pythonのつなぎの部分のコードを追いかけていくと確実にたどり着けそうですが・・・まあ、もっとシンプルに「fluid」や「bake」で検索すればおそらくたどり着けるでしょう。

Xcodeのパターン検索で、「fluid(Any)bake」で検索すると、
30 results in 4 files
案の定、physics_fluid.cといういかにも関係ありそうな名前のファイルが引っかかります。 このphysics_fluid.cのなかで「fluid(Any)bake」は27カ所。その中でも関数の定義だけに絞り込んで関係してそうな名前のものだけピックアップしてみると

static int fluidsimBake(bContext *C, ReportList *reports, Object *fsDomain, short do_job)

static int fluid_bake_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))

static int fluid_bake_exec(bContext *C, wmOperator *op)

となります。

fluid_bake_invoke()もfluid_bake_exec()も両方中でfluidsimBake()を呼んでいるので、fluidsimBake()の先頭部分にブレイクポイントを張ってBakeボタンを押してみる事にします。すると狙い通りブレイクポイントに引っかかりました!

fluidsimBake()の中身を追う

fluidsimBake()の中身は232行に渡っています。その中の多くはパラメータをセットする命令になっているようです。最後の方にジョブをスタートさせたりコールバックの設定をしたりするような部分があります。おそらく別スレッドで非同期に動かすためのジョブのパラメータをセットし、最後にジョブをスタートさせる事で流体シミュレーションを実行させているのではないでしょうか?Bakeが終わるのを待っている間他の操作が同時に出来るので、そう考えると自然な気がします。

ジョブを追う

このような予測のもと、ジョブを中心に追いかけていこうと思います。実際の流体計算にたどり着き、それが別スレッドで実行されていれば予測が的中しているものと見てよさそうです。

fluidsimBake()の最後の方で呼ばれているfluidbake_startjob()がジョブをスタートさせる関数で、これに渡されているジョブがfbと言う名前の付いたFluidBakeJob構造体のポインタです。

typedef struct FluidBakeJob {
    /* from wmJob */
    void *owner;
    short *stop, *do_update;
    float *progress;
    int current_frame;
    elbeemSimulationSettings *settings;
} FluidBakeJob;

最後のelbeemSimulationSettings *settings;にいろいろ詰まってそうです。

fluidbake_startjob()を呼ぶ直前で、

fb->settings = fsset;

というように、fssetというポインタが渡されています。

このelbeemSimulationSettings構造体の中身に

elbeemRunSimulationCallback runsimCallback;

という関数ポインタ(別の場所でelbeemRunSimulationCallbackはtypedefされている)が定義されています。コールバックなのでもし流体計算が別スレッドで処理されていればそのスレッドから呼ばれるので、ブレイクポイントで止めれば計算箇所を突き止められるかもしれません。

fsset->runsimCallback = &runSimulationCallback;

のように、physics_fluid.cの中の

static int runSimulationCallback(void *data, int status, int frame)

がセットされています。この関数の先頭にブレイクポイントを仕掛けてみましょう。すると予想通り別スレッドから呼ばれている事がわかりました。ブレイクポイントに引っかかっているので、どの関数からコールバックが呼ばれているのかもわかります。

「elbeem」ってなんだ??

どうもさっきからelbeemSimulationSettingsやelbeemRunSimulationCallbackの「elbeem」という名前が目につきます。そしてブレイクポイントを張って調べたrunSimulationCallback()もbf_intern_elbeemフォルダの中のソースから呼ばれています。

この「elbeem」って何なんでしょう?Googleで調べてみると
http://elbeem.sourceforge.net
にたどり着きます。

「El'Beem Is an Open-Source free surface fluid simulation library.」Blenderは流体シミュレーションのためにこのライブラリを採用していたのですね!格子ボルツマン法に基づいたライブラリだそうです。これだけで参考書や論文が何本もありそうですね(^^; こ、ここを追いかけるのは ま、またの機会に・・・|)彡サッ


@fmystB

ターミネーター

2015年7月10日に映画ターミネーターの最新作「ターミネーター: 新起動/ジェニシス」が公開になりましたね!

この最新作でも「ターミネーター2」で初登場してシュワちゃん達を苦しめたアイツが登場するようです。

そう、液体金属ロボット「T-1000」です!

液体金属なのでどんな形にも自在に変形可能。手を武器に変形させて襲いかかります。小さな隙間から侵入したり、別の人物に成り代わって待ち伏せする事も可能です。銃で撃たれても自己再生するのでとても厄介!

Youtubeで検索すれば元祖の方も含めてT-1000の映像はたくさん出てきますよ。

ターミネーター2が公開されたのはずいぶん前の話ですが、あの時代にもこんなにすごい映像を作る技術が存在したのですね。

私はこのT-1000が大好きで、技術的目標の一つなのです。それもあって今では3D関連のプログラミングを仕事にしています。見る人を「あっ!!」と言わせるようなものを作りたい!

私以外にも多くのファンを惹き付けたT-1000ですが、この映像を作るためにシェーディングや流体シミュレーションなど色んな技術が使われている事でしょう。今は映画スタッフのような専門の人でなくても普通の人が無料でこのような技術に触れる事が出来るんですよ!そう、Blenderの出番です。

特に今回はT-1000の動きに関係の深そうな流体シミュレーションの技術に触れてみましょう。と、いうわけでBlenderの流体シミュレーション周りのコードを探っていきたいと思います。part1では下準備として、簡単な流体シミュレーションのプロジェクトをBlenderで作っていきます。

とってもお手軽な流体シミュレーションのやり方

( 作り方は気にせず完成したプロジェクトだけ欲しい場合は下にファイルへのリンクがあります。 )

1、オブジェクトの中にオブジェクトを作る都合上、ひとまずWireflame表示に切り替えます。
wireflame

2、デフォルトで配置されているキューブを適当に大きくします。
default
big

3、上記のキューブの内部に新しくキューブを追加して、大きいキューブ内部の上の方に移動します
small

4、さらに障害物となるキューブを追加し、大きさを調整して移動します。
obstacle_perspective
obstacle_frustum

5、ここから物理オブジェクトとしての設定をしていきます。まず小さいキューブを選択してプロパティエディタのPhysicsタブからFluidボタンを押します。
fluid
Typeは「Fluid」を指定します。
type_fluid

6、次に障害物用のオブジェクトを選択して同じようにFluidボタンを押します。Typeは「Obstacle」を指定します。
type_obstacle

7、最後に大きいキューブを選択してFluidボタンを押し、Typeは「Domain」を指定します。
type_domain

8、DomainタイプにはBakeボタンがあるので押します。
bake_button
これで物理計算が走り、進捗は画面上に表示されるプログレスバーで確認できます。時間のかかる処理なので途中でキャンセルしたい場合はxボタンを押しましょう。
baking

9、物理計算が終了した後、アニメーションを再生するとドメイン内で障害物に邪魔されながら水の落ちる様子が確認できます。
playing

今回のプロジェクトファイルのダウンロードはこちら(右クリックでリンク先を名前を付けて保存してください)
ちなみに、上記bakeボタンを押して物理計算が終了すると、このfluidsym.blendと同じフォルダにcache_fluidというフォルダが出来て中に計算結果のキャッシュデータがたまるのですが、このデータはファイルサイズが大きいためここには置かないので上記ファイルダウンロード後にbakeボタンを押してご自身で作成してください。これが無いとアニメーションを再生させても水が落ちません。

プリレンダリングという技術

Bakeには少々時間がかかると思います。MacBook Pro Mid 2014, 2.6GHz intel Core i5で実験しましたが数分待たされました。このようにレンダリングに必要なデータを事前計算しておく事はプリレンダリングという技術に分類されます。ゲームのムービーシーンや映画で使われる技術で、ターミネーターシリーズでも様々なシーンで使われている事でしょう。ゲームのプレイ中にユーザーの操作を動的に受け付けながらレンダリングするリアルタイムレンダリングとはまた違った技術です。Blenderには多くのプリレンダリングの技術が含まれているのでプリレンダリングを研究したい場合は他に無いくらい最適な材料になるかと思います。

今回作ったプロジェクトを使って、part2ではブレイクポイントを張りながらコードを追いかけていきます。それではまた次回。
I'll be back.


@fmystB

※この記事ではgitのタグ「v2.74」から生成したブランチ上でコードリーディングしています。

頂点が頻繁に更新されるのはEditモードだよね

前回の記事の続きです。

前回はObjectモード時のレンダリングはGPUで行われている事を突き止めましたが、今回は頂点データが頻繁に更新されてメインメモリ<ー>GPUメモリ間のデータ転送コストが毎回発生するであろうEditモードのレンダリングについて調べてみます。Editモードのレンダリングに使われているのはCPUでしょうか?GPUでしょうか?

OB_MODE_EDITで探るもレンダリング命令まで行き着かず

Objectモードのときはdrawobject.cの中でObjectモードを示すenum値:OB_MODE_OBJECTの付近を探っていたら運良くレンダリング命令の部分を引き当てる事に成功しましたが、今回はEditモードを示すOB_MODE_EDITの付近を探ってみるも、レンダリング命令に行き着きませんでした。

しかしdrawobject.cの中に目的の部分がある可能性は捨てず、別の方法で探す事にしました。いろいろ検索条件を変えて絞り込んでいきましょう。

Objectモードのときと同じようにdrawFacesSolidが答えか?

ObjectモードのときはdrawFacesSolidという関数ポインタがドローコールにつながっていたので、Editモードのときも同じようにViewport ShadingがSolidの場合は関数ポインタdrawFacesSolidがドローコールにつながっているかもしれません。

drawobject.cの中で関数ポインタdrawFacesSolidがコールされている場所は8カ所。試しに8カ所全てコメントアウトしてみるも、Editモードの時のモデルの面が消える事はありませんでした。

drawFaces〜〜〜かな??

ついでに「drawFaces」でdrawobject.c内を検索してみましょう。

ヒットは11件で8件が先ほどのdrawFacesSolid。1件はenum値なのでこれは関係なし。残る2件はdrawFacesGLSL(GLSLはOpenGLのシェーダ言語)という関数ポインタで、EditモードはデフォルトでSolidシェーディングなのでGLSLが使われる事もなさそうだから違うだろうなと思いつつ2件ともコメントアウトしてみるもやはり該当しませんでした。

試行錯誤

「draw」ならどうか?ヒットは1311件。これは調べきれません。

Objectモードのときと同じように構造体内の関数ポインタになっていると予想できるので、「->draw」で検索してみると135件。まだ手探りで該当箇所を探るのはキツい件数ですね。

Xcodeはパターン検索が出来るので「->draw〜〜〜(」という形で検索して絞り込む。すると55件。もう少し絞りたい!この55件の〜〜〜の中には「Verts」(頂点)や「Edges」(辺)という文字列が含まれています。でも狙いは「Faces」(面)なので「->draw〜〜〜Faces」で検索。すると12件まで絞れました。これくらいの数であれば1つ1つ手で調べていけますね!この12件の中に答えがあるか!?

容疑者:drawMappedFaces

12件のうち1件は関数でも関数ポインタでもないので除外。そして10件は関数ポインタdrawMappedFaces、1件は関数ポインタdrawMappedFacesGLSLです。Objectモードのときもdraw〜〜〜という関数ポインタがレンダリング命令につながっていたので、この11件の中のどれかがEditモードの面のレンダリングにつながっているかもしれません。

どの関数がdrawMappedFacesまたはdrawMappedFacesGLSLを呼び出しているかを列挙してみると、

  • draw_dm_faces_sel() 1件
  • draw_em_fancy() 3件
  • draw_mesh_fancy() 1件
  • bbs_mesh_solid_EM() 2件
  • bbs_mesh_solid_verts() 1件
  • bbs_mesh_solid_faces() 2件
  • draw_object_mesh_instance() 1件

となっていました。

Objectモードのときはdraw_mesh_fancy()がdrawFacesSolid()を呼び出していてレンダリング命令につながっていましたね。試しにdraw_mesh_fancy()の中のdrawMappedFaces()をコメントアウトして実行してみましたが、Editモードの面のレンダリングには関係ないようです。

次はdraw_mesh_fancy()と同じように「fancy」の付くdraw_em_fancy()辺りが怪しいでしょうか?3件ともコメントアウトしてみます。
before
↓↓↓
after
Editモードの面が消えましたね!!結果、3つの関数ポインタdrawMappedFacesのうち最後が今回探している起動時のデフォルト状態からEditモードに切り替えた直後の面のレンダリング部分につながっているようです。

関数ポインタが指す関数本体は?

さて、狙いの関数ポインタdrawMappedFacesも見つかった事ですし、ステップ実行してこのdrawMappedFacesが指し示している関数本体を探してみましょう。するとdrawMappedFacesはeditderivedmesh.c内のemDM_drawMappedFaces()を指し示している事がわかります。

emDM_drawMappedFaces()の中ではやはりOpenGLのレンダリング命令が使われており、GPUレンダリングが行われているようです。CPUか?GPUか?答えが出ましたね!

おまけ

ObjectモードのときはglDrawArraysで頂点データの格納された配列の中身を一気にレンダリングしていました。

Editモードのときはこれと違い、for文の中で三角形を1つずつレンダリングしているようです。きっと頻繁な頂点の追加&削除の負荷に耐えるためでしょう。

試しにfor文のカウントの上限値から1を引いてみたら三角形が1つ欠けたりするんでしょうか?
before
三角形が1つ消えましたね^^


@fmystB

↑このページのトップヘ