Unity Tilemapの比較関数の実装とプレハブを用いたテスト

        /// <summary>
        /// Tilemap の TileBase の参照が等しいかを比較します。
        /// Tilemap ではタイルパレットの同じタイルが配置された場合、実体が同じ TileBase 派生オブジェクトを配置します。
        /// そのためタイルマップに配置されたタイルごとの変形や色の変化は Tilemap で持っています。
        /// </summary>
        /// <param name="this">比較元の TileBase です。</param>
        /// <param name="that">比較対象の TileBase です。</param>
        /// <returns>二つの TileBase の参照が等しければ true を返します。</returns>
        public static bool SCIsSameReference(this TileBase @this, TileBase that)
        {
            return @this == that;   // 参照の比較
        }

        /// <summary>
        /// 二つの Tilemap の同じ座標に同じタイルが配置されていること、
        /// その二つのタイルの表示設定(AnimationFrameCount TileFlags, TransfomrMatrix(Move, Rotate, Scale)) がタイルごとに一致していることを比較します。
        /// Tilemap 全体の設定については比較しません。
        /// </summary>
        /// <param name="this">比較元の Tilemap です。</param>
        /// <param name="that">比較対象の Tilemap です。</param>
        /// <param name="bounds">比較する範囲です。二つのタイルマップで交差する部分に制限されます。 null の場合は二つのタイルマップで交差する範囲です。</param>
        /// <returns>二つのタイルマップのタイル群の配置・表示設定が等価ならば true 、他は false を返します。</returns>
        public static bool SCIsSameTileBlockLayout(this Tilemap @this, Tilemap that, BoundsInt? bounds = null)
        {
            BoundsInt cellBounds;
            if (bounds == null)
            {
                BoundsInt thisCellBounds = @this.cellBounds;
                BoundsInt thatCellBounds = that.cellBounds;

                cellBounds = @this.cellBounds;
                cellBounds.ClampToBounds(that.cellBounds);
            }
            else
            {
                cellBounds = (BoundsInt)bounds; // null 許容型から値型へキャストします。
                cellBounds.ClampToBounds(@this.cellBounds);
                cellBounds.ClampToBounds(that.cellBounds);
            }

            // ループ内で戻り値を保持する変数の宣言しておきます。
            TileBase thisTile, thatTile = null;
            int index = 0;
            Vector3Int cellPosition = new Vector3Int();
            TileFlags thisTileFlags, thatTileFlags;
            int thisFrameCount, thatFrameCount;
            Matrix4x4 thisTransformMatrix;
            Matrix4x4 thatTransformMatrix;

            // それぞれのタイルマップから指定範囲のブロックの範囲のタイルを配列で取得します。
            TileBase[] thisTiles = @this.GetTilesBlock(cellBounds);
            TileBase[] thatTiles = that.GetTilesBlock(cellBounds);

            // 同じ座標に配置されているタイルをそれぞれのタイルマップから取得し、比較します。
            for (int y = 0; y < cellBounds.size.y; ++y)
            {
                for (int x = 0; x < cellBounds.size.x; ++x)
                {
                    index = x + cellBounds.size.x * y;
                    cellPosition.Set(x, y, 0);

                    thisTile = thisTiles[index];
                    thatTile = thatTiles[index];
                    if (thisTile.SCIsSameReference(thatTile) == false)
                    {
                        return false;
                    }

                    // https://docs.unity3d.com/ScriptReference/Tilemaps.Tilemap.html

                    // GetColor, GetSprite は同一 Tile で共通の設定なので比較しません。

                    // GetAnimationFrame は現在の表示フレーム番号を返すものなので比較しません。

                    thisFrameCount = @this.GetAnimationFrameCount(cellPosition);
                    thatFrameCount = that.GetAnimationFrameCount(cellPosition);
                    if (thisFrameCount != thatFrameCount)
                    {
                        return false;
                    }

                    // GetAnimationTime は現在時間軸でどの位置のアニメーションが行われているかを得る関数なので比較しません。

                    // GetCellCenterLocal, GetCellCenterWorld は Tilemap.tileAnchor で確認するので比較しません。

                    thisTileFlags = @this.GetTileFlags(cellPosition);
                    thatTileFlags = that.GetTileFlags(cellPosition);
                    if (thisTileFlags != thatTileFlags) // 値型なので == で値が等しいか確認します。
                    {
                        return false;
                    }

                    thisTransformMatrix = @this.GetTransformMatrix(cellPosition);
                    thatTransformMatrix = that.GetTransformMatrix(cellPosition);
                    if (thisTransformMatrix.Equals(thatTransformMatrix) == false)
                    {
                        return false;
                    }
                }
            }
            return true;
        }

    /// <summary>
    /// SCTilemapExtensions の SCIsSameTileBlockLayout 関数のテストです。
    /// 二つのタイルマップのタイルの配置や表示設定が同じならば true を返す、異なれば false を返すテストを行います。
    /// 同じ Grid の下に用意したタイルマップ 3 つを比較対象にします。
    /// Tilemap1 は同じタイルを 3x3 マスに 4 つ配置し、Move, Rotate, Scale をそれぞれ変えています。
    /// Tilmeap1Dup は Tilemap 1 の複製です。そのため Tilemap1 と Tilemap1Dup の比較では true を期待します。
    /// Tilemap2 は同じ 3x3 マスですが、タイルの配置位置や、表示設定が少し異なります。
    /// Tilemap1 と Tilemap2 の比較では false を期待します。
    /// </summary>
    /// <param name="gridPrefabPath"></param>
    /// <param name="tilemap1Name"></param>
    /// <param name="tilemap2Name"></param>
    /// <param name="constraint"></param>
    [TestCase("Test/Tilemap/TestGrid2", "Tilemap1", "Tilemap1Dup", true)]
    [TestCase("Test/Tilemap/TestGrid2", "Tilemap1", "Tilemap2", false)]
    public void SCTilemapExtensions_SCIsSameTileBlockLayout_1(string gridPrefabPath, string tilemap1Name, string tilemap2Name, bool constraint)
    {
        GameObject gridPrefab = Resources.Load(gridPrefabPath) as GameObject;
        GameObject gridGo = GameObject.Instantiate(gridPrefab);
        GameObject tilemap1Go = gridGo.transform.Find(tilemap1Name).gameObject;
        GameObject tilemap2Go = gridGo.transform.Find(tilemap2Name).gameObject;
        Tilemap tilemap1 = tilemap1Go.GetComponent<Tilemap>();
        Tilemap tilemap2 = tilemap2Go.GetComponent<Tilemap>();

        bool actual = tilemap1.SCIsSameTileBlockLayout(tilemap2);

        Assert.That(actual, Is.EqualTo(constraint));
    }