chore: PR feedback

aplib.net-demo/Assets/Scripts/Models/Model.cs

@@ -1,6 +1,6 @@
 using System;
 using UnityEngine;
-using Grid = WFC.Grid;
+using Grid = Assets.Scripts.Wfc.Grid;
 
 namespace Assets.Scripts.Models
 {

aplib.net-demo/Assets/Scripts/Tiles/Corner.cs

@@ -5,7 +5,7 @@ namespace Assets.Scripts.Tiles
 {
     /// <summary>
     /// Represents a corner tile.
-    /// <br/><br/>
+    /// <para/>
     /// Default orientation (north):
     /// <code>
     ///

aplib.net-demo/Assets/Scripts/Tiles/Crossing.cs

@@ -5,7 +5,7 @@ namespace Assets.Scripts.Tiles
 {
     /// <summary>
     /// Represents a crossing tile.
-    /// <br/><br/>
+    /// <para/>
     /// Default orientation (north):
     /// <code>
     ///

aplib.net-demo/Assets/Scripts/Tiles/DeadEnd.cs

@@ -5,7 +5,7 @@ namespace Assets.Scripts.Tiles
 {
     /// <summary>
     /// Represents a dead end tile.
-    /// <br/><br/>
+    /// <para/>
     /// Default orientation (north):
     /// <code>
     ///

aplib.net-demo/Assets/Scripts/Tiles/Direction.cs

@@ -17,7 +17,7 @@ public enum Direction
     public static class DirectionExtensions
     {
         /// <summary>
-        /// Rotates the direction X times to the right.
+        /// Rotates the direction X times clockwise.
         /// </summary>
         /// <param name="direction">The direction to rotate.</param>
         /// <param name="times">The number of times the direction must be rotated.</param>
@@ -26,7 +26,7 @@ public static Direction RotateRight(this Direction direction, int times = 1)
             => (Direction)(((int)direction + times) % 4);
 
         /// <summary>
-        /// Rotates the direction X times to the left.
+        /// Rotates the direction X times counterclockwise.
         /// </summary>
         /// <param name="direction">The direction to rotate.</param>
         /// <param name="times">The number of times the direction must be rotated.</param>
@@ -38,8 +38,10 @@ public static Direction RotateLeft(this Direction direction, int times = 1)
         /// Rotates the direction X times to the left or right.
         /// </summary>
         /// <param name="direction">The direction to rotate.</param>
-        /// <param name="times">The number of times the direction must be rotated.
-        /// Negative numbers indicate rotation towards the left.</param>
+        /// <param name="times">
+        /// The number of times the direction must be rotated.
+        /// Negative numbers indicate rotation towards the left.
+        /// </param>
         /// <returns>The adjusted direction.</returns>
         public static Direction Rotate(this Direction direction, int times)
             => times >= 0 ? direction.RotateRight(times) : direction.RotateLeft(-times);

aplib.net-demo/Assets/Scripts/Tiles/Empty.cs

@@ -4,7 +4,7 @@ namespace Assets.Scripts.Tiles
 {
     /// <summary>
     /// Represents an empty tile.
-    /// <br/><br/>
+    /// <para/>
     /// Default orientation (north):
     /// <code>
     ///

aplib.net-demo/Assets/Scripts/Tiles/Straight.cs

@@ -5,7 +5,7 @@ namespace Assets.Scripts.Tiles
 {
     /// <summary>
     /// Represents a straight tile.
-    /// <br/><br/>
+    /// <para/>
     /// Default orientation (north):
     /// <code>
     ///

aplib.net-demo/Assets/Scripts/Tiles/TSection.cs

@@ -5,7 +5,7 @@ namespace Assets.Scripts.Tiles
 {
     /// <summary>
     /// Represents a T-section tile.
-    /// <br/><br/>
+    /// <para/>
     /// Default orientation (north):
     /// <code>
     ///
@@ -21,7 +21,7 @@ public class TSection : Tile
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="TSection"/> class.
-        /// The default is a T-section with the top side opened.
+        /// The default is a T-section with the bottom side closed.
         /// </summary>
         /// <param name="facing">The direction in which the front of the tile should face.</param>
         public TSection(Direction facing = North)

aplib.net-demo/Assets/Scripts/WFC/Cell.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using static Assets.Scripts.Tiles.Direction;
 
-namespace WFC
+namespace Assets.Scripts.Wfc
 {
     /// <summary>
     /// Represents a cell in the grid.

aplib.net-demo/Assets/Scripts/WFC/Grid.cs

@@ -5,7 +5,7 @@
 using System.Linq;
 using static Assets.Scripts.Tiles.Direction;
 
-namespace WFC
+namespace Assets.Scripts.Wfc
 {
     /// <summary>
     /// Represents a grid.
@@ -78,7 +78,7 @@ public void Init()
         /// <param name="index">Ranging from 0 to infinity, and beyond! But not too far, as you will get an exception.</param>
         /// <returns>The coordinates of the belonging tile.</returns>
         /// <exception cref="IndexOutOfRangeException">
-        /// When index is larger than <see cref="Width"/> times /// <see cref="Height"/>.
+        /// When index is larger than <see cref="Width"/> times <see cref="Height"/>.
         /// </exception>
         protected (int x, int y) IndexToCoordinates(int index)
         {
@@ -156,8 +156,8 @@ public ICollection<Cell> Get8NeighbouringCells(Cell cell)
         }
 
         /// <summary>
-        /// Given a cell, this method determines all directly adjacent neighbours which are connected by their <see cref="Tile"/>s.
-        /// These are at most 4, as diagonal tiles cannot be connected.
+        /// Given a cell, this method determines all directly adjacent neighbours which are connected by their
+        /// <see cref="Tile"/>s. These are at most 4, as diagonal tiles cannot be connected.
         /// </summary>
         /// <param name="cell">The cell whose connected tiles are to be determined.</param>
         /// <returns>The cells directly connected through their tiles</returns>
@@ -168,13 +168,10 @@ public ICollection<Cell> GetConnectedNeighbours(Cell cell)
             ICollection<Cell> neighbours = Get4NeighbouringCells(cell); // Note: no diagonal neighbours
             foreach (Cell neighbour in neighbours)
             {
-                if (cell.Tile.CanConnectInDirection(East) && neighbour.X > cell.X && neighbour.Tile.CanConnectInDirection(West))
-                    connectedNeighbours.Add(neighbour);
-                else if (cell.Tile.CanConnectInDirection(West) && neighbour.X < cell.X && neighbour.Tile.CanConnectInDirection(East))
-                    connectedNeighbours.Add(neighbour);
-                else if (cell.Tile.CanConnectInDirection(North) && neighbour.Y > cell.Y && neighbour.Tile.CanConnectInDirection(South))
-                    connectedNeighbours.Add(neighbour);
-                else if (cell.Tile.CanConnectInDirection(South) && neighbour.Y < cell.Y && neighbour.Tile.CanConnectInDirection(North))
+                if (cell.Tile.CanConnectInDirection(East) && neighbour.X > cell.X && neighbour.Tile.CanConnectInDirection(West)
+                    || cell.Tile.CanConnectInDirection(West) && neighbour.X < cell.X && neighbour.Tile.CanConnectInDirection(East)
+                    || cell.Tile.CanConnectInDirection(North) && neighbour.Y > cell.Y && neighbour.Tile.CanConnectInDirection(South)
+                    || cell.Tile.CanConnectInDirection(South) && neighbour.Y < cell.Y && neighbour.Tile.CanConnectInDirection(North))
                     connectedNeighbours.Add(neighbour);
             }
 

aplib.net-demo/Assets/Scripts/WFC/GridPlacer.cs

@@ -3,7 +3,7 @@
 using UnityEngine;
 using static Assets.Scripts.Tiles.Direction;
 
-namespace WFC
+namespace Assets.Scripts.Wfc
 {
     /// <summary>
     /// Represents the grid placer.
@@ -85,14 +85,14 @@ public void PlaceTile(int x, int y, Tile tile)
         {
             GameObject prefab = tile switch
             {
-                Corner   => RoomObjects.Corner,
+                Corner => RoomObjects.Corner,
                 Crossing => RoomObjects.Crossing,
-                DeadEnd  => RoomObjects.DeadEnd,
-                Empty    => RoomObjects.Empty,
-                Room     => RoomObjects.Room,
+                DeadEnd => RoomObjects.DeadEnd,
+                Empty => RoomObjects.Empty,
+                Room => RoomObjects.Room,
                 Straight => RoomObjects.Straight,
                 TSection => RoomObjects.TSection,
-                _        => null
+                _ => null
             };
 
             if (prefab != null)
@@ -122,6 +122,7 @@ private void JoinConnectedComponentsWithTeleporters()
             // TODO the joining of the connected components with teleporters will be done in another PR.
         }
 
+        // Here are temporary helper methods used to display the connected components in different colors.
         private static Color[] _colors = { Color.red, Color.blue, Color.green, Color.yellow, Color.magenta, Color.cyan };
         private static int _colorIndex = -1;
         private static Color GetUnusedColor() => _colors[_colorIndex = (_colorIndex + 1) % _colors.Length];

aplib.net-demo/Assets/Scripts/WFC/RoomObjects.cs

@@ -1,6 +1,6 @@
 using UnityEngine;
 
-namespace WFC
+namespace Assets.Scripts.Wfc
 {
     /// <summary>
     /// Represents the room objects.