tanaka's Programming Memo

プログラミングについてのメモ。

水面やUnlitシェーダーとDepth of Fieldの不具合対策メモ

f:id:am1tanaka:20220215232012j:plain
Depth of Fieldと相性が悪いもの

オブジェクト指向を勉強するための素材となる海賊をモチーフにしたスゴロクもどきゲームを開発しています。

f:id:am1tanaka:20220218152125p:plain
制作中の海賊スゴロク(仮)

箱庭っぽいイメージを狙ってPost ProcessingのDepth of Field(DOF:被写界深度)を設定して、水面はフリーながらカッコいいLowPoly Waterを組み込みました。いい感じでできたと思ったのですが、水面に配置したFadeの波紋オブジェクトが消えたり、手前にある水面がボヤけたりと謎の症状が発生しました。それらの問題の原因と解決策の備忘録です。

目次

問題

問題を検証するためのプロジェクトを作成しました。手元で確認したい場合にご活用ください。セットアップ方法はリポジトリのREADME.mdにあります。

github.com

3つ並んでいるうちの真ん中のCubeは正常に描画されています。Materialの設定は、シェーダーはStandard、Rendering ModeはOpaqueです。Cutoutでも正常に描画できます。

f:id:am1tanaka:20220215233023j:plain
FadeとUnlitと水面

左右のCubeも同じ奥行きに配置しているのですが、以下のような問題が起きてます。

  1. 左のCubeの下の消失。StandardシェーダーのRendering ModeをFadeにすると発生します。Transparentでも同じ状態になります
  2. 右のCubeのボヤけ。Unlitシェーダーで描画しています
  3. 真ん中のCubeの下の水面のボヤけ。遠くにあるようにボヤけていますが、水面は立方体の直下です

原因

1. FadeやTransparentが消える

この症状は、FadeやTransparentのオブジェクトと、LowPoly Waterで作成した水面オブジェクトの位置関係で発生します。

f:id:am1tanaka:20220216125053g:plain
消えたり現れたり

f:id:am1tanaka:20220215234239p:plain
上からみるとこんな感じ

水面の中心がCubeの中心よりカメラに近くなると不具合が発生します。

LowPoly Waterの水面のRender Queueは、FadeやTransparentと同じ3000に設定されています。Render Queueは、描画処理の仕方や描画順を決める値です。詳しくは ShaderLab: SubShader 内のタグ - Unity マニュアルレンダリング順 - Queue タグにあります。

Render Queueは描画順などを決める設定で、値が小さい方から描画します。Render Queueが同じ値の時は、2500以下かどうかでルールが変わります。2500以下は不透明扱いになり、Zバッファ(奥行きバッファ=デプスバッファ)への書き込みとテストをしながら手前から奥へ描画していきます。Zバッファより奥のものは見えないはずなので描画を省いて時間を節約します。2500より大きい場合は半透明として扱います。奥の物が透けて見える可能性があるので、Zバッファは更新せず奥から手前に上書きしていきます。

ここで問題となるのが水面のシェーダーです。LowPoly Waterは独自のWaterShadedシェーダーで水面を描画します。Zバッファを参照して、水面下の不透明物と水面の距離に応じて波を表現したり、水面下を半透明で描いたりしています。この処理が描画済みの半透明のオブジェクトを考慮していないため、FadeやTransparentのオブジェクトが奥にあって先に描画されていた場合に水面が上書きして消してしまうのです。

2. Unlitのオブジェクトがボヤける

ボヤけるのはDepth of Fieldの効果ですが、Unlitのオブジェクトの奥行きが正しく反映されずボヤけ過ぎてしまっています。よく観察してみると位置によってボヤけ方が変わっています。

f:id:am1tanaka:20220216001010j:plain
水面の下を観察

赤で囲った部分とそれより下では、囲んだ範囲の方が少しだけボヤけ具合が弱くなっています。また、左のFadeのCubeの表示範囲と赤で囲った部分が一致しています。FadeやTransformはZバッファに奥行きを書き込まないので、奥にある不透明なものまでの距離に応じたエフェクトがかかっているのです。Unlitも原因は同じです。Unlitは不透明でもZバッファに奥行きが書き込まれないのです。

Zバッファに書き込まれる時の条件が書かれている公式マニュアル。

docs.unity3d.com

以下の3つの条件が成立している状態でShadow Casterパスを描画する時に、ハードウェアがZバッファに奥行きを書き込みます。

  • マテリアルのRender Queueが2500以下
  • ZWrite On
  • ShadowCasterのパスが有効であること

Unlitは光の影響を受けないので影が描画されません。つまり、Zバッファを書き込むShadowCasterパスがないのです。Depth of Fieldが正しく反映されないのはこれが理由です。

3. 水面がボヤける

水面シェーダーのRender Queueが3000なので、水面の高さはZバッファに書き込まれません。どうせ半透明の描画順を調整するので、水面シェーダーを不透明なQueueにして、Shadow Casterを有効にすれば解決と思ったのですが、別の問題が発生しました。

f:id:am1tanaka:20220216205214p:plain
水面が真っ白に!

これは開発中の海賊スゴロクで水面の高さをZバッファに書き込んだ時のスクショです。ボヤけは解決しましたが水面が真っ白になっています。水面の高さをZバッファに書き込んだことで水面のすぐ下に物があると水面シェーダーが判定してしまい、波の白で塗りつぶしてしまうのです。水系のシェーダーはこの辺りの対策が必要です。

これで全ての原因が分かったので解決していきます。

解決編

FadeとTransparentの消失とボヤけ問題

消失問題はRender Queueを調整して水面を先に描画するようにすれば解決します。更にボヤけを防ぐには、Render Queueを2500以下、かつ、Shadow Casterパスの追加をしたカスタムシェーダーを作ります。

新規にUnlitシェーダーを作成して、ZBufferShaderのような名前にして以下のようにします。

Shader "Unlit/ZBufferShader"
{
    SubShader
    {
        Tags { "Queue"="AlphaTest+1"}
        LOD 100

        Pass
        {
            Tags { "LightMode"="ShadowCaster"}

            ZWrite On
            ColorMask 0
        }
    }
}
  • Render QueueはAlphaTest+1として、Cutoutより後で描画します
  • ColorMask 0は色もアルファ値も書き込まないようにする設定で、Zバッファだけ書き込みます

StandardシェーダーのFadeでの描画に加えて、このシェーダーでもCubeを描画します。Standardシェーダーに手を加えるとか、自前で後付け描画するなどのスマートな方法が考えられますが、今回はMesh Rendererに複数マテリアルを設定することにします。

このシェーダーを設定したマテリアルを作成して、FadeのCubeのMesh Rendererにテクスチャを追加します。

f:id:am1tanaka:20220217002133p:plain
Zバッファ専用マテリアル

「同じメッシュを別のマテリアルでそれぞれ描画するからパフォーマンス落ちるぞ。マルチパスを推奨」と言われてます。しかし、マルチパスでRender Queueを変える方法がなさそうだったので承知の上で押し通します。

これで問題が解決です。真っ白な部分がありますが、これは水面シェーダーが原因なので後で直ります。

f:id:am1tanaka:20220217002355p:plain
水面シェーダーの影響で真っ白

f:id:am1tanaka:20220217002959p:plain
水面がなければ大丈夫

注意!!

不透明なQueueにしたことで、手前から奥に描画することになります。そのため、このMaterialを設定したFadeやTransparentのオブジェクト同士が重なると奥にあるものが描画されなくなります。この辺りを完全に解決する手段はなさそうで、Render Queueをいじるなどして調整するようです。

Materialに表示されている警告が気になる場合は、自前でスクリプトを作成して描画すれば表示されなくなります。そのものズバり欲しい情報がLIGHT11さんのブログにありました。

light11.hatenadiary.com

