refactoring of Method calculatePath from Game.java to Track.java

implemented PathFollowerMoveStrategy.java

README.md

@@ -1,2 +1,39 @@
 # team02-AngryNerds-projekt1-racetrack
 PM2 Team 02 Projekt 1 Racetrack
+Racetrack is a pen and paper game that dates back to the early 1960s in this version of the game, the game is digitalized and the math behind it is done automatically rather than calculated by hand and the winner gets informed automatically as well.
+
+The aim of the game is to finish the race faster than your opponent or win by being the only survivor in case the other cars crash.
+
+In order to not crash you have to keep in mind the acceleration and other players car to get to the finish line safely.
+
+# Initialization:
+#### The game can be initialized by the terminal command:
+    ./gradlew run
+You will then be prompted to select a track file from the selection by entering the corresponding number.
+
+#### For each car that is taking part in the race a strategy has to be chosen there are the following options:
+
++ Do not move Strategy
+> This Strategy sets the car stationary, and it won't make any moves during the game staying at the startpoint indefinitely.
++ User Move Strategy
+> The player is prompted for each move to make a choice the different choices you are able to take are as following:
+> > 1=down-left <br> 2=down<br> 3=down-right<br> 4=left<br> 5=no acceleration<br> 6=right <br> 7=up-left<br> 8=up<br> 9=up-right<br> it is also possible to leave the game when it is your turn by entering 10
++ Move List Strategy
+> For this strategy a predefined list of moves have to be given, the list may contain all allowed moves like mentioned in User Move Strategy
++ Path Follow Move Strategy
+> A list of point has to be given to the follow move strategy, the strategy will then calculate the route to cross each point in the given order.
++ Path Finder Strategy
+> The pathfinder Strategy Calculates a route itself and follows it direction fully automatically.
+
+The shown Track can be interpreted as following:<br>
+'#' is a Wall<br>
+'>,<,^,v' are finish line components<br>
+And every other character represents a car.
+
+### Determining a winner
+The winner gets determined automatically. <br> The car that first passes the finish line (doing a complete round) is given the win, if all car except one crash the surviving car will be crowned as the winner.<br>The game will inform you of this, and you will have the option to quit the game or play another match.
+
+## Branching Model
+We choose a simple branching model where all starting features got a branch and where merged into the main branch, some branches who needed unfinished code to be completed where taken from the game branch but merged into the main at the end as well.<br> Since there was just one end product  we abstained from using a development branch and merges where done straight into main.
+
+## Class Diagramm

follower/challenge_points.txt

@@ -0,0 +1,19 @@
+(X:40, Y:22)
+(X:43, Y:22)
+(X:46, Y:21)
+(X:48, Y:19)
+(X:48, Y:17)
+(X:46, Y:15)
+(X:41, Y:13)
+(X:41, Y:10)
+(X:46, Y:9)
+(X:49, Y:4)
+(X:40, Y:2)
+(X:30, Y:2)
+(X:21, Y:3)
+(X:16, Y:7)
+(X:13, Y:10)
+(X:14, Y:14)
+(X:11, Y:19)
+(X:13, Y:22)
+(X:24, Y:22)

src/main/java/ch/zhaw/pm2/racetrack/Game.java

