From 0134f15d18fc57affc8da7369d5d2b0deb021ce4 Mon Sep 17 00:00:00 2001 From: Pacien TRAN-GIRARD Date: Mon, 25 Apr 2016 14:41:58 +0200 Subject: New code review and refactoring --- src/ch/epfl/xblast/server/painter/BlockImage.java | 6 +- .../epfl/xblast/server/painter/BoardPainter.java | 25 ++++--- .../xblast/server/painter/ExplosionPainter.java | 32 ++++---- .../epfl/xblast/server/painter/PlayerPainter.java | 86 ++++++++++++++++------ test/ch/epfl/xblast/painter/BoardPainterTest.java | 42 ++++++----- .../epfl/xblast/painter/ExplosionPainterTest.java | 23 +++--- test/ch/epfl/xblast/painter/PlayerPainterTest.java | 39 +++++----- 7 files changed, 159 insertions(+), 94 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 blocksMap, BlockImage shadowedFreeBlock ) { - this.blocksMap = blocksMap; + public BoardPainter(Map 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 + */ + private static byte byteForFrame(int tick) { + int cycleTick = tick % ANIMATION_TICK_LOOP; + return (byte) (cycleTick % 2 == 0 ? 0 : cycleTick / 2 + 1); + } + + /** + * Returns the byte for the given Direction. + * + * @param d the Direction + * @return the directional byte + */ + private static byte byteForDirection(Direction d) { + return (byte) (d.ordinal() * DIRECTION_MULTIPLIER); + } + + /** + * Returns the player image byte for the given PlayerID. + * + * @param pid the PlayerID + * @return the image byte for the player + */ + private static byte byteForPlayerID(PlayerID pid) { + return (byte) (pid.ordinal() * PLAYER_MULTIPLIER); + } + + /** + * Returns the image ID for the dying state according to the number of remaining lives. + * + * @param lives the number of remaining lives + * @return the dying image ID + */ + private static byte byteForDyingState(int lives) { + return lives == 0 ? LAST_DYING_IMAGE_ID : DYING_IMAGE_ID; + } /** * Returns the byte related to the image corresponding to the actual state of the given player. * * @param player the given player - * @param tick the actual tick of the game + * @param tick the actual tick of the game * @return the byte related to the image of the the actual state of the player */ public static byte byteForPlayer(Player player, int tick) { - if (!player.isAlive()) - return DEAD_PLAYER; + switch (player.lifeState().state()) { + case DEAD: + return DEAD_PLAYER_IMAGE_ID; - byte correspondingByte = (byte) (player.id().ordinal() * PLAYER_MULTIPLIER); + case DYING: + return (byte) (byteForPlayerID(player.id()) + + byteForDyingState(player.lives())); - if (player.lifeState().state() == Player.LifeState.State.DYING) - if (player.lives() > 0) - return (byte) (correspondingByte + DYING_IMAGE_ID); - else - return (byte) (correspondingByte + LAST_DYING_IMAGE_ID ); - - correspondingByte += player.direction().ordinal() * 3; - - switch (tick % 4) { // Magic Numbers !!! - case 1: - return (byte) (correspondingByte + 1); - case 3: - return (byte) (correspondingByte + 2); default: - return (byte) (correspondingByte + 0); + return (byte) (byteForPlayerID(player.id()) + + byteForDirection(player.direction()) + + byteForFrame(tick)); } } + } diff --git a/test/ch/epfl/xblast/painter/BoardPainterTest.java b/test/ch/epfl/xblast/painter/BoardPainterTest.java index 9ac8ad4..050e84f 100644 --- a/test/ch/epfl/xblast/painter/BoardPainterTest.java +++ b/test/ch/epfl/xblast/painter/BoardPainterTest.java @@ -1,34 +1,40 @@ package ch.epfl.xblast.painter; -import ch.epfl.xblast.*; -import ch.epfl.xblast.server.*; -import ch.epfl.xblast.server.painter.*; - -import java.util.Arrays; -import java.util.HashMap; - +import ch.epfl.xblast.Cell; +import ch.epfl.xblast.server.Block; +import ch.epfl.xblast.server.Board; +import ch.epfl.xblast.server.painter.BlockImage; +import ch.epfl.xblast.server.painter.BoardPainter; import org.junit.Assert; import org.junit.Test; +import java.util.Arrays; +import java.util.HashMap; + /** * @author Timothée Floure (257420) + * @author Pacien TRAN-GIRARD (261948) */ public class BoardPainterTest { - public static Board createBoard() { + private static Board createBoard() { Block __ = Block.FREE; Block XX = Block.INDESTRUCTIBLE_WALL; Block xx = Block.DESTRUCTIBLE_WALL; - return Board.ofQuadrantNWBlocksWalled(Arrays.asList(Arrays.asList(__, __, __, __, __, xx, __), - Arrays.asList(__, XX, xx, XX, xx, XX, xx), Arrays.asList(__, xx, __, __, __, xx, __), - Arrays.asList(xx, XX, __, XX, XX, XX, XX), Arrays.asList(__, xx, __, xx, __, __, __), - Arrays.asList(xx, XX, xx, XX, xx, XX, __))); + return Board.ofQuadrantNWBlocksWalled( + Arrays.asList( + Arrays.asList(__, __, __, __, __, xx, __), + Arrays.asList(__, XX, xx, XX, xx, XX, xx), + Arrays.asList(__, xx, __, __, __, xx, __), + Arrays.asList(xx, XX, __, XX, XX, XX, XX), + Arrays.asList(__, xx, __, xx, __, __, __), + Arrays.asList(xx, XX, xx, XX, xx, XX, __))); } @Test public void byteForCellTest() { // Create the blocks map - HashMap blocksMap = new HashMap<>(); + HashMap blocksMap = new HashMap<>(); // Fill the blocks map blocksMap.put(Block.FREE, BlockImage.IRON_FLOOR); @@ -38,20 +44,18 @@ public class BoardPainterTest { blocksMap.put(Block.BONUS_BOMB, BlockImage.BONUS_BOMB); blocksMap.put(Block.BONUS_RANGE, BlockImage.BONUS_RANGE); - // Instanciates the painter + // Instantiates the painter BoardPainter painter = new BoardPainter(blocksMap, BlockImage.IRON_FLOOR_S); // Create a dummy board Board board = createBoard(); - Cell freeCell = new Cell(2,1); - Cell shadowedFreeCell = new Cell(1,1); - Cell walledCell = new Cell(0,0); + Cell freeCell = new Cell(2, 1); + Cell shadowedFreeCell = new Cell(1, 1); + Cell walledCell = new Cell(0, 0); Assert.assertEquals(painter.byteForCell(board, freeCell), BlockImage.IRON_FLOOR.ordinal()); Assert.assertEquals(painter.byteForCell(board, shadowedFreeCell), BlockImage.IRON_FLOOR_S.ordinal()); Assert.assertEquals(painter.byteForCell(board, walledCell), BlockImage.DARK_BLOCK.ordinal()); - } - } diff --git a/test/ch/epfl/xblast/painter/ExplosionPainterTest.java b/test/ch/epfl/xblast/painter/ExplosionPainterTest.java index 204b1ad..a6df54b 100644 --- a/test/ch/epfl/xblast/painter/ExplosionPainterTest.java +++ b/test/ch/epfl/xblast/painter/ExplosionPainterTest.java @@ -1,19 +1,21 @@ package ch.epfl.xblast.painter; -import ch.epfl.xblast.*; -import ch.epfl.xblast.server.*; -import ch.epfl.xblast.server.painter.*; - +import ch.epfl.xblast.Cell; +import ch.epfl.xblast.PlayerID; +import ch.epfl.xblast.server.Bomb; +import ch.epfl.xblast.server.painter.ExplosionPainter; import org.junit.Assert; import org.junit.Test; /** * @author Timothée Floure (257420) + * @author Pacien TRAN-GIRARD (261948) */ public class ExplosionPainterTest { + @Test public void byteForBombTest() { - Cell cell = new Cell(1,1); + Cell cell = new Cell(1, 1); int range = 5; Bomb bomb1 = new Bomb(PlayerID.PLAYER_1, cell, 8, range); @@ -29,9 +31,10 @@ public class ExplosionPainterTest { @Test public void byteForBlastTest() { - Assert.assertEquals((byte) 15,ExplosionPainter.byteForBlast(true,true,true,true)); // NESW - Assert.assertEquals((byte) 0,ExplosionPainter.byteForBlast(false,false,false,false)); // nesw - Assert.assertEquals((byte) 13,ExplosionPainter.byteForBlast(true,true,false,true)); // NEsW - Assert.assertEquals((byte) 4,ExplosionPainter.byteForBlast(false,true,false,false)); // nEsw + Assert.assertEquals((byte) 15, ExplosionPainter.byteForBlast(true, true, true, true)); // NESW + Assert.assertEquals((byte) 0, ExplosionPainter.byteForBlast(false, false, false, false)); // nesw + Assert.assertEquals((byte) 13, ExplosionPainter.byteForBlast(true, true, false, true)); // NEsW + Assert.assertEquals((byte) 4, ExplosionPainter.byteForBlast(false, true, false, false)); // nEsw } -} \ No newline at end of file + +} diff --git a/test/ch/epfl/xblast/painter/PlayerPainterTest.java b/test/ch/epfl/xblast/painter/PlayerPainterTest.java index 32b14a9..5eb20f4 100644 --- a/test/ch/epfl/xblast/painter/PlayerPainterTest.java +++ b/test/ch/epfl/xblast/painter/PlayerPainterTest.java @@ -1,22 +1,24 @@ package ch.epfl.xblast.painter; import ch.epfl.cs108.Sq; -import ch.epfl.xblast.*; -import ch.epfl.xblast.server.*; -import ch.epfl.xblast.server.painter.*; - +import ch.epfl.xblast.Direction; +import ch.epfl.xblast.PlayerID; +import ch.epfl.xblast.SubCell; +import ch.epfl.xblast.server.Player; +import ch.epfl.xblast.server.painter.PlayerPainter; import org.junit.Assert; import org.junit.Test; /** * @author Timothée Floure (257420) + * @author Pacien TRAN-GIRARD (261948) */ public class PlayerPainterTest { - private Player playerGenerator(PlayerID id,Direction direction,Player.LifeState.State state,SubCell position,int lives) { + private Player playerGenerator(PlayerID id, Direction direction, Player.LifeState.State state, SubCell position, int lives) { Sq lifeStates = Sq.constant(new Player.LifeState(lives, state)); Sq directedPositions = Player.DirectedPosition.stopped( - new Player.DirectedPosition(position,direction) + new Player.DirectedPosition(position, direction) ); // id, lifeStates, DirectedPositions, MaxBombs, BombRange return new Player(id, lifeStates, directedPositions, 1, 1); @@ -24,38 +26,39 @@ public class PlayerPainterTest { @Test public void byteForPlayerTest() { - SubCell position = new SubCell(1,1); + SubCell position = new SubCell(1, 1); // Build the players Player player1 = playerGenerator(PlayerID.PLAYER_1, Direction.S, Player.LifeState.State.VULNERABLE, position, - 5 //lives - ); + 5 // lives + ); Player player2 = playerGenerator(PlayerID.PLAYER_2, Direction.S, Player.LifeState.State.DYING, position, - 1 //lives - ); + 1 // lives + ); Player player3 = playerGenerator(PlayerID.PLAYER_3, Direction.N, Player.LifeState.State.VULNERABLE, position, 5 // lives - ); + ); Player player4 = playerGenerator(PlayerID.PLAYER_4, Direction.E, Player.LifeState.State.VULNERABLE, position, 5 // lives - ); + ); // Assert - Assert.assertEquals((byte) 7,PlayerPainter.byteForPlayer(player1,1)); // P1 S1 - Assert.assertEquals((byte) 32,PlayerPainter.byteForPlayer(player2,1)); // P2 losing life - Assert.assertEquals((byte) 40,PlayerPainter.byteForPlayer(player3,2)); // P3 N0 - Assert.assertEquals((byte) 65,PlayerPainter.byteForPlayer(player4,3)); // P4 E2 + Assert.assertEquals((byte) 7, PlayerPainter.byteForPlayer(player1, 1)); // P1 S1 + Assert.assertEquals((byte) 32, PlayerPainter.byteForPlayer(player2, 1)); // P2 losing life + Assert.assertEquals((byte) 40, PlayerPainter.byteForPlayer(player3, 2)); // P3 N0 + Assert.assertEquals((byte) 65, PlayerPainter.byteForPlayer(player4, 3)); // P4 E2 } -} \ No newline at end of file + +} -- cgit v1.2.3