やってることはMesh Rendererに警告されたことを自前のスクリプトに移動しただけのような気がするので、警告は消えますがパフォーマンス的には同じような気がします。本題の海賊スゴロクではこの問題は対応しなかったので今回は手を出しませんでした。サブメッシュが絡んできたら必要になるかも知れませんし、実際にはパフォーマンスの違いがあるかも知れません。その辺の問題が出た時にまた調査ということにします。

Unlitシェーダーのボヤけ問題

カスタムのUnlitシェーダーを作成して、ShadowCasterを有効にしたパスを追加します。これはよくある問題のようであちこちで解決策が見つかりました。公式を参考に解決します。

docs.unity3d.com

ついでにデフォルトだと半透明に対応していないので対応させました。新規にUnlitシェーダーを作成して、UnlitZBufferという名前にして以下のコードを書きます。

Shader "Unlit/UnlitZBuffer"
{
    Properties
    {
        _Color("Main Color", Color) = (1,1,1,1)
        _MainTex ("Texture", 2D) = "white" {}
    }
    SubShader
    {
        Tags { "RenderType"="Transparent" "Queue" = "AlphaTest+1" "IgnoreProjector"="True"}
        LOD 100

        Pass
        {
            Tags {"LightMode"="ShadowCaster"}
            ZWrite On
            ColorMask 0
        }

        Pass
        {
            Blend SrcAlpha OneMinusSrcAlpha

            CGPROGRAM
            #pragma vertex vert
            #pragma fragment frag
            // make fog work
            #pragma multi_compile_fog

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD0;
            };

            struct v2f
            {
                float2 uv : TEXCOORD0;
                UNITY_FOG_COORDS(1)
                float4 vertex : SV_POSITION;
            };

            sampler2D _MainTex;
            float4 _MainTex_ST;
            fixed4 _Color;

            v2f vert (appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = TRANSFORM_TEX(v.uv, _MainTex);
                UNITY_TRANSFER_FOG(o,o.vertex);
                return o;
            }

            fixed4 frag (v2f i) : SV_Target
            {
                // sample the texture
                fixed4 col = tex2D(_MainTex, i.uv) * _Color;
                // apply fog
                UNITY_APPLY_FOG(i.fogCoord, col);
                return col;
            }
            ENDCG
        }
    }
}

今回は追加パスとかは不要なので、既存のMaterialのシェーダーをこれに変更して解決です。

f:id:am1tanaka:20220217163454g:plain
カスタムUnlitZシェーダー適用!

半透明の部分が変な感じになりますが、これも水面の問題です。中央のCubeの色が変わるのはgif化した時の影響なので実際には起きません。

水面のボヤけ問題

この解決には、水面シェーダー用のカメラが必要になります。解決のヒントは先日ゲットしたTanuki Digital - Asset StoreさんのSUIMONO Water Systemで見つけました。

※これはアフィリエイトリンクです。

確認したところ、水の演出のために沢山のカメラが使われていました!!

f:id:am1tanaka:20220217165322p:plain
カメラ軍団!!

水面と水面下でそれぞれDOFを適用するなら別の奥行きが必要になりますし、水面下の半透明物は?とか考え出すと水系は大変だなと実感しました。優秀なアセット作者の皆様に感謝!!

水面シェーダー用のカメラの作成

水面下のZバッファを描画する水面用のカメラを作ります。メインカメラと同じものが必要なので、分かりやすくメインカメラの子供にしました。描画前に位置を合わせればいいので実際には場所はどこでも良さそうです。SUIMONOでは水面用のオブジェクトにまとめられてました。

  • HierarchyウィンドウのMain Cameraを右クリックして、Cameraを追加します
  • 追加したCameraのAudio ListenerをRemoveします
  • 新規でC#スクリプトを作成して、名前をUnderWaterCameraにして、以下のようにします
using UnityEngine;
using UnityEngine.Rendering;

[ExecuteInEditMode]
public class UnderWaterCamera : MonoBehaviour
{
    /// <summary>
    /// RenderTextureのサイズ
    /// </summary>
    static int renderTextureSize => 512;

    /// <summary>
    /// ビット数
    /// </summary>
    static int renderTextureDepth => 24;

    Camera sourceCamera;
    Camera underWaterCamera;
    RenderTexture underWaterTex;
    float currentAspect;

    private void Awake()
    {
        sourceCamera = transform.parent.GetComponent<Camera>();
        underWaterCamera = GetComponent<Camera>();
        underWaterCamera.CopyFrom(sourceCamera);
        underWaterCamera.cullingMask = underWaterCamera.cullingMask & (-1 ^ LayerMask.GetMask("Water"));
        underWaterCamera.clearFlags = CameraClearFlags.Depth;
        underWaterCamera.depth = -100;
        underWaterCamera.depthTextureMode = DepthTextureMode.Depth;
        underWaterCamera.targetTexture = null;
        UpdateRenderTex();
    }

    private void LateUpdate()
    {
        UpdateRenderTex();
        Shader.SetGlobalTexture("_WaterDepthTex", underWaterTex);
    }

    private void OnDestroy()
    {
        DestroyTexture();
    }

    void DestroyTexture()
    {
        if (underWaterCamera.targetTexture != null)
        {
            underWaterCamera.targetTexture = null;
        }
        if (underWaterTex != null)
        {
            DestroyImmediate(underWaterTex);
            underWaterTex = null;
        }
    }

    /// <summary>
    /// RenderTextureを生成
    /// </summary>
    void UpdateRenderTex()
    {
        if ((sourceCamera == null) || (underWaterCamera == null)) return;

        if (underWaterTex != null)
        {
            if (currentAspect != sourceCamera.aspect)
            {
                currentAspect = sourceCamera.aspect;
                DestroyTexture();
            }
            else
            {
                return;
            }
        }
        underWaterTex = new RenderTexture(
            renderTextureSize, renderTextureSize,
            renderTextureDepth,
            RenderTextureFormat.Depth,
            RenderTextureReadWrite.Linear);
        underWaterTex.dimension = TextureDimension.Tex2D;
        underWaterTex.autoGenerateMips = false;
        underWaterTex.anisoLevel = 1;
        underWaterTex.filterMode = FilterMode.Point;
        underWaterTex.wrapMode = TextureWrapMode.Clamp;
        underWaterCamera.aspect = sourceCamera.aspect;
        underWaterCamera.targetTexture = underWaterTex;
        currentAspect = sourceCamera.aspect;
    }
}
  • これを先に作成したCameraにアタッチします
  • Hierarchyウィンドウで Ocean をクリックして選択して、LayerをWaterにします

これで水面下を描画するカメラと、水面のレイヤー設定ができました。スクリプトでは、Main Cameraの設定をCopyFromでコピーしたり、Waterレイヤーを描画候補から外すためのcullingMaskの設定などをしています。描画するテクスチャは_WaterDepthTexという名前で、シェーダーにGlobalTextureで渡します。

警告やエラーが出る場合

RenderTexture.Create: Depth|ShadowMap RenderTexture requested without a depth buffer. Changing to a 16 bit depth buffer.というような警告が表示されて、grabがどうこうというエラーが出る場合があります。その時は、81行目のDepthをDefaultに変更してみてください。

// 81:
            RenderTextureFormat.Default,

これで一旦エラーが消えるので、作業を完了させてください。作業が完了したらDepthに戻します。それでとりあえず動きました。このエラーは水系の色々なアセットで発生しているようですが、今回は直す決め手を見つけることはできませんでした。

WaterShadedの改造

仕上げにLowPoly WaterのWaterShadedシェーダーに手を加えます。やることは以下の通りです。

  1. 水面下の距離を_WaterDepthTexから取得するようにします
  2. Render Queueを、不透明でFadeやUnlitより前に描画するように変更します(AlphaTest-1)
  3. 水面描画時にZWriteをOnにします。これをしないと水面が描画されません
  4. Shadow Casterパスを追加します。これでDOFを有効にします

