New code review and refactoring

4 files changed, 102 insertions, 47 deletions

diff --git a/src/ch/epfl/xblast/server/painter/BlockImage.java b/src/ch/epfl/xblast/server/painter/BlockImage.java
index d5fa593..85a44be 100644
--- a/src/ch/epfl/xblast/server/painter/BlockImage.java
+++ b/src/ch/epfl/xblast/server/painter/BlockImage.java
@@ -1,7 +1,10 @@
 package ch.epfl.xblast.server.painter;
 
 /**
- * @author Timothée FLOURE (257420
+ * Block images enumeration.
+ *
+ * @author Timothée FLOURE (257420)
+ * @author Pacien TRAN-GIRARD (261948)
  */
 public enum BlockImage {
 
@@ -39,4 +42,5 @@ public enum BlockImage {
      * Bomb Range Bonus.
      */
     BONUS_RANGE
+
 }
diff --git a/src/ch/epfl/xblast/server/painter/BoardPainter.java b/src/ch/epfl/xblast/server/painter/BoardPainter.java
index 69af129..8378cce 100644
--- a/src/ch/epfl/xblast/server/painter/BoardPainter.java
+++ b/src/ch/epfl/xblast/server/painter/BoardPainter.java
@@ -1,12 +1,18 @@
 package ch.epfl.xblast.server.painter;
 
-import ch.epfl.xblast.*;
-import ch.epfl.xblast.server.*;
+import ch.epfl.xblast.Cell;
+import ch.epfl.xblast.Direction;
+import ch.epfl.xblast.server.Block;
+import ch.epfl.xblast.server.Board;
 
+import java.util.Collections;
 import java.util.Map;
 
 /**
+ * Board painter.
+ *
  * @author Timothée FLOURE (257420)
+ * @author Pacien TRAN-GIRARD (261948)
  */
 public final class BoardPainter {
 
@@ -16,11 +22,11 @@ public final class BoardPainter {
     /**
      * Instantiates a new BoardPainter.
      *
-     * @param blocksMap map linking block to the images
+     * @param blocksMap         map linking block to the images
      * @param shadowedFreeBlock a "shadowed" block image
      */
-    public BoardPainter(Map<Block, BlockImage> blocksMap, BlockImage shadowedFreeBlock ) {
-        this.blocksMap = blocksMap;
+    public BoardPainter(Map<Block, BlockImage> blocksMap, BlockImage shadowedFreeBlock) {
+        this.blocksMap = Collections.unmodifiableMap(blocksMap);
         this.shadowedFreeBlock = shadowedFreeBlock;
     }
 
@@ -28,13 +34,14 @@ public final class BoardPainter {
      * Returns the bits sequence of the block related to the given Cell.
      *
      * @param board given board
-     * @param cell given cell
-     * @return the bits sequence related to the image of the given cell
+     * @param cell  given cell
+     * @return the bit sequence related to the image of the given cell
      */
     public byte byteForCell(Board board, Cell cell) {
         if (board.blockAt(cell).isFree() && board.blockAt(cell.neighbor(Direction.W)).castsShadow())
             return (byte) shadowedFreeBlock.ordinal();
-
-        return (byte) this.blocksMap.get(board.blockAt(cell)).ordinal();
+        else
+            return (byte) this.blocksMap.get(board.blockAt(cell)).ordinal();
     }
+
 }
diff --git a/src/ch/epfl/xblast/server/painter/ExplosionPainter.java b/src/ch/epfl/xblast/server/painter/ExplosionPainter.java
index 63181e9..756d3c4 100644
--- a/src/ch/epfl/xblast/server/painter/ExplosionPainter.java
+++ b/src/ch/epfl/xblast/server/painter/ExplosionPainter.java
@@ -1,11 +1,15 @@
 package ch.epfl.xblast.server.painter;
 
-import ch.epfl.xblast.server.*;
+import ch.epfl.xblast.server.Bomb;
 
 /**
+ * Explosion painter.
+ *
  * @author Timothée FLOURE (257420)
+ * @author Pacien TRAN-GIRARD (261948)
  */
 public final class ExplosionPainter {
+
     private static final byte BLACK_BOMB_IMAGE = 20;
     private static final byte WHITE_BOMB_IMAGE = 21;
 
@@ -15,41 +19,37 @@ public final class ExplosionPainter {
     private static final byte WEST_EXPLOSION = 0b0001;
 
     /**
-     * Return the image corresponding to a bomb depending on its fuse length.
+     * Returns the image corresponding to a bomb depending on its fuse length.
      *
      * @param bomb given bomb
      * @return the byte related to the image of the bomb (black or white)
      */
-    public static byte byteForBomb(Bomb bomb)
-    {
-        if (Integer.bitCount(bomb.fuseLength()) == 1 ) {
-            return WHITE_BOMB_IMAGE;
-        } else {
-            return BLACK_BOMB_IMAGE;
-        }
+    public static byte byteForBomb(Bomb bomb) {
+        return Integer.bitCount(bomb.fuseLength()) == 1 ? WHITE_BOMB_IMAGE : BLACK_BOMB_IMAGE;
     }
 
     /**
      * Return the image corresponding to the explosion on a cell given the explosions of its neighbors.
      *
      * @param north is an explosion on the north cell
-     * @param east is an explosion on the east cell
+     * @param east  is an explosion on the east cell
      * @param south is an explosion on the south cell
-     * @param west is an explosion on the west cell
+     * @param west  is an explosion on the west cell
      * @return the byte corresponding to the related image
      */
     public static byte byteForBlast(boolean north, boolean east, boolean south, boolean west) {
-        byte correspondingByte = 0b0;
+        byte correspondingByte = 0b0000;
 
         if (north)
-            correspondingByte += NORTH_EXPLOSION;
+            correspondingByte |= NORTH_EXPLOSION;
         if (east)
-            correspondingByte += EAST_EXPLOSION;
+            correspondingByte |= EAST_EXPLOSION;
         if (south)
-            correspondingByte += SOUTH_EXPLOSION;
+            correspondingByte |= SOUTH_EXPLOSION;
         if (west)
-            correspondingByte += WEST_EXPLOSION;
+            correspondingByte |= WEST_EXPLOSION;
 
         return correspondingByte;
     }
+
 }
diff --git a/src/ch/epfl/xblast/server/painter/PlayerPainter.java b/src/ch/epfl/xblast/server/painter/PlayerPainter.java
index 4f28554..043cb50 100644
--- a/src/ch/epfl/xblast/server/painter/PlayerPainter.java
+++ b/src/ch/epfl/xblast/server/painter/PlayerPainter.java
@@ -1,44 +1,88 @@
 package ch.epfl.xblast.server.painter;
 
-import ch.epfl.xblast.server.*;
+import ch.epfl.xblast.Direction;
+import ch.epfl.xblast.PlayerID;
+import ch.epfl.xblast.server.Player;
 
 /**
+ * Player painter.
+ *
  * @author Timothée FLOURE (257420)
+ * @author Pacien TRAN-GIRARD (261948)
  */
 public final class PlayerPainter {
-    private static final byte DEAD_PLAYER = 16;
+
+    private static final byte DEAD_PLAYER_IMAGE_ID = 16;
     private static final byte DYING_IMAGE_ID = 12;
     private static final byte LAST_DYING_IMAGE_ID = 13;
-    private static final byte PLAYER_MULTIPLIER = 20;
+
+    private static final int PLAYER_MULTIPLIER = 20;
+    private static final int DIRECTION_MULTIPLIER = 3;
+
+    private static final int ANIMATION_TICK_LOOP = 4;
+
+    /**
+     * Computes and returns the animation frame byte for the given tick.
+     *
+     * @param tick the tick
+     * @return the frame byte