@@ -44,32 +44,38 @@ public class Game implements GameSpecification {
             moveStrategies.add("Path Follow Move Strategy");
             for (int i = 0; i < track.getCarCount(); i++) {
                 Car car = track.getCar(i);
-                while (car.getMoveStrategy() == null) {
+                MoveStrategy moveStrategy = null;
+                while (moveStrategy == null) {
+                    String filePath;
                     int moveStrategie = userInterface.selectOption(
                         "Select Strategy for Car " + i + " (" + track.getCarId(i) + ")", moveStrategies);
                     switch (moveStrategie + 1) {
                         case 1:
-                            selectMoveStrategy(car, new DoNotMoveStrategy());
+                            moveStrategy = new DoNotMoveStrategy();
                             break;
                         case 2:
-                            selectMoveStrategy(car, new UserMoveStrategy(userInterface, i, track.getCarId(i)));
+                            moveStrategy = new UserMoveStrategy(userInterface, i, track.getCarId(i));
                             break;
                         case 3:
-                            String path = ".\\moves\\" + selectedTrack.getName().split("\\.")[0] + "-car-" + track.getCar(i).getID() + ".txt";
+                            filePath = ".\\moves\\" + selectedTrack.getName().split("\\.")[0] + "-car-" + track.getCar(i).getID() + ".txt";
                             try {
-                                MoveStrategy moveStrategy = new MoveListStrategy(path);
-                                selectMoveStrategy(car, moveStrategy);
+                                moveStrategy = new MoveListStrategy(filePath);
                             } catch (FileNotFoundException e) {
-                                userInterface.printInformation("There is no MoveList implemented. Choose another Strategy!");
+                                userInterface.printInformation("There is no Move-List implemented. Choose another Strategy!");
                             }
                             //TODO: Backslash kompatibel für Linux
                             break;
                         case 4:
-                            //TODO: add Arguments
-                            selectMoveStrategy(car, new PathFollowerMoveStrategy());
+                            filePath = ".\\follower\\" + selectedTrack.getName().split("\\.")[0] + "_points.txt";
+                            try {
+                                moveStrategy = new PathFollowerMoveStrategy(filePath, track.getCarPos(i));
+                            } catch (FileNotFoundException e) {
+                                userInterface.printInformation("There is no Point-List implemented. Choose another Strategy!");
+                            }
                             break;
                     }
                 }
+                selectMoveStrategy(car, moveStrategy);
             }
             return true;
         } else {
@@ -265,63 +271,10 @@ public class Game implements GameSpecification {
      */
     @Override
     public List<PositionVector> calculatePath(PositionVector startPosition, PositionVector endPosition) {
-        ArrayList<PositionVector> pathList = new ArrayList<>();
-        // Use Bresenham's algorithm to determine positions.
-        int x = startPosition.getX();
-        int y = startPosition.getY();
-
-        // Relative Distance (x & y axis) between end- and starting position
-        int diffX = endPosition.getX() - startPosition.getX();
-        int diffY = endPosition.getY() - startPosition.getY();
-
-        // Absolute distance (x & y axis) between end- and starting position
-        int distX = Math.abs(diffX);
-        int distY = Math.abs(diffY);
-
-        // Direction of vector on x & y axis (-1: to left/down, 0: none, +1 : to right/up)
-        int dirX = Integer.signum(diffX);
-        int dirY = Integer.signum(diffY);
-
-        // Determine which axis is the fast direction and set parallel/diagonal step values
-        int parallelStepX, parallelStepY;
-        int diagonalStepX, diagonalStepY;
-        int distanceSlowAxis, distanceFastAxis;
-        if (distX > distY) {
-            // x axis is the 'fast' direction
-            parallelStepX = dirX;
-            parallelStepY = 0; // parallel step only moves in x direction
-            diagonalStepX = dirX;
-            diagonalStepY = dirY; // diagonal step moves in both directions
-            distanceSlowAxis = distY;
-            distanceFastAxis = distX;
-        } else {
-            // y axis is the 'fast' direction
-            parallelStepX = 0;
-            parallelStepY = dirY; // parallel step only moves in y direction
-            diagonalStepX = dirX;
-            diagonalStepY = dirY; // diagonal step moves in both directions
-            distanceSlowAxis = distX;
-            distanceFastAxis = distY;
+        return track.calculatePointsOnPath(startPosition, endPosition);
     }
 
-        int error = distanceFastAxis / 2;
-        for (int step = 0; step < distanceFastAxis; step++) {
-            error -= distanceSlowAxis;
-            if (error < 0) {
-                error += distanceFastAxis; // correct error value to be positive again
-                // step into slow direction; diagonal step
-                x += diagonalStepX;
-                y += diagonalStepY;
-            } else {
-                // step into fast direction; parallel step
-                x += parallelStepX;
-                y += parallelStepY;
-            }
 
-            pathList.add(new PositionVector(x, y));
-        }
-        return pathList;
-    }
 
     private void calculateWinner(PositionVector start, PositionVector finish, int carIndex) {
         List<PositionVector> path = calculatePath(start, finish);

src/main/java/ch/zhaw/pm2/racetrack/Track.java

@@ -355,6 +355,65 @@ public class Track implements TrackSpecification {
         return currentSpace.getValue();
     }
 
+    public ArrayList<PositionVector> calculatePointsOnPath(PositionVector startPosition, PositionVector endPosition) {
+        ArrayList<PositionVector> pathList = new ArrayList<>();
+        // Use Bresenham's algorithm to determine positions.
+        int x = startPosition.getX();
+        int y = startPosition.getY();
+
+        // Relative Distance (x & y axis) between end- and starting position
+        int diffX = endPosition.getX() - startPosition.getX();
+        int diffY = endPosition.getY() - startPosition.getY();
+
+        // Absolute distance (x & y axis) between end- and starting position
+        int distX = Math.abs(diffX);
+        int distY = Math.abs(diffY);
+
+        // Direction of vector on x & y axis (-1: to left/down, 0: none, +1 : to right/up)
+        int dirX = Integer.signum(diffX);
+        int dirY = Integer.signum(diffY);
+
+        // Determine which axis is the fast direction and set parallel/diagonal step values
+        int parallelStepX, parallelStepY;
+        int diagonalStepX, diagonalStepY;
+        int distanceSlowAxis, distanceFastAxis;
+        if (distX > distY) {
+            // x axis is the 'fast' direction
+            parallelStepX = dirX;
+            parallelStepY = 0; // parallel step only moves in x direction
+            diagonalStepX = dirX;
+            diagonalStepY = dirY; // diagonal step moves in both directions
+            distanceSlowAxis = distY;
+            distanceFastAxis = distX;
+        } else {
+            // y axis is the 'fast' direction
+            parallelStepX = 0;
+            parallelStepY = dirY; // parallel step only moves in y direction
+            diagonalStepX = dirX;
+            diagonalStepY = dirY; // diagonal step moves in both directions
+            distanceSlowAxis = distX;
+            distanceFastAxis = distY;
+        }
+
+        int error = distanceFastAxis / 2;
+        for (int step = 0; step < distanceFastAxis; step++) {
+            error -= distanceSlowAxis;
+            if (error < 0) {
+                error += distanceFastAxis; // correct error value to be positive again
+                // step into slow direction; diagonal step
+                x += diagonalStepX;
+                y += diagonalStepY;
+            } else {
+                // step into fast direction; parallel step
+                x += parallelStepX;
+                y += parallelStepY;
+            }
+
+            pathList.add(new PositionVector(x, y));
+        }
+        return pathList;
+    }
+
     /**
      * Return a String representation of the track, including the car locations.
      *

src/main/java/ch/zhaw/pm2/racetrack/strategy/MoveListStrategy.java

@@ -25,9 +25,9 @@ public class MoveListStrategy implements MoveStrategy {
         Direction[] directions = Direction.values();
         while (scanner.hasNextLine()) {
             String line = scanner.nextLine();
-            for (Direction dir : directions) {
-                if (dir.toString().equals(line)) {
-                    moveList.add(dir);
+            for (Direction direction : directions) {
+                if (direction.toString().equals(line)) {
+                    moveList.add(direction);
                     break;
                 }
             }

src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFollowerMoveStrategy.java

@@ -1,15 +1,126 @@
 package ch.zhaw.pm2.racetrack.strategy;
 
+import ch.zhaw.pm2.racetrack.PositionVector;
 import ch.zhaw.pm2.racetrack.PositionVector.Direction;
 
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.util.ArrayList;
+import java.util.Scanner;
+
 /**
  * The PathFollowerMoveStrategy class determines the next move based on a file containing points on a path.
  */
 public class PathFollowerMoveStrategy implements MoveStrategy {
 
+    /**
+     * The current Position of the car.
+     */
+    private PositionVector currentPosition;
+    /**
+     * The current Velocity of the car.
+     */
+    private PositionVector currentVelocity;
+    /**
+     * List of all points on the path.
+     */
+    private ArrayList<PositionVector> pointList;
+    /**
+     * The index of the next point on the path.
+     */
+    private int pointer;
+
+    /**
+     * Constructor to create a new PathFollowerMoveStrategy for a car.
+     * @param path The location where the file is saved
+     * @param startPosition The start position of the car
+     * @throws FileNotFoundException If the file with the given path does not exist.
+     */
+    public PathFollowerMoveStrategy(String path, PositionVector startPosition) throws FileNotFoundException {
+        pointList = new ArrayList<>();
+        pointer = 0;
+        readFile(new File(path));
+        currentPosition = startPosition;
+        currentVelocity = new PositionVector(0, 0);
+    }
+
+    /**
+     * Method to read the given File and add the points to the pointList
+     * @param trackFile the File Object which should be read
+     * @throws FileNotFoundException If the file with the given path does not exist.
+     */
+    public void readFile(File trackFile) throws FileNotFoundException {
+        Scanner scanner = new Scanner(new FileInputStream(trackFile), "UTF-8");
+        while (scanner.hasNextLine()) {
+            String line = scanner.nextLine();
+            String[] coordinates = line.split("(\\(X:|, Y:|\\))");
+            pointList.add(new PositionVector(Integer.parseInt(coordinates[1]), Integer.parseInt(coordinates[2])));
+        }
+    }
+
+    /**
+     * Method to select the direction for the next move.
+     * @return The direction for the next move. null if there are no points left in the list.
+     */
     @Override
     public Direction nextMove() {
-        // TODO: implementation
-        throw new UnsupportedOperationException();
+        // if no more points in the list --> return null
+        if (pointer >= pointList.size()) {
+            return null;
+        }
+
+        // increase pointer variable if the next point is reached.
+        if (pointList.get(pointer).equals(currentPosition)) {
+            pointer ++;
+        }
+
+        // calculate Vector from current Position to next Point
+        PositionVector movementVector = new PositionVector(pointList.get(pointer).getX() - currentPosition.getX(), pointList.get(pointer).getY() - currentPosition.getY());
+
+        // select acceleration for X
+        int accelerationX;
+        if((movementVector.getX() == 0 && currentVelocity.getX() > 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getX() > 0 && movementVector.getX()/2.0 <= currentVelocity.getX()) || //increase velocity
+            (movementVector.getX() < 0 && movementVector.getX()/2.0 < currentVelocity.getX())){ //reduce velocity
+                accelerationX = -1;
+        } else if((movementVector.getX() == 0 && currentVelocity.getX() < 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getX() > 0 && movementVector.getX()/2.0 > currentVelocity.getX()) || //increase velocity
+            (movementVector.getX() < 0 && movementVector.getX()/2.0 >= currentVelocity.getX())) { //reduce velocity
+                accelerationX = 1;
+        }
+        else { //no acceleration
+            accelerationX = 0;
+        }
+
+        // select acceleration for Y
+        int accelerationY;
+        if((movementVector.getY() == 0 && currentVelocity.getY() > 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getY() > 0 && movementVector.getY()/2.0 <= currentVelocity.getY()) || //increase velocity
+            (movementVector.getY() < 0 && movementVector.getY()/2.0 < currentVelocity.getY())){ //reduce velocity
+                accelerationY = -1;
+        } else if((movementVector.getY() == 0 && currentVelocity.getY() < 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getY() > 0 && movementVector.getY()/2.0 > currentVelocity.getY()) || //increase velocity
+            (movementVector.getY() < 0 && movementVector.getY()/2.0 >= currentVelocity.getY())) { //reduce velocity
+                accelerationY = 1;
+        }
+        else { //no acceleration
+            accelerationY = 0;
+        }
+
+        //update current Velocity and current Position with the selected acceleration
+        currentVelocity = new PositionVector(currentVelocity.getX() + accelerationX, currentVelocity.getY() + accelerationY);
+        currentPosition = new PositionVector(currentPosition.getX() + currentVelocity.getX(), currentPosition.getY() + currentVelocity.getY());
+
+        //Find Direction for acceleration
+        PositionVector acceleration = new PositionVector(accelerationX, accelerationY);
+        Direction[] directions = Direction.values();
+        for (Direction direction : directions) {
+            if (direction.vector.equals(acceleration)) {
+                return direction;
+            }
+        }
+    return null;
+
     }
 }

src/test/java/ch/zhaw/pm2/racetrack/CarTest.java

@@ -186,7 +186,11 @@ class CarTest {
         car.setMoveStrategy(moveStrategy);
         assertEquals(moveStrategy, car.getMoveStrategy());
 
-        moveStrategy = new PathFollowerMoveStrategy();
+        try {
+            moveStrategy = new PathFollowerMoveStrategy(".\\follower\\challenge_points.txt", new PositionVector(0, 0));
+        } catch (FileNotFoundException e) {
+            e.printStackTrace();
+        }
         car.setMoveStrategy(moveStrategy);
         assertEquals(moveStrategy, car.getMoveStrategy());