ProjetウィンドウのAssets > LowPolyWater_Pack > Shaders フォルダーを開いて、WaterShadedシェーダーをダブルクリックして開きます。以下に従って修正してください。

  • 26行目付近の_CameraDepthTexture_WaterDepthTexに書き換えます
  • 159行目のhalf depth=から始まる行にある_CameraDepthTexture_WaterDepthTexに書き換えます
// 159:
            half depth = SAMPLE_DEPTH_TEXTURE_PROJ(_WaterDepthTex, UNITY_PROJ_COORD(i.screenPos));

これでMain CameraのZバッファではなく、こちらで作成した_WaterDepthTexから奥行きを取り出すようになります。カメラのaspectを正しく設定しておけば、正方形のRenderTextureからちゃんとアスペクト比に従って参照してくれます。

次にRender Queueを変更します。

  • 183行目付近のTagsを以下のように修正します
// 183:
    Tags {"RenderType"="Transparent" "Queue"="AlphaTest-1"}

水面描画時のZWriteをOnにします。

// 193:
            ZWrite On

207行目の}の後ろで改行して、以下のShadowCasterのパスを追加します。

// 208:

    Pass{
            Tags { "LightMode" = "ShadowCaster"}
            ZWrite On
            ColorMask 0
    }

以上で完了です。Playすると水面がくっきり表示されるようになります。

f:id:am1tanaka:20220218013252p:plain
水面くっきり!

この時、島の下が真っ白になっている場合は、CameraにアタッチしたスクリプトDepthのところをDefaultに変更したのではないかと思います。元のDepthに戻してみてください。

Unlitが白くなるのを解消する

右のCubeの下半分が真っ白です。これはCubeのZバッファに水面シェーダーが反応して波を描いてしまうからです。水面と同じくこのCubeのレイヤーをWaterにすることでぱっと見では解決です。

f:id:am1tanaka:20220218014748p:plain
Waterで問題を回避

よくよく見るとCubeの場所だけ水面がくっきり見えています。DOFがCubeの距離で反映するからですが、これ以上は別テーマになりそうなので今回はここまでにしておきます。

まとめ

ちょっと見栄えを良くしようと思って入れたDepth of Fieldが思わぬ問題を巻き起こしました。理屈を知ってみると、DOFと透過物との相性の悪さ、特に水面はなかなかに難儀な対応が必要ということが実感できました。これらを対策済みの水や透明系アセットの有難さが分かりました。

この調査を通じて、以下のようなことを知ることができました。

  • Render Queueは2500以下が不透明、それ以降が透明扱いになり、描画ルールが変わる
  • ZバッファはRender Queueが2500以下、ZWrite On、Shadow Casterのパスでハードウェアに書き込まれる
  • 不透明のキューでもBlend設定で半透明の描画はできる
  • ShadowCasterでZバッファを書き込む場合は、他のパスもZWrite Onにしないと描画されなかった(水面)
  • エフェクト用のカメラでRenderTextureに欲しい画像を書き込んで、Shader.SetGlobalTexture()でシェーダーに渡せる
  • カメラのaspectを設定すれば、正方形のRenderTextureからスクリーン座標で色を取り出せる
  • RenderTextureを作成する時に謎の警告とエラーがでたら、とりあえずRenderTextureFormat.Defaultで作成しておく

今回の作業では、公式ドキュメントに加えてLIGHT11さんのブログに大変お世話になりました。助かりました。

Win, Mac, WebGL, Android(Pixel3a)では動作確認しました。Pixel3aだとかなり重い感じでしたが動いてはいました。

memo:シェーダーのRender Typeについて

Render Typeは特殊なエフェクトなどのためにシェーダーを置き換えたい時に、置き換える候補を指定するのに使うとのこと。

docs.unity3d.com

Zバッファのみとか不透明なQueueで半透明にしてたりとかイレギュラーなことをしていて何を設定するのが正解か分からなかったので、今回はなんとなくで設定しています。何かのエフェクトが正しく描画されない場合はこの辺りが原因かも知れません。

参考/関連URL

Unity Adsの初期化がネット未接続時に失敗した時の対策

デジゲー博で展示する際に、Voxelorer BirdのUndoが回復されない症状が発生しました。会場では自動的にネットに接続されないため、広告やUndo回復を取得するためのサーバーアクセスに失敗していたのが原因と気付いて手元のスマホテザリングしてみましたが、広告を見れるようにするにはアプリの再起動が必要でした。ネットに接続すればアプリを再起動しなくても広告を見れるようにする方法を調査したところ、現行のUnity Adsの動作で分かりづらいところが見つかったのでまとめておきます。

  • 2021/12/27 「さらなる不具合」を追記

確認した環境

  • Unity2020.3.9f1
  • Unity Ads 3.7.5と4.0.0

Unity Adsの初期化失敗時の仕様と問題点

Unity Adsを利用する際には、Initialize()を一度呼び出しておきます。呼び出し時にインターネットに接続されていなかった場合、その場では初期化は失敗しますが、ネットに接続されたら自動的に初期化が実行される仕様になっています。

この仕様はUnity2020.3.9f1のエディター上では動かないようで、初期化に失敗するとアプリを再起動する必要がありました。念のため、AndroidiOSで試したところ、実機ではちゃんと仕様通りに再初期化することが分かりました。

Unity Ads 3.7.5ではもう一つ問題があって、初期化が失敗した後に再初期化が成功した際にOnInitializationComplete()が呼ばれません。そのため、このコールバックを受け取る前提で作成していたVoxelore Birdはアプリの再起動が必要になったのでした。4.0.0では修正されています。

広告の初期化はLoad()を使う

Unity Ads3.x.xでは、IsReady()で広告を表示する準備できたかどうかを確認できたのですが、4.0.0ではこのメソッドが廃止されてしまいました。Load()を手動で呼び出して、コールバックで読み込み成功を確認することになったようです。

docs.unity.com

さらなる不具合

4.0.0では、広告の初期化時にネットに接続できない状態でアプリを一時停止させてしまうと、アプリの再開後にネットに接続しても初期化は実行されず、Inittialize()を呼び出してもOnInitializationFailed()が呼ばれて失敗するようです。

また、広告の読み込み成功後にネットから切断してShow()を呼ぶと、OnUnityAdsShowFailure()が呼ばれて失敗します。

まとめ

まとめると以下のような感じです。

  • Advertisement.Initialize()は起動時に一度呼び出せばよい
  • UnityAds3.7.5では、OnInitializationComplete()が呼ばれない可能性があるので、IsReady()で完了を確認してからShow()を実行
  • UnityAds4.0.0では、Load()で必要な広告種類を手動で読み込み、OnUnityAdsAdLoaded()が呼ばれたことを確認してからShow()を実行

UnityAdsのマニュアルの手順に従って実装しておけば問題は回避できるということですね。Unityエディター上では再初期化がされない可能性があるので、正常に動いていないようでも実機で試すのをお忘れなく。

追記

マニュアルは勿論読んでたはずなのでおかしい・・・とこの記事を書きながら思っていたのですが、最後にマニュアルの更新日を見て納得しました。更新されたのはこの記事を書いた前日の12/17でした^^; Unity Adsの調査をしたのは数日前なので、その頃にはないドキュメントだったのですね。

参考URL

ゆるく使うUnityTest

Qiita Advent Calender 2021 Unity カレンダー1の8日目の記事です。

前の日は @neusstudio さんの 【Unity】Vivox でボイスチャットを始めよう! - Qiita です!

次の日は @nkjzm さんの【Unity】テスト対象のプレハブを名前で検索するUtilityメソッド - Qiita です!

この記事は、Unityに標準で用意されているテストフレームワークを使ったことがない人や、使ってみたけど今一つ使いどころが分からなかった人向けに、既存のプロジェクトに手軽にテストを導入する例をご紹介します。

f:id:am1tanaka:20211203152122p:plain

目次

