【Unity】シーンからCubemapを作成してpngファイルで出力するツールを作ってみた

f:id:tsgcpp:20200701205557p:plain

2021/06/19追記
概要
環境
前知識
実装方針
実装までの流れ
ツールの使用方法
- ツールの起動
- ツールの設定
実行結果
生成した画像をCubemapとして適用
Github
2021/06/19追記
雑感

2021/06/19追記

諸々更新してツールの見た目が変わっています。
以下の記事は v0.0.3 に関する記事となっています。

概要

Unityで作成したシーンからCubemapを作成して、pngファイルとして出力するツールを作成したので紹介します。
Camera.RenderToCubemapを使用することでCubemap自体は作成できますが、そのCubemapをテクスチャファイルに出力するツールが見当たらなかったので作ってみました。
また、作成の過程で気になった点も併せて共有します。

記事の最後にgithubのリンクを記載します。

環境

Unity 2019.4.1f1
Windows 10

前知識

テクスチャ形式

公式ドキュメントのCubemapsに記載されているCreating Cubemaps from Texturesで解説されているテクスチャに準拠して作成します
現時点では縦または横に並べた形式のみをサポート

f:id:tsgcpp:20200701192521p:plain — テクスチャ形式 (Cubemapsページより引用)

Texture2D.SetPixels

Texture2D.SetPixels
ピクセル配列を渡すことで、テクスチャ上のピクセルをセットするメソッド
ピクセルの順番は左下から右上
- The colors array is a flattened 2D array, where pixels are laid out left to right, bottom to top より

Cubemap.GetPixels

Cubemap.GetPixels
指定したfaceに対応するテクスチャのピクセル配列をゲットするメソッド
ピクセルの順番は右上から左下
- Texture2D.SetPixelsとは順番が異なるため要注意
- The returned array is a flattened 2D array, where pixels are laid out right to left, top to bottom より

Camera.RenderToCubemap

Camera.RenderToCubemap
Cameraオブジェクトのpositionを中心としてCubemapを作成するメソッド

実装方針

タブから作成を実行
- MenuItemを使用
テクスチャサイズは可変
- Wizardにpublic int widthを追加
テクスチャ形式を指定可能
- Wizardにpublic FileType fileTypeを追加
Cameraの位置を指定可能
- Wizardにpublic Transform renderFromPositionを追加
ファイル出力先を指定可能
- EditorUtility.SaveFilePanelを使用

実装までの流れ

ソースコードについてはgithubを参照してください。

CubemapFileGeneratorWizardの作成

EditorツールにするためScriptableWizardCubemapFileGeneratorWizard`を継承したクラスCubemapFileGeneratorWizardを作成
- 基本的にはCamera.RenderToCubemapのRenderCubemapWizardを参考に作成
- ScriptableWizardの詳細については割愛

テクスチャ形式に合わせたConverterを作成

注意点としてVerticalPng(テクスチャを縦に並べる形式)の場合はSetPixelsを実施する順番を気を付けてください。
Texture2D.SetPixelsは画像の左下が原点なので、-Z, +Z, -Y, +Y, -X, +Xの順番(下から上)でセットするように実装しています。

Texture2DとCubemapの差異を補正するSetPixelsメソッドを作成

「前知識」で記載しましたが、Texture2DとCubemapには差異があるため、それを補正するメソッドを作成
Texture2DExtensions
- 今回はTexture2Dの拡張として実装

Color[] pixels = cubemap.GetPixels(face);

// Cubemap.GetPixelsは右上から左下の順番のため、
// SetPixelsに左下から右上の順番に合わせて反転させる
System.Array.Reverse(pixels);
for (int i = 0; i < blockWidth; ++i) {
    System.Array.Reverse(pixels, i * blockHeight, blockWidth);
}

texture.SetPixels(x, y, blockWidth, blockHeight, pixels);