ブログの動作環境

  • Unity 2020.3.9f1
  • Creator Kit - Puzzle 1.0

Unity Test Frameworkとは

Unityには、.NETプラットフォーム向けのテストフレームワークである NUnit を元にした Unity Test Framework がデフォルトで用意されています(以降、UnityTestと書きます)。以下、公式マニュアルです。

nunit.org

docs.unity3d.com

ソフトウェアのテストについてはあちこちで述べられているので詳細は割愛しますが、関数やクラス、システムが予想通りに動くかどうかを自動的に確認するためのものです。テストのために引数と結果の組み合わせを検討することで実装内容が明確化できることや、手動でテストする手間の削減、実装後のリファクタリングによるエンバグの発見など、テストの導入には多くのメリットがあります。プログラミングにある程度慣れてきた段階で、軽くでもよいので一度試してみると発見があって面白いと思います。

ゆるく使うとは

テストというとTDD(テスト・ドリブン・デベロップメント)などを語りたくなりますが、既存のプロジェクトでも導入するメリットはあります。このブログでは、Unity Hub2.4.5の「使い方を学ぶ」にあるCreator Kit: Puzzleに用意されているサンプルステージのレベル1を自動操作して、星3つを獲得したかを確認するテストを作ってみます。すぐに享受できるメリットからはじめて、徐々にテストへの理解を深めていくのもよいだろうと思います。

Creator Kit: Puzzleをテストする

プロジェクトの読み込みからテストの作成までの手順です。

対象プロジェクトを開く

  • Unity Hubを起動して、使い方を学ぶからCreator Kit: Puzzleを選択します

f:id:am1tanaka:20211203113922p:plain
チュートリアルを開く

  • はじめての時は、プロジェクトをダウンロード をクリックします
  • ダウンロードが完了したら、 プロジェクトを開く をクリックします
  • Projectウィンドウから Creator Kit - Puzzle > Scenes > ExampleScenes を開いて Level01 シーンをダブルクリックすると、以下のシーンが開きます

f:id:am1tanaka:20211203152122p:plain
Level01

Playして遊んでみてください。スペースキーで仕掛けを動かして、ゴールに玉を転がしたらクリアです。

テスト内容

作成するテストは以下のような流れにします。

  • Level01を読み込む
  • 開始時に星の獲得数を0に設定
  • 適当な秒数が経過するまで、ゴール待機のループ
    • ゴールしたら星が3つ獲得できたか確認して、ループ終了
    • ボールが一定の位置を通過したら仕掛けを作動
  • ループが終了してゴールしていなければ失敗

テストスクリプトの作成

UnityTestで最初にやることは、テスト用のフォルダーを作成することです。

  • ProjectウィンドウでTestsフォルダーを作成したいフォルダー(Assetsなど)を右クリックして、Create > Testing > Tests Assembly Folder を選択します。フォルダー名はTestsのままでよいかと思います

f:id:am1tanaka:20211203121503p:plain
Testフォルダーの作成

この手順はプロジェクトで1回だけでOKです。あとは必要に応じてテストスクリプトを作成します。

  • 作成した Tests フォルダーを右クリックして、 Create > Testing > C# Test Script を選択して、Level01Testsなどの名前でスクリプトを作成します

f:id:am1tanaka:20211203121725p:plain
テストスクリプトの作成

作成したスクリプトから不要な行を削除したりして整理します。単体テスト用のメソッドの前には[Test]、コルーチンで複合的なテストを行うメソッドには[UnityTest]を書きます。今回は単体テストはしないので[Test]は不要です。コメントも消して以下のようにすっきりさせておきます。

using System.Collections;
using System.Collections.Generic;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;

public class Level01Tests
{
    [UnityTest]
    public IEnumerator Level01TestsWithEnumeratorPasses()
    {
        yield return null;
    }
}

以上で上書き保存します。

テストの実行

テストコードは何も書いてませんがテストを実行してみましょう。Unityに切り替えて、以下を操作してください。

  • Windowメニューから General > Test Runner を選んで、テストランナーウィンドウを起動します

f:id:am1tanaka:20211203125825p:plain
テストランナーの起動

  • PlayMode をクリックします

f:id:am1tanaka:20211203130000p:plain
PlayModeに切り替え

  • 先ほど作成したテスト Level01TestsWithEnumeratorPasses をクリックして選択したら、Run Selected をクリックしてテストを実行します

f:id:am1tanaka:20211203130100p:plain
特定のテストを実行

以上でテストランナーが起動します。まだ何もテストコードを書いていないので成功して終了します。

f:id:am1tanaka:20211203130232p:plain
起動成功

テストのためのAssembly Definitionファイルの作成

UnityTestの面倒ポイントの一つが、テストスクリプトからプロジェクトのスクリプトを参照するための Assembly Definitionファイルを作る必要があることです。ある程度の段階までは触らない機能なので、知らない場合はとにかく以下の操作をして必要なファイルを作成してください。

  • Assets/Creator Kit - Puzzle Scripts フォルダーを右クックして、Create > Assembly Definition を選択します

f:id:am1tanaka:20211203134445p:plain
Assembly Definitionの作成

  • 作成されたアセットの名前をCKPuzzle などにします
  • Inspectorウィンドウの Assembly Definition References欄の List is Empty の右下の + をクリックします
  • 追加される欄の None の右の二重丸をクリックして、Unity TextMeshProを選択します
  • 同様に、com.unity.cinemachine と Unity.Postprocessing.Runtime を追加します
  • 下の方の Apply ボタンを押します

スクリプトから参照しているものが他にもある場合は、都度、同様の操作で追加する必要があります。

  • 先ほど作成した Tests フォルダー内の Testsファイル をクリックして選択します
  • Inspectorウィンドウの Assembly Definition References欄に、先ほどと同様の手順で CKPuzzle への参照を追加します
  • 下の方の Apply ボタンを押します

以上でテストランナーからプロジェクトのスクリプトを参照できるようになります。

シーンの切り替えとタイムアウト

テストコードの作成開始です。まずは「Level01を読み込んで」「指定秒数待って」「終了時に指定秒数の経過状態をテスト」してみましょう。

先ほどのLevel01Testsスクリプトを以下のようにします。

  • 冒頭に以下のusingを追加します
// 6:
using UnityEngine.SceneManagement;
  • テストメソッドを以下のように実装します
// 10:
    [UnityTest]
    public IEnumerator Level01TestsWithEnumeratorPasses()
    {
        float timeOut = 10;

        SceneManager.LoadScene("Level01");
        yield return null;
        var timing = GameObject.FindObjectOfType<TimingRecording>();
        while (timing.timer < timeOut)
        {
            yield return null;
        }

        Assert.That(timing.timer, Is.LessThan(timeOut), "クリアしたか");
    }

以上できたら上書き保存してテストランナーを実行してください。操作せずに放っておくと、10秒経過したらテストが失敗して実行が停止します。

テストを開始するとInitTestScene?????という感じの名前のテスト用のシーンが起動します。このシーン上にテストに必要なオブジェクトをInstantiateで配置する想定なのですが、今回のようにステージが必要なテストをコードで用意するのは面倒です。15行目のようにLoadScene()でシーンを読み込めば手軽にテストを始められます。

16行目:シーンを読み込んだら yield return null; で1フレーム待って、シーンを初期化させてます。

17行目:経過時間はTimingRecordingスクリプトtimerで確認できます。この辺がpublicなのは助かります(アクセサなどで読み出し専用にしてたらなお良し)。必要なインスタンスはテストコードなので多少効率が悪くても問題ないだろうということで FindObjectOfType<>() で強引に取得しました。

18行目:timeOutに設定した秒数が経過するまで待つwhile()には、後ほどパドル操作とクリアチェックのコードを追加します。

23行目:最後にAssertで経過秒数がtimeOutの時間以内であることを確認します。今は時間が経過するまでwhileループを抜けないので必ずテストは失敗します。

f:id:am1tanaka:20211203140921p:plain
最初のテスト失敗

状態をテストするのはAssert.That()というNUnitが提供するstaticメソッドを使います。最初に検証したいデータが入っている変数、2番目に予想する結果、3番目に失敗時に表示するコメントを書きます。2番目の引数には色々なものが用意されています。詳しくはこの辺りこの辺りを参照してください。

仕掛けを動かす

テストから仕掛けを動かせるようにするために、元のコードに少し手を加える必要があります。Projectウィンドウから Assets > Creator Kit - Puzzle > Scripts > InteractivePuzzlePieces フォルダーを開いて InteractivePuzzlePiece スクリプトをエディターで開きます。24行目あたりに仕掛けを動かすためのコードがありますが、Inputが直書きされているのでテストから操作できません。ちょこっと手を加えます。

  • InteractivePuzzlePieceクラスに以下のstatic変数を追加します
// 22:
    public static bool interactKeyState;
  • FixedUpdate()のif文に以下のように条件を追加します
// 24:
    protected void FixedUpdate ()
    {
        if ((Input.GetKey (interactKey) || interactKeyState) && m_IsControlable)
        {
            ApplyActiveState ();
        }
        else
        {
            ApplyInactiveState ();
        }
    }

これでBaseInteractivePuzzlePiece.interactKeyStatetrueを代入すれば仕掛けが動き、falseなら解除します。

本来は、入力を管理するクラスを作成して入力を取りまとめた方がいいのですが、本論から外れるので今回はお手軽な手法にしました。

テストを以下のように変更します。

// 10:
    [UnityTest]
    public IEnumerator Level01TestsWithEnumeratorPasses()
    {
        float timeOut = 10;
        float activateX = -1.5f;

        SceneManager.LoadScene("Level01");
        yield return null;

        var marble = GameObject.Find("Marble");
        var timing = GameObject.FindObjectOfType<TimingRecording>();
        while (timing.timer < timeOut)
        {
            yield return null;
            if (marble.transform.position.x > activateX)
            {
                BaseInteractivePuzzlePiece.interactKeyState = true;
            }
        }

        Assert.That(timing.timer, Is.LessThan(timeOut), "クリアしたか");
    }

上書きしてテストを実行したら操作せずに眺めていてください。玉がactivateXを越えたら仕掛けが自動的に動いてクリアします。まだクリア判定をしていないのでテストは終わりません。UnityのPlayボタンを押して手動で停止してください。

クリアと結果の判定

クリアと獲得した星の数の確認を追加します。どちらもSceneCompletionスクリプトで確認できます。必要なパラメーターはpublicで宣言されているのでそのまま利用できます。

以下のようにテストスクリプトにコードを追加します。

// 10:
    [UnityTest]
    public IEnumerator Level01TestsWithEnumeratorPasses()
    {
        float timeOut = 10;
        float activateX = -1.5f;

        SceneManager.LoadScene("Level01");
        yield return null;

        var comp = GameObject.FindObjectOfType<SceneCompletion>();
        comp.sceneReference.earnedStars = 0;

        var marble = GameObject.Find("Marble");
        var timing = GameObject.FindObjectOfType<TimingRecording>();
        while (timing.timer < timeOut)
        {
            yield return null;
            if (marble.transform.position.x > activateX)
            {
                BaseInteractivePuzzlePiece.interactKeyState = true;
            }

            if (comp.panel.activeSelf)
            {
                Assert.That(comp.sceneReference.earnedStars, Is.EqualTo(3), "星3つ");
                break;
            }
        }

        Assert.That(timing.timer, Is.LessThan(timeOut), "クリアしたか");
    }

追加したのは以下の行です。

  • 19行目付近
        var comp = GameObject.FindObjectOfType<SceneCompletion>();
        comp.sceneReference.earnedStars = 0;
  • 32行目付近
            if (comp.panel.activeSelf)
            {
                Assert.That(comp.sceneReference.earnedStars, Is.EqualTo(3), "星3つ");
                break;
            }

上書き保存をしてテストを実行したら操作せずに見ていてください。クリアしたのち、結果が表示されるタイミングでテストが失敗します。

f:id:am1tanaka:20211203151004p:plain
星が足りなかった

Expected: 3
But was: 0

上記は、獲得した星の数が「3を予想したが結果は0だった」ということで動作結果と一致します。これでテストコード完成です!

仕上げ

テストコードの14行目付近のfloat activateX = -1.5f;の値を変えれば、仕掛けが動く場所を調整できます。星3つ獲得できたらテストが成功するので、良さそうな値を探してみてください。数当てみたいでこれはこれで楽しめると思います。

これは本来の使い方ではありませんが、自動テストで同じ状況を繰り返し再現できることで、バグを探したり、コード変更の影響を確認するのが楽になりそうなことを実感いただければ幸いです。

また、テストコードの15行目付近に以下のコードを追加してみてください。

// 15:
        Time.timeScale = 4;

テストを4倍速で実行できます。これもテストの便利なところです。ただし、あまり速くしすぎると物理演算の誤差で結果が不正確になるので倍率はほどほどに。

得られた知見

今回のようなテストをする場合に重要になるのが以下の2点です。

  • 操作を外部からできるようにする
  • 状態を外部から把握しやすくする

何かを操作するコードに直接Inputを書き込むと今回のようにテストがしにくくなります。オブジェクトを制御するクラスと、入力値を読み取ってアクションに変換するクラスは分けた方がテストがしやすくなります。テストがしやすくなるだけではなく、カットシーンでプレイヤーを自動制御したり、リプレイ機能を付けることも簡単にできるようになるオマケが付いてきます。

ユーザー操作を想定したテストをする場合、人間が無意識にやっている操作できるようになるまで待つというのをテストコードで実装する必要があります。状態を外部から把握しやすくすることで、操作したい状況になるまでの待機が簡単に実装できるようになります。このことは、例えば会話中はプレイヤーの操作を停止させたい、とか、メニューを表示するアニメ中は操作を停止したい、というような仕組み作りに役立ちます。最初からこのような設計で作っておけばゲーム中の面倒な処理が簡単に実装できます。

テストを前提にしたシステムを考えることと、設計について学ぶことは近い関係にあります。ゆるい使い方に慣れてきたら、改めてテストや設計について学んでみてください。

実用例

現在開発中のVoxelorer BirdでもUnityTestを利用しています。

f:id:am1tanaka:20211206232753p:plain
VoxelorerBirdのテスト一覧

個人制作のそれほど大きなプロジェクトではないので必要と感じた以下のようなもののみ用意しています。

  • 保存データの確認
    • テスト用のファイルにすることで、自由に保存状態を変えてテストできます
  • 発話やメニュー、操作の排他処理確認
    • 確認のための手順が多いので、テストで自動操作させることで大幅に省力化できました
  • 起動からステージクリア、ステージ選択の流れの確認
    • 機能追加や変更をすると不測の不具合が出る可能性があるので、時々、ゲームを一通り操作してみるのが肝要です。手動でやるのは億劫なので、これこそ自動テストの出番です
  • Undoやシナリオキューの開発
    • 動きがややこしい処理はTDDの出番です。予想外の不具合がいくつも見つかったので大いに助かりました

f:id:am1tanaka:20211207004145g:plain
100回クリアテスト

こんな感じで普通にアプリを起動してステージを読み込んで、じゃかじゃかボタンやプレイヤーの操作をテストランナーに実行させて不具合がないかも確認できます。これで見つけた予想外の不具合が結構あるのでテストの恩恵を実感しています。

最後に

UnityTestは最初から用意されているので、Assembly Definitionファイルの作成さえなんとかなれば導入ハードルはそれほど高くありません。今回紹介したPlayモードのテストは、コルーチンに馴染んでいれば感覚的に利用できると思います。

記事の中で入力のコードを変更しましたが、「テストをしやすいコードにするにはどうしたらよいか」を考えるのは、良い設計への道しるべです。テストの雰囲気が掴めたら、本来のテスト手法や手順も学んでみてください。とっかかりとして、新しい挑戦をしたい時に見る本 Vol3 - まんてらスタジオ - BOOTHの第6章、murnanaさん執筆の「Unityとテスト駆動開発で作る〇×ゲーム」がオススメです。

booth.pm

以上、Qiita Advent Calender 2021 Unity カレンダー1の8日目の記事でした。

前の日は @neusstudio さんの 【Unity】Vivox でボイスチャットを始めよう! - Qiita です!

次の日は @nkjzm さんの【Unity】テスト対象のプレハブを名前で検索するUtilityメソッド - Qiita です!

参考URL

デジゲー博2021出展してきました!

恒例となってきましたデジゲー博、今年も出展してきました。

f:id:am1tanaka:20211114104834j:plain

最初に出展したのが2018年だったので気が付けば4回目。ついにスマホ版のオープンテスト版を配信できるところまで辿り着きました!忘れないうちにざっくり書いておきます。

目次

今回の目的

4回目にしてようやくスマホのオープンテスト版をお届けできる準備が整いまして、今回の最大の目的はオープンテスト版のダウンロードURLのQRコードを印刷したカードを配布することでした。

その他、難易度や操作性の確認、バグの発見、設営と撤収の練習、ルキグラ自慢などなど、展示をすることで開発しているだけでは入手できない貴重な経験を得ることができるので、本当にデジゲー博さんにはありがたい機会を提供していただいています。

展示の様子

ブースはこんな感じになりました。

去年はスマホの操作データをPCに送って初代ルキグラで表示ということをしていて、実装に時間がかかった割には遅延がすごくて微妙なデモ状態でした。今年はLooking Glass Portraitが届いたのですが、対応に割ける時間があまり残っていなかったため、何かないかと考えた結果、マウスを台においてPCで普通に操作してもらえばいいんじゃん、ということに気づきそれで実装。結果、実装は楽だったし、去年よりちゃんと遊べる状態で展示できました。

毎度のことですが、ルキグラ目当てで足を止めて下さったお客さんにVoxelorer Birdを遊んでいただいて、ゲームも面白いじゃん、となればいいなというような感じで、今年もルキグラは頼りになりました。Portraitはレイアウトがスマホのをそのまま使えるので素晴らしいです。

ルキグラの公式サイトは以下です。ご興味がありましたら。

lookingglassfactory.com

配布したカード

こんな感じのカードをA4に10枚並べて、自分でカットして配布しました。

f:id:am1tanaka:20211114211529p:plain
オープンテストご招待カード

300dpiでカード1枚の縦横のドット数を計算して、Unity Recorderでそのサイズで出力。1枚分の画像ができたら、GIMPで左右に2枚並べてから、縦に5行並べて、あとはA4のドット数にキャンバスを拡大すれば原稿のできあがり。

印刷はファミマのネットプリントを利用しました。ネットプリント光沢紙、ネットプリント普通紙、カラーコピー光沢紙の3パターンを試してみたところ、今回のデザインだとグラデーションや細かい部分の発色が光沢紙より普通紙の方が良くて、ネットプリント普通紙で印刷しました。カラーコピーの方がネットプリントより安いのですが、今回のようなグラデーションや淡い色だとスキャンしきれず、あまり奇麗に印刷できませんでした。普通紙ならネットプリントでも1枚60円だったのでまあそのぐらいはいいかということで全部ネットプリントで出力しました。

印刷できたら、大昔に出席カードを作るためにゲットしていた裁断機で裁断。

f:id:am1tanaka:20211112185746j:plain
裁断

最初に上か下をカットしてから、縦方向に短冊状にカットして、短冊状にしたやつを3~4枚ほど並べてまとめてカット、という感じでやるとスパスパできあがりました。

試しに印刷した20枚と、ネットプリントの普通紙のカード60枚の合計で80枚を持っていき、61枚配布できました!ニアピン賞です。受け取って下さった皆様、ありがとうございました!

今回のオープンテストは、一旦、会場で配布した分で様子見をします。その間に、展示で見つかった不具合を解消したり改良を加えて、機が熟しました公開しようと考えています。

今回の展示で気付いたこと

プレイの様子を見ながら、あるいは、ご意見を伺って、以下のようなことが確認できました。

  • 通信がないところだと広告APIの初期化がコケて様々な不具合を巻き起こした
    • 手元のスマホテザリングして緊急回避
    • 展示モード時は、Adsの初期化を回避する処理が必要
    • 初回の初期化に失敗すると再起動しないと正常に動作しなくなる作りだったので、失敗したら初期化からやり直すようにする必要あり
  • ブロックが落ち切らずに吹き飛ぶことがある
    • 移動はRigidbodyを使わないようにした方がよさげ
  • プレイヤーキャラクターが空中に浮くことがあった
    • ブロックの不具合と同じ原因と思われる。独自移動に変更することで解消できそう
  • メッセージ表示中だとUndoボタンが押しにくい
    • メッセージ表示中でもUndoボタンを有効にする
  • iPadのカバーが画面に微妙に触れているようで、メッセージがどんどん飛んでしまうことがあった
    • 画面端は当たり判定を無くす
  • Undoの確定ボタンが気付きにくい
    • Undoの確定とキャンセルは不要かも。戻したい場面になったら画面をタップすればそこで確定でいいような気がする
  • Undo放題の時間はもう少し長くて良い

いただいたアイディア

  • 広告を見るとコスチュームが入手できたり、別のトリにできたり
    • ハクの物語で考えていたけど、トリごとに洞窟にやってくる目的が変わるといいかも?大変か?

来年に向けて

来年のデジゲー博こそは、正規版のダウンロードURLを大々的に公開したい、ということで、Voxelorer Bird の開発を継続するのが野望です。もう一つ。チームでこういう感じの作ろうか、という話が出ていて、その試遊版が展示できたらいいなということを考えてます。

そして、去年はそこそこ成功した設営と撤収でしたが、今年は荷造りに頭が回ってなくて撤収に手間取り、2Fで最後に片付いたぐらいの遅延ぶりでした。設営機材がほぼ揃って安心して、小物とかをどこに入れるかを考えずに袋に放り込んでいったのが敗因でした。ハンズとかビックカメラの袋ではなく、どこに何を入れるかが決まっている展示用収納を構築するのも来年度の密かな野望です。

最後に

試遊をして貴重なご意見やバグを見つけてくださったり、オープンテストカードを受け取ってくださった皆様、ありがとうございました。

差し入れなども本当にありがとうございました。疲れが癒えます。毎度のことですが、なかなかブースから離れられず、全然遊び返しに行けていなくて恐縮です。なるべくTwitterとかで情報を追って遊びたいと思ってます。

デジゲー博はなぜだか肌に合い、あまり展示などをしない自分にとって貴重な場です。運営の皆様、主催や共催の皆様、ありがとうございました。今後も末永く続きますよう及ばずながら応援してまいります。

Scroll Viewのメモ

スクロールビュー(Scroll View)の設定方法をいつもすぐ忘れるので備忘録。

目次

対象バージョン

この記事は Unity 2020.3.9f1 を元にしています。

Scroll Viewの構成

デフォルトのScroll Viewは以下のような構成です。

f:id:am1tanaka:20210805174832p:plain
Scroll Viewの構成

  • Scroll View
    • 表示する範囲やスクロールの動作設定などをするオブジェクト
  • Viewport
    • スクロールビューの外を消すマスク処理をするためのオブジェクト
  • Content
    • スクロールする対象のUIオブジェクトを配置するためのオブジェクト。スクロールできる範囲や、最初に表示される位置をこのオブジェクトで設定します
  • Scrollbar Horizontal / Scrollbar Vertical
    • スクロールバーのオブジェクト。不要ならScroll Viewの設定を消した上で、このオブジェクトを消してもよい

表示範囲

(1)と(2)の表示範囲は、Scroll ViewのWidthとHeightなどのRect Transformで設定します。AnchorのMinとMaxを01にして、画面いっぱいに広げるような設定をしても問題なく動きます。

f:id:am1tanaka:20210805170130p:plain
表示範囲とスクロールバー

スクロールバーを消す

スマホ用などでスクロールバーがいらない場合は、Inspectorウィンドウの(3)と(4)の欄を削除してNoneにして、Scrollbar Horizontal と Scrollbar Vertical を削除します。

スクロールバーを使わない場合、スクロールするかどうかに応じたViewportのサイズ調整が動作しないようで、そのままだとスクロールバーの場所が空いてしまいます。ViewportのRect TransformのRightは0にするのがよさそうです。

コンテンツの配置

f:id:am1tanaka:20210805173446p:plain
コンテンツの配置

コンテンツを配置する先

表示するコンテンツは Content オブジェクトの子供にします。

スクロールできる範囲

Contents オブジェクトの幅や高さがスクロールできる範囲になります。図では、Scroll Viewの高さが900、Contentsの高さが2000なので、表示範囲が900で、画面外に1100スクロールできます。

最初に表示される場所

Contents の Pos X や Pos Y に設定した状態で始まります。図では、Anchorが上端でPos Yが0なので、上端が表示された状態で始まります。

プログラムでコンテンツを追加する場合などは、Anchorをうまく設定しておくと計算が楽になる場合があります。例えば中央から表示したい場合なら、AnchorのMinとMaxを0.5にして、Pos Yを0にしておけば、自動的に中央から表示できます。

参考URL

Voxel ImporterでMagicaVoxelのボクセルを読み込んで透過させたり光らせたり

f:id:am1tanaka:20210801001016p:plain
光る砂時計

この記事は Unity アセット真夏のアドベントカレンダー 2021 Summer! – Unity公式 Asset Portal の4日目の記事です。

assetstore.info

▲前の日は さとや さんの「単独でも活用できる!Corgi Engine/TopDown Engineに同梱されているMMFeedbacksの紹介」でした。

▼次の日は kido さんの「History Inspector の紹介」です。

この記事では、ボクセルのモデルを簡単に読み込んだり、ボーン設定ができる定番アセット Voxel Importer を利用して、透過や自己発光するボクセルモデルを手軽に作成する方法をご紹介します!!

assetstore.unity.com

モデリングにはMagicaVoxelを利用します。

ephtracy.github.io

目次

記事の環境

以下の環境で作成しました。

  • Windows10
  • Unity2020.3.9f1
  • Voxel Importer 1.2.2
  • MagicaVoxel 0.99.6.2

MagicaVoxelでモデルを作成する

光る砂時計を作ってみます。今回のミソは素材ごとに違うマテリアルが割り当てることです。そのためにMagicaVoxelのRenderモードで色に素材の設定をします。また、今回のような多層構造を作るのに便利なレイヤーとオブジェクトの使い方も簡単にご紹介します。

MagicaVoxelの使い方は以下の書籍がとても参考になります。これまで使ってなかったあれこれの機能が使えるようになりました^^

モデリング

素材は以下の3種類にします。

  • 上下の木の枠のボクセル
  • 透過するガラスのボクセル
  • 光らせる砂のボクセル

上下の枠

必要に応じてサイズを設定します。今回は15 15 15で作成しました。

f:id:am1tanaka:20210801130851p:plain
オブジェクトのサイズ設定

  1. index:96のパレットを選びます
  2. EditパネルのSHAPE欄からCyliをクリックして円柱を作ります
  3. Eraseモードにします
  4. Faceモードにします
  5. 高さが2になるまで削除します

f:id:am1tanaka:20210801131132p:plain
下の枠の作成

EditパネルのMIRROR欄のZをクリックして、作成したのと同じ形を上にも作ります。

f:id:am1tanaka:20210801131313p:plain
上の枠

BrushパネルのMirrorモードのX, Y, Z全てONにして、角取りをしたら枠は出来上がり。

f:id:am1tanaka:20210801132847g:plain
枠の角取り

砂とガラスの部分は二重構造になっています。先に内側の砂で形を作ってから、ガラスのボクセルで砂を覆えば良さそうです。

砂のパレットはindex:184の緑でこんな形にしました。

f:id:am1tanaka:20210801140202g:plain
砂の作成

f:id:am1tanaka:20210801140423p:plain
枠と砂

ガラス

砂を覆うようにindex:73のパレットでガラスのボクセルを置きます。

f:id:am1tanaka:20210801141848g:plain
ガラスで覆う

f:id:am1tanaka:20210801191120p:plain
覆った

マテリアルを設定

マテリアルを分けるために色のMatter設定をします。まずは以下の通りガラスの設定をします。

  1. Renderモードに切り替えます
  2. ガラスのパレットであるindex:73を選択します
  3. MatterパネルのMATERIAL欄からGlassを選択します
  4. 適当にパラメーターを設定します

f:id:am1tanaka:20210801180019p:plain
ガラスの素材設定

砂の設定をします。

  1. 砂のパレットであるindex:184を選択します
  2. MatterパネルのMATERIAL欄からEmitを選択します
  3. 適当にパラメーターを設定します

f:id:am1tanaka:20210801180326p:plain
砂の素材設定

以上で素材の設定が完了です。枠、砂、ガラスに異なる設定をしたので、別のマテリアルが割り当てられます。

オブジェクトとレイヤー

雰囲気は良い感じになりましたが、砂が上から下まで詰まっていて砂時計に見えません。Unityに持って行く前にちょっと砂を減らします。

砂の調整はガラスや枠のボクセルをずらせばできますが面倒です。そこで砂を別レイヤーにします。この辺の操作がMagicaVoxelは独特で、理解するのに苦戦したので本筋とは違いますが備忘録として。

  1. Modelモードに切り替えます
  2. 右上の上三角形のアイコンをクリックしてワールドモードに切り替えます

f:id:am1tanaka:20210801180658p:plain
ワールドモードへ]

何もない場所をクリックすると、砂時計の大きさの立方体のワイヤーの色がレイヤーの色になります。砂時計がレイヤー0にあるオブジェクトだということを表しています。

f:id:am1tanaka:20210801180755p:plain
レイヤーを表す色

起動時にいじっているのはレイヤー0にある1つのオブジェクトということになります。MagicaVoxelでは1つのファイルにこのようなオブジェクトを複数持たせることができます。オブジェクトは新しく追加したり、コピーして複製したり、丸ごと移動したり、他のvoxファイルからImportして読み込むことができます。

オブジェクトの複製

現在のレイヤー0のオブジェクトを、レイヤー1に複製します。

  1. 砂時計をクリックして選択します
  2. EditパネルのSELECT欄からCopyをクリックします
  3. Pasteをクリックします

f:id:am1tanaka:20210801181351p:plain
オブジェクトを複製

見た目には分かりませんが、これで砂時計は2つに増えています。赤の矢印をドラッグして移動させると、2つの砂時計が確認できます

f:id:am1tanaka:20210801181539p:plain
コピーした砂時計を移動

レイヤーの設定

編集しやすくするためにレイヤーを分けます。BrushパネルのLAYER欄から、赤い丸の右の1と書いてある欄のさらに右の小さな四角の部分をクリックします。< が1の行に移動します。

f:id:am1tanaka:20210801181710p:plain
レイヤーの設定

これで選択していたオブジェクトがレイヤー1に移動しました。よくあるツールだと「レイヤーを指定してオブジェクトを作成」という感じですが、MagicaVoxelでは「オブジェクトを作成してから別のレイヤーへ移動」という感じです。

LAYERの0の左の丸をクリックすると片方の砂時計が消えます。1の丸をクリックすると、もう一方の砂時計が消えます。丸をクリックし直せば表示します。これで、好きな方だけ砂時計を表示することができます。

f:id:am1tanaka:20210801182139g:plain
レイヤーの表示と非表示

レイヤー0から砂を消す

レイヤー0を表示して、レイヤー0の砂時計をクリックして選択します。

f:id:am1tanaka:20210801182402p:plain
レイヤー0の砂時計を選択

  1. 右上の下三角アイコンをクリックしてモデルモードにします。
  2. Region Selectツールで枠の部分をクリックして選択します
  3. Transformツールで移動させて砂時計のボクセルを見えるようにします
  4. Region Selectツールで砂時計のボクセルの一つをクリックして選択したら、右のEditパネルのSELECT欄からCutで削除します
  5. 枠を元の位置に戻します

f:id:am1tanaka:20210801185004g:plain
砂を消す

レイヤー1を砂だけにする

同じような操作をして、レイヤー1のオブジェクトを砂だけにします。

  1. 右上の三角をクリックしてワールドモードに切り替えます
  2. 赤い枠のレイヤー1の砂時計をクリックして選択します
  3. 右上の三角をクリックしてモデルモードに切り替えます

f:id:am1tanaka:20210801185429p:plain
レイヤー1の砂時計を選択

  1. Region Selectツールを選択します
  2. 枠のボクセルの一つをクリックして選択します
  3. Cutで削除します

f:id:am1tanaka:20210801185616p:plain
枠を削除

f:id:am1tanaka:20210801185722p:plain
枠の削除完了

同様にしてガラスを削除します。

f:id:am1tanaka:20210801185750p:plain
砂だけ

あとは、砂を削除して好みの状態にします。削除する前の砂のオブジェクトをコピーして、別のレイヤーに取っておくと砂のさまざまな状態を作りやすくなります。

f:id:am1tanaka:20210801185944p:plain
砂完成

右上の三角をクリックしてワールドモードに切り替えたら、レイヤー1の場所を移動させて、レイヤー0の砂時計に重ねます。

f:id:am1tanaka:20210801190601g:plain
レイヤー0と1を重ねる

以上で完了です。Renderモードでレンダリングすると、砂が光っている砂時計がレンダリングされます。

f:id:am1tanaka:20210801190653p:plain
砂時計ボクセル完成!!

任意の場所にvoxファイルとして保存して、MagicaVoxelでの作業は完了です。

Unityにボクセルを読み込む

Voxel Importerでvoxを読み込む

ここからはあっという間です。UnityのプロジェクトにVoxel Importerをインストールします。

assetstore.unity.com

ついでにPostProcessing Stack V2も設定しておくといい感じで光るので良いです。PostProcessing Stackについてはこちらなどを。

Voxel Importerをインストールすれば、ボクセルの読み込みはvoxファイルをProjectウィンドウにドラッグ&ドロップするだけです。

f:id:am1tanaka:20210801213741p:plain
ボクセルをインポート

読み込んだボクセルをシーンにドラッグ&ドロップすれば表示できます。

f:id:am1tanaka:20210801213839p:plain
ボクセルの表示

パラメーターの調整

MagicaVoxelで設定したMatterの設定の多くはUnityへは反映されないのでUnity側で調整が必要です。また、他にもいくつか設定しておきたい項目があるので調整します。

  1. Projectウィンドウで読み込んだボクセルを選択します
  2. デフォルトでは1ボクセルが1mです。砂時計は15ボクセルなので15mと巨大なので、Scaleを0.066にしておおよそ1mにします
  3. Applyをクリックして変更を適用します
  4. Extract Materials...ボタンをクリックして、Materialsなどのフォルダーを指定して、マテリアルを保存します

f:id:am1tanaka:20210801214719p:plain
基本設定

ライトをベイクする場合は、さらに以下を設定すると問題が起きにくくなります。

  1. Advancedに切り替えます
  2. Share same faceのチェックを外して、面の共有をやめます
  3. Generate Lightmap UVにチェックを入れます
  4. ベイク時にoverlapの警告が表示される場合は、Pack Marginを増やすと軽減できる場合があります
  5. 全て設定したらApplyボタンを押します

f:id:am1tanaka:20210801215125p:plain
Advanced設定

マテリアルの設定

Extractしたマテリアルを編集して見た目を調整します。保存したマテリアル名ではどのマテリアルか不明ですが、ガラス用のマテリアルはシェーダーがTransparentになっているので分かりやすいです。

  1. Albedoのアルファを下げて透過させます
  2. Smoothnessを大きくしてピカピカにします

f:id:am1tanaka:20210801215752p:plain
ガラスの設定

残り2つのマテリアルのAlbedoを変更してみて、砂のマテリアルを探します。見つけたら、Emissionを設定して光らせます。

f:id:am1tanaka:20210801220103p:plain
Emissionの設定

以上で完成です!!

f:id:am1tanaka:20210801001016p:plain
完成!!

Voxel Importerのメリット

MagicaVoxelはobj形式でのエクスポートができるので、Voxel Importerがなくても同じようなことはできます。ただし、objだと以下のような感じに読み込まれます。

f:id:am1tanaka:20210802122335p:plain
objだとメッシュやテクスチャが分かれてしまう

Voxel Importerなら1つのメッシュで済みます。他にも、ボクセルにウェイトを設定してアニメさせることもできますし、ボクセルの最適化などもできますので、持っていると何かと有難いアセットだと思います。

まとめ

MagicaVoxelで作成したモデルをVoxel Importerで読み込んで、透過や自己発光を設定しました。

assetstore.unity.com

MagicaVoxelで色のMATERIALを変えるとUnityに別マテリアルとして読み込める性質を使って、1つのボクセルモデルに複数のマテリアルを設定しました。静止オブジェクトならドラッグ&ドロップだけでボクセルを読み込むことができ、マテリアルの取り出しもボタンひとつでできます。あとはマテリアルの設定をいじるだけ。また、MagicaVoxelのレイヤーを使うと多重構造などを作りやすくなります。

こんなことをしながら、3年目に突入したVoxelorerBirdの制作を続けています。

大半がMagicaVoxelの記事のような気がしますが、以上、Unity アセット真夏のアドベントカレンダー 2021 Summer! – Unity公式 Asset Portal の4日目の記事でした。

assetstore.info

▲前の日は さとや さんの「単独でも活用できる!Corgi Engine/TopDown Engineに同梱されているMMFeedbacksの紹介」でした。

▼次の日は kido さんの「History Inspector の紹介」です。

では良い制作の夏を!

参考URL

参考図書

conoHa WINGサーバーにFileZillaでSFTP接続

公式だとFTPの設定になってたのでSFTPで接続できるようにする設定を。

目次

SSHキーの作成

以下の手順でSSHキーを作成して、ユーザーフォルダーの.sshフォルダーなどにダウンロードしておきます。

support.conoha.jp

サイトマネージャーにサイト情報を作成

FileZillaでconoHaへの接続情報を作成します。

  • FileZillaのファイルメニューからサイトマネージャーを起動します
  • 新しいサイト をクリックして、conohaなどの名前にします

f:id:am1tanaka:20210531180712p:plain
新しいサイトの作成

  • 右の欄を以下のように設定します
    • プロトコル欄をSFTP - SSH File Transfer Protocol
    • ホスト欄にconoHaのSSH設定のホスト名
    • ポート番号はconoHaのSSH設定のポート番号(8022)
    • ログオンタイプを鍵ファイル
    • ユーザー欄にconoHaのSSH設定のユーザー名
  • 以上設定したら、鍵ファイルの 参照 ボタンをクリック

f:id:am1tanaka:20210531181829p:plain
サイト情報

  • ファイルの種類をPEM fileに変更して、conoHaからダウンロードした秘密鍵を選択して、開くボタンをクリック

f:id:am1tanaka:20210531182252p:plain
PEMファイルを開く

  • OKボタンをクリックします

以上で設定完了です。サイトマネージャーを開いて、conoHaの設定を選択すれば接続できます。

参考URL