Compare commits

..

124 Commits

Author SHA1 Message Date
Marcela Ruiz 552b350c30 Feedback P1 Ruiz
Feedback P1 Ruiz
2022-04-08 11:55:57 +02:00
Leonardo Brandenberger 3e50a96f41 Merge remote-tracking branch 'origin/main' 2022-03-25 23:54:18 +01:00
Leonardo Brandenberger e68ab597d5 small adjustment in javadoc GameTest, MoveListStrategyTest, TrackTest
Author added in all of them
2022-03-25 23:54:10 +01:00
romanschenk37 9a278eb2db Javadoc in GameTest.java 2022-03-25 23:53:03 +01:00
Leonardo Brandenberger 31c76273c9 Merge remote-tracking branch 'origin/main' 2022-03-25 23:48:21 +01:00
Leonardo Brandenberger a5b12760ba added small improvements in GameTest 2022-03-25 23:48:07 +01:00
Leonardo Brandenberger 4a955c2978 added small improvements in GameTest 2022-03-25 23:47:48 +01:00
Andrin Fassbind 3ed26fb909 javadoc 2022-03-25 23:46:06 +01:00
Andrin Fassbind 143b5da14c Merge remote-tracking branch 'origin/main' 2022-03-25 23:45:03 +01:00
Andrin Fassbind 591bbc423d javadoc 2022-03-25 23:44:56 +01:00
romanschenk37 b4664cd854 Javadoc in MoveListStrategyTest 2022-03-25 23:44:06 +01:00
romanschenk37 1addc2a6d5 Merge remote-tracking branch 'origin/main' 2022-03-25 23:40:55 +01:00
romanschenk37 45cffafb6b code cleanup 2022-03-25 23:40:41 +01:00
Leonardo Brandenberger 9d8e699c02 Merge remote-tracking branch 'origin/main' 2022-03-25 23:38:58 +01:00
Leonardo Brandenberger cec225ea10 checked and added javadocs where needed in CarTest 2022-03-25 23:38:49 +01:00
romanschenk37 087ead234e Merge remote-tracking branch 'origin/main' 2022-03-25 23:38:35 +01:00
romanschenk37 52d0ace051 code cleanup 2022-03-25 23:38:26 +01:00
Leonardo Brandenberger c041006efb fixed small bug in README.md 2022-03-25 23:27:28 +01:00
Leonardo Brandenberger b68b567804 Merge remote-tracking branch 'origin/main' 2022-03-25 23:22:50 +01:00
Leonardo Brandenberger 94fe5c1e53 fixed small bug in README.md 2022-03-25 23:22:40 +01:00
Leonardo Brandenberger 093992ec99 fixed small bug in README.md 2022-03-25 23:21:20 +01:00
Andrin Fassbind 5701eaae43 Merge remote-tracking branch 'origin/main' 2022-03-25 23:19:21 +01:00
Andrin Fassbind 01391075bd javadoc 2022-03-25 23:19:09 +01:00
Leonardo Brandenberger 3b76abf760 Merge remote-tracking branch 'origin/main' 2022-03-25 23:16:21 +01:00
Leonardo Brandenberger e4e08859f7 finished README.md 2022-03-25 23:16:11 +01:00
romanschenk37 ee6b348611 Merge remote-tracking branch 'origin/main' 2022-03-25 23:13:53 +01:00
Andrin Fassbind be240d6721 codecleanup 2022-03-25 23:06:23 +01:00
romanschenk37 be2fb1fb5c code cleanup 2022-03-25 23:06:20 +01:00
Leonardo Brandenberger c41b56b47e Merge remote-tracking branch 'origin/main' 2022-03-25 22:58:02 +01:00
Leonardo Brandenberger d0da883795 fixed typos in several classes 2022-03-25 22:57:48 +01:00
romanschenk37 acd01b42eb code cleanup 2022-03-25 22:42:51 +01:00
Leonardo Brandenberger efe1e1f304 Merge remote-tracking branch 'origin/main' 2022-03-25 22:34:36 +01:00
Leonardo Brandenberger bb0e52b8bd added javadocs in InvalidFileFormatException, InvalidTrackFormatException, Track, UserInterface and Main. Enhanced Game methods 2022-03-25 22:34:26 +01:00
Andrin Fassbind 6c72354278 codecleanup 2022-03-25 22:33:22 +01:00
romanschenk37 2f6b2d2e41 Merge remote-tracking branch 'origin/main' 2022-03-25 22:15:30 +01:00
romanschenk37 cf9301d4b8 javadocs of Methods to create Movestrategy 2022-03-25 22:15:19 +01:00
Andrin Fassbind 8233758ca8 Klassendiagramm.svg updated 2022-03-25 22:11:42 +01:00
romanschenk37 976b153edb Merge remote-tracking branch 'origin/main' 2022-03-25 22:04:50 +01:00
romanschenk37 a77d02b440 refactoring Game.java 2022-03-25 22:04:38 +01:00
Leonardo Brandenberger 6560de8708 Merge remote-tracking branch 'origin/main'
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/InvalidFileFormatException.java
2022-03-25 22:04:18 +01:00
Andrin Fassbind d08ebc0187 code cleanup 2022-03-25 21:58:23 +01:00
Andrin Fassbind 77652705dc code cleanup 2022-03-25 21:55:19 +01:00
Leonardo Brandenberger 77922b71b8 Merge remote-tracking branch 'origin/main'
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/Game.java
#	src/main/java/ch/zhaw/pm2/racetrack/InvalidFileFormatException.java
2022-03-25 21:53:11 +01:00
Leonardo Brandenberger 73fd298fe5 added java docs 2022-03-25 21:48:40 +01:00
Andrin Fassbind 00cb917842 Merge remote-tracking branch 'origin/main' 2022-03-25 21:48:25 +01:00
Andrin Fassbind 65d7ea6e7e code cleanup 2022-03-25 21:48:12 +01:00
romanschenk37 a002362b62 Code Cleanup 2022-03-25 21:26:56 +01:00
romanschenk37 c72ae904e7 Merge remote-tracking branch 'origin/main' 2022-03-25 21:14:29 +01:00
romanschenk37 70a2179cce Code Cleanup 2022-03-25 21:14:18 +01:00
Leonardo Brandenberger 64996f4b93 added comments when exception is thrown in Track 2022-03-25 21:09:27 +01:00
romanschenk37 e2c6b5cb49 Merge remote-tracking branch 'origin/main' 2022-03-25 20:57:19 +01:00
romanschenk37 29b9daadd4 Code Cleanup 2022-03-25 20:57:07 +01:00
Leonardo Brandenberger 5c52f06956 Merge remote-tracking branch 'origin/main' 2022-03-25 20:51:50 +01:00
Leonardo Brandenberger 00debf7fa5 improved java docs 2022-03-25 20:51:27 +01:00
Andrin Fassbind a9366de7bc code cleanup 2022-03-25 20:28:47 +01:00
Andrin Fassbind a2560ce5d5 Klassendiagramm.svg 2022-03-25 20:22:37 +01:00
Andrin Fassbind 48675b0ca5 codecleanup MoveListStrategy 2022-03-25 20:17:30 +01:00
Andrin Fassbind bb41595609 updated Klassendiagramm.drawio and README 2022-03-25 20:08:11 +01:00
romanschenk37 d1444a366f Code Cleanup 2022-03-25 19:16:17 +01:00
romanschenk37 3761377b61 Code Cleanup 2022-03-25 19:14:01 +01:00
romanschenk37 53b2dabc59 Merge remote-tracking branch 'origin/main' 2022-03-25 16:31:47 +01:00
romanschenk37 52f9eb7629 fixing function quit in usermovestrategy 2022-03-25 16:31:37 +01:00
Andrin Fassbind 4a401f54c4 updated Klassendiagramm.drawio 2022-03-25 16:23:56 +01:00
Andrin Fassbind c43a08cef9 Merge remote-tracking branch 'origin/main'
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFinderMoveStrategy.java
2022-03-25 11:08:48 +01:00
Andrin Fassbind 8581b7ee64 - updated javadoc
- added playscenario to GameTest
2022-03-25 11:06:08 +01:00
romanschenk37 6c4f18a0d1 change in Readme.md 2022-03-25 11:05:29 +01:00
romanschenk37 daa0cc322a removed Todo 2022-03-25 11:00:30 +01:00
romanschenk37 09ab684fdd Merge remote-tracking branch 'origin/main' 2022-03-25 10:52:43 +01:00
romanschenk37 ff41150e44 Javadoc in PathFinderMoveStrategy.java 2022-03-25 10:52:32 +01:00
Leonardo Brandenberger d038132055 Merge remote-tracking branch 'origin/main' 2022-03-25 09:27:09 +01:00
Leonardo Brandenberger 38728f0921 finished Java 2022-03-25 09:27:00 +01:00
romanschenk37 483d800484 Merge pull request #31 from PM2-IT21bWIN-ruiz-mach-krea/Strategy
Strategy
2022-03-25 09:24:21 +01:00
romanschenk37 7f9b0bafe4 Merge branch 'main' into Strategy
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/Game.java
#	src/main/java/ch/zhaw/pm2/racetrack/Track.java
#	src/test/java/ch/zhaw/pm2/racetrack/GameTest.java
2022-03-25 09:21:12 +01:00
Leonardo Brandenberger 2366f798ca added all javadocs to class Track 2022-03-25 08:58:34 +01:00
romanschenk37 d6a9b5f1aa fixed PathFinderMoveStrategy 2022-03-25 08:58:01 +01:00
Leonardo Brandenberger 13012c1d4b Merge remote-tracking branch 'origin/main'
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/Track.java
2022-03-25 08:52:41 +01:00
romanschenk37 448e34e869 fixed PathFinderMoveStrategy 2022-03-25 00:10:07 +01:00
romanschenk37 b01bee0142 fixed PathFinderMoveStrategy 2022-03-25 00:02:04 +01:00
romanschenk37 7c8cf55ac2 fix calculateNewWinPoints 2022-03-24 19:14:36 +01:00
romanschenk37 0a57afc3c7 Merge remote-tracking branch 'origin/Strategy' into Strategy 2022-03-24 19:05:01 +01:00
romanschenk37 e84bce43af fix getWinner in Game.java
working on PathFinderMoveStrategy
2022-03-24 19:04:43 +01:00
Andrin Fassbind 1a3a96218c refactor Track 2022-03-24 18:49:07 +01:00
Andrin Fassbind 19eb41066c GameTest.java correct 2022-03-24 18:45:59 +01:00
Andrin Fassbind 95ef0b9d76 refactor gametest 2022-03-24 18:33:29 +01:00
romanschenk37 30162df956 Merge remote-tracking branch 'origin/Strategy' into Strategy 2022-03-24 18:18:20 +01:00
romanschenk37 d777b87549 fix in Method calculateNewWinPoints 2022-03-24 18:18:07 +01:00
Andrin Fassbind 7b6fc70e05 removed PositionVectorNotValidException.java 2022-03-24 17:53:35 +01:00
Andrin Fassbind a2dcc1b0d8 Merge remote-tracking branch 'origin/Strategy' into Strategy 2022-03-24 17:52:21 +01:00
Andrin Fassbind badec0d16f removed PositionVectorNotValidException.java 2022-03-24 17:50:03 +01:00
romanschenk37 82911fcfb6 merge Game.java 2022-03-24 17:45:15 +01:00
romanschenk37 f133f4305d Merge branch 'main' into Strategy
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/Game.java
2022-03-24 17:43:40 +01:00
romanschenk37 0656b77662 worked on PathFinderMoveStrategy and Refactoring in Game.java 2022-03-24 17:38:40 +01:00
Leonardo Brandenberger c997730abf Merge remote-tracking branch 'origin/main'
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/Track.java
2022-03-24 17:33:11 +01:00
Andrin Fassbind f6a16181cf removed PositionVectorNotValidException.java 2022-03-24 17:27:30 +01:00
Leonardo Brandenberger 2b2834f47a added all javadocs to class Track 2022-03-24 17:26:44 +01:00
romanschenk37 ad2e1c3104 worked on PathFinderMoveStrategy and Refactoring in Game.java 2022-03-24 17:09:05 +01:00
Andrin Fassbind eca2e2eb9b refactored merge conflict in Track 2022-03-24 17:02:42 +01:00
Andrin Fassbind 80b07111de Merge remote-tracking branch 'origin/main'
# Conflicts:
#	src/main/java/ch/zhaw/pm2/racetrack/Game.java
#	src/main/java/ch/zhaw/pm2/racetrack/Track.java
2022-03-24 16:57:00 +01:00
Andrin Fassbind a143a9c7d7 refactoring several classes 2022-03-24 16:50:18 +01:00
Leonardo Brandenberger 31ec1e9e64 refactoring done in several classes 2022-03-24 16:30:59 +01:00
Leonardo Brandenberger bc0dd52360 added elements to README.md 2022-03-24 14:38:08 +01:00
Leonardo Brandenberger 015dbac96c added elements to README.md 2022-03-24 14:36:48 +01:00
romanschenk37 4b5802a0d0 added PathFinderMoveStrategy in Game. 2022-03-24 13:59:46 +01:00
romanschenk37 a689df5fe1 Merge branch 'main' into Strategy 2022-03-24 13:41:42 +01:00
Leonardo Brandenberger 4ce26578b9 Merge pull request #30 from PM2-IT21bWIN-ruiz-mach-krea/Game
refactoring of Method calculatePath from Game.java to Track.java
2022-03-24 13:35:38 +01:00
romanschenk37 fa4842e440 refactoring of Method calculatePath from Game.java to Track.java 2022-03-24 13:32:12 +01:00
Leonardo Brandenberger dc704cce4c continued readme 2022-03-23 21:32:15 +01:00
Leonardo Brandenberger 082d1414f5 started readme 2022-03-23 21:19:37 +01:00
Leonardo Brandenberger 7c87f4b2fd started readme 2022-03-23 21:11:36 +01:00
Leonardo Brandenberger 1c63c0cb21 started readme 2022-03-23 21:08:57 +01:00
Leonardo Brandenberger 787ddd7155 Merge remote-tracking branch 'origin/main' 2022-03-23 21:07:55 +01:00
Leonardo Brandenberger a14327a2a7 started readme 2022-03-23 21:07:44 +01:00
romanschenk37 ded9023ff1 adapted CarTest.java for PathFolowerMoveStrategy.java 2022-03-23 11:24:58 +01:00
romanschenk37 2de3993921 Merge pull request #28 from PM2-IT21bWIN-ruiz-mach-krea/PathFollowerMoveStrategy
implemented PathFollowerMoveStrategy.java
2022-03-23 10:09:35 +01:00
romanschenk37 de91717a48 Merge pull request #29 from PM2-IT21bWIN-ruiz-mach-krea/GameTest
Game test
2022-03-23 09:18:59 +01:00
romanschenk37 6ac4f64456 Javadoc in PathFollowerMoveStrategy.java 2022-03-23 08:55:32 +01:00
romanschenk37 45918124df refactoring and javadoc in PathFollowerMoveStrategy.javaa 2022-03-23 08:48:46 +01:00
romanschenk37 c59e4a30d8 Update MoveListStrategy.java 2022-03-22 18:31:15 +01:00
romanschenk37 eddf9d3daa implemented PathFollowerMoveStrategy.java 2022-03-22 18:20:23 +01:00
Leonardo Brandenberger cf1a8d703e continued class PathFinderStrategy 2022-03-21 01:26:26 +01:00
Andrin Fassbind 6403ee958f Merge remote-tracking branch 'origin/Strategy' into Strategy 2022-03-20 16:59:50 +01:00
Leonardo Brandenberger 7c841abfc6 continued class PathFinderStrategy 2022-03-20 16:33:03 +01:00
Andrin Fassbind ae62f9e98c Merge branch 'Game' into Strategy 2022-03-20 13:45:44 +01:00
Leonardo Brandenberger 0b423b759e started method PathFinderStrategy, (much work needed still no real solution in mind) 2022-03-20 03:26:00 +01:00
24 changed files with 1137 additions and 420 deletions

BIN
FeedbackP1_ruiz.md.pdf Normal file

Binary file not shown.

View File

@ -1 +0,0 @@
<mxfile host="Electron" modified="2022-03-22T17:46:19.706Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/16.5.1 Chrome/96.0.4664.110 Electron/16.0.7 Safari/537.36" etag="blTsmpdlGFIXdx0F82xm" version="16.5.1" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">7Vtbd6I6GP01PraLi7c+qr3MzOn0OGNPe16jRMgxEE+Itc6vny8QQExVaGVorWt1rZKPkED2zpedDTbsgf98w9Hc+84cTBuW4Tw37MuGZZnwB/9kZBVHOu1mHHA5cVSlLDAiv7AKGiq6IA4OcxUFY1SQeT44YUGAJyIXQ5yzZb7alNF8r3PkYi0wmiCqRx+JI7w42rU6WfwLJq6X9Gy2L+IzPkoqqycJPeSw5VrIvmrYA86YiI/85wGmcvCScXn8unqkt7P2zbcf4f/on/5f93cPZ3Fj12UuSR+B40C8uulfs+n1l4fmf//Oh9c/lsZNb/ztTF1iPCG6UOM1xDxkgXpisUqGMVwSn6IASv0pC8RInYFB6CNK3ACOJ3B3mEPgCXNBAIGeOiHYHKITj1DnFq3YQj5DKNBklpT6HuPkFzSLKJwyIQCnuVBkstq5GiN5JYQNiHIcQp1hMjBmGrpFoVB1JoxSNA/JOLphWcVH3CVBnwnB/KQhtggc7KhSinRUEJzNUu7I6wvCoWCTo4Gf18io4LnBzMeCr6CKOttVaKiZ1lLFZUZbs61i3jpl7a6aLmqquGnLaWc/YWqhwIUhSHuz7Hx3ZrNgf4BHrjtEAfYACdyXgxiukxAO1h40C0XULEFTU6PpHfKxRlIYZ7FGSIqnYisdwzmakMC9jepcNrPIT/WkMsTg2imNqOARx8FBRBWBBIrZJPkxZyQQ0VC0+vAHAzYwzluNFtzQAMpmVoY/WZ2LAQuAVYhE9MFA1SWWdH2BWDsn7X5irfKIlUV2nUg5SMviZ+lpxmOBJOPdwh9D0jg2JHfkE0/4VB1WhXfLqhlvW8P7ykdEXtZzHMjQ4QnwgwLe6dYMeFMDXEOYkkg9qNEwX1xZ98DvA5CyuQTve0mHyzNT44Stc8J+AX+KxpgOWUgEYbJ9Htfd4EVdWds0msVQ3bH8vwnUlp61F3zioVAmbhBdMxje6OgI53NloJp15+a2hupILBz5mAU1v3HS/JVpfrtbreg37Vf2V4Po72wn6rHKxoJZp12YZe9lA9DVsOzB3UvrxjK+w0pydEgeVA+Wxrv2DcDFSQ8eHNSiIr8qOWjqZuFXSPzGFaARrbSWcc9kOeBMtnZkM3pdAjWrwrhbd6I2davtBssVd4R9EiAuAb9HM6w7xB8d36ogrV/xJzewKxvjwOnJty1QGlMmxXYfQkqNm0ZcvCY0Wbn2yOX88ocdFydTB9MxW15lgX4UgBMJU0qL7ZDBrhTvhwy2Fy4usJmTd7sT2JeA5JgiQZ7yL512aPOhJG6myy0jr8stw843ET+kumr9LU/ZhuJR0Bo6mFOvW39DzqY4DJku108bzOo3mLb5yh1fx9hL4hc2mHazQHed97HBNHXXcoQoUhn3E65t6eT9OBtLUzcpNfQ++06jPKxF94+VbTV0k/JTKZYEsXctWTYXls4rJcvmCmV1Nu6lasmiG43b3lKeBEv1gqW1oSAKf5Zi7lhjtguWVivf3bv+DEa3UUeCY6y/uvksgqVTmF3vRrDo1uiAiOOTnAc1wMvjXLsDnnw1mpurkB1OQB8W6No/fbF0xxSEvVzELWPAnBPgBwa88Gcx1SGu+6kDGBNxhMZB3VjbrxRjh8Na9zM1kD+9v1Ae11ZBGVaVwWDp1t8DQOQc4wJdHYrt2jOx7v79vRDzhXQXevJV5a2cBydECyN6UXu+Lef8sXk01uW8vdQWNOt3+tTY7jX6Eiz3On0KZ0mlnIuibuiNpp+98b2ieWHlmyhq+m26PFpDW0w/raGzzRdOG+2w6TTElfiGlu4bGufnCfAZXSMvbi0R7Ek7Y+XIxWt4H01mbsTfAaOMw/mAZf6jMrut4jkhmV/q55bqthrpjxyL+3Rnb2RUQsw/BpdunhXHKtFPHxWsw8z+5JPcPw6d7plReAq5wKOt3ueaHN9EVVfBRQz8VKPvxrqUif5GYmgE2MaV4uvExWGYknyevmHiv4UrUMx+bB1Xz36ybl/9Bg==</diagram></mxfile>

1
Klassendiagramm.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 115 KiB

View File

@ -1,2 +1,51 @@
# team02-AngryNerds-projekt1-racetrack
PM2 Team 02 Projekt 1 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 player's car to get to the finish line safely.
# Testing
#### All test can be run by the terminal command:
gradlew test
# 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 start point 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
> > To create your own Move List strategy it needs to be located in /racetrack/moves and be named as *track_name*-car-*character_of_car*.txt and be a txt file.
+ Path Follow Move Strategy
> A list of points given in a txt file where on each lime a coordinate is placed like (X:24, Y:22) gets used to calculate a path which makes the car cross each point.
> > To create your own follow move strategy it needs to be located in /racetrack/moves and be named as *track_name*_points.txt and be a txt file.
+ 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>
'spaces' are part of the raceable track.<br>
'#' is a Wall<br>
'>,<,^,v' are finish line components<br>
'X' is shown if a car crashes at its crash location.<br>
And every other character represents a car.
> To create your own track it needs to be located inside /racetrack/tracks and be a txt file.
### 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 branch.<br>Commits which contain only documentation and doesn't change any functionality are committed directly into the Main branch.
## Class Diagramm
To create the best possible insight, all methods that are in the classes that we edited are shown completely. Including the private methods, since they can clearly be distinguished from the public ones through their prefix. <br>
However, the classes that were already given, i.e. not editable, are also in the class diagram for clarity, but the methods had been omitted since they can be found in the documentation, and the interfaces are just there for grading test purposes. <br><br>
![Classdiagram of this program](./Klassendiagramm.svg)
## GitHub Project
Our GitHub Project can be found here: [GitHubProject](https://github.zhaw.ch/PM2-IT21bWIN-ruiz-mach-krea/team02-AngryNerds-projekt1-racetrack/projects)

View File

@ -0,0 +1,23 @@
(X:28, Y:22)
(X:31, Y:22)
(X:34, Y:22)
(X:37, Y:22)
(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)

View File

@ -35,6 +35,3 @@ UP_RIGHT
UP_RIGHT UP_RIGHT
RIGHT RIGHT
RIGHT RIGHT

View File

@ -3,14 +3,12 @@ package ch.zhaw.pm2.racetrack;
import ch.zhaw.pm2.racetrack.given.CarSpecification; import ch.zhaw.pm2.racetrack.given.CarSpecification;
import ch.zhaw.pm2.racetrack.strategy.MoveStrategy; import ch.zhaw.pm2.racetrack.strategy.MoveStrategy;
import java.util.Vector;
/** /**
* Class representing a car on the racetrack. * Class representing a car on the racetrack.
* Uses {@link PositionVector} to store current position on the track grid and current velocity vector. * Uses {@link PositionVector} to store current position on the track grid and current velocity vector.
* Each car has an identifier character which represents the car on the race track board. * Each car has an identifier character which represents the car on the racetrack board.
* Also keeps the state, if the car is crashed (not active anymore). The state can not be changed back to uncrashed. * Also keeps the state, if the car is crashed (not active anymore). The state can not be changed back to uncrashed.
* The velocity is changed by providing an acelleration vector. * The velocity is changed by providing an acceleration vector.
* The car is able to calculate the endpoint of its next position and on request moves to it. * The car is able to calculate the endpoint of its next position and on request moves to it.
*/ */
public class Car implements CarSpecification { public class Car implements CarSpecification {
@ -46,6 +44,7 @@ public class Car implements CarSpecification {
/** /**
* Constructor for class Car * Constructor for class Car
*
* @param id unique Car identification * @param id unique Car identification
* @param position initial position of the Car * @param position initial position of the Car
*/ */
@ -59,18 +58,29 @@ public class Car implements CarSpecification {
* *
* @return id of the car. * @return id of the car.
*/ */
public char getID(){ public char getID() {
return id; return id;
} }
/**
* Increases the winpoints by one
*/
public void increaseWinPoints() { public void increaseWinPoints() {
winPoints ++; winPoints++;
} }
/**
* Decreases the winpoints by one
*/
public void deductWinPoints() { public void deductWinPoints() {
winPoints --; winPoints--;
} }
/**
* Returns the current value of winpoints.
*
* @return winpoints of the car
*/
public int getWinPoints() { public int getWinPoints() {
return winPoints; return winPoints;
} }
@ -80,13 +90,14 @@ public class Car implements CarSpecification {
* *
* @return velocity current velocity of the car. * @return velocity current velocity of the car.
*/ */
public PositionVector getVelocity(){ public PositionVector getVelocity() {
return velocity; return velocity;
} }
/** /**
* Set this Car position directly, regardless of current position and velocity. * Set this Car position directly, regardless of current position and velocity.
* This should only be used by the game controller in rare cases to set the crash or winning position. * This should only be used by the game controller in rare cases to set the crash or winning position.
* The next position is normaly automatically calculated and set in the {@link #move()} method. * The next position is normally automatically calculated and set in the {@link #move()} method.
* *
* @param position The new position to set the car directly to. * @param position The new position to set the car directly to.
* @throws IllegalArgumentException if invalid PositionVector is given. * @throws IllegalArgumentException if invalid PositionVector is given.
@ -95,8 +106,7 @@ public class Car implements CarSpecification {
public void setPosition(final PositionVector position) { public void setPosition(final PositionVector position) {
if (position.getX() < 0 || position.getY() < 0) { if (position.getX() < 0 || position.getY() < 0) {
throw new IllegalArgumentException(); throw new IllegalArgumentException();
} } else {
else {
this.position = position; this.position = position;
} }
} }
@ -109,7 +119,7 @@ public class Car implements CarSpecification {
*/ */
@Override @Override
public PositionVector nextPosition() { public PositionVector nextPosition() {
return new PositionVector(position.getX() + velocity.getX(),position.getY() + velocity.getY()); return new PositionVector(position.getX() + velocity.getX(), position.getY() + velocity.getY());
} }
/** /**
@ -123,11 +133,10 @@ public class Car implements CarSpecification {
*/ */
@Override @Override
public void accelerate(PositionVector.Direction acceleration) { public void accelerate(PositionVector.Direction acceleration) {
if(acceleration.vector.getX() < -1 || acceleration.vector.getX() > 1|| if (acceleration.vector.getX() < -1 || acceleration.vector.getX() > 1 ||
acceleration.vector.getY() < -1 || acceleration.vector.getY() > 1) { acceleration.vector.getY() < -1 || acceleration.vector.getY() > 1) {
throw new IllegalArgumentException(); throw new IllegalArgumentException();
} } else {
else {
velocity = new PositionVector(velocity.getX() + acceleration.vector.getX(), velocity = new PositionVector(velocity.getX() + acceleration.vector.getX(),
velocity.getY() + acceleration.vector.getY()); velocity.getY() + acceleration.vector.getY());
} }
@ -142,7 +151,7 @@ public class Car implements CarSpecification {
} }
/** /**
* Mark this Car as being crashed. * Marks the car as crashed
*/ */
@Override @Override
public void crash() { public void crash() {
@ -150,7 +159,7 @@ public class Car implements CarSpecification {
} }
/** /**
* Returns whether this Car has been marked as crashed. * Returns whether this Car has been marked as crashed or not
* *
* @return Returns true if crash() has been called on this Car, false otherwise. * @return Returns true if crash() has been called on this Car, false otherwise.
*/ */
@ -160,18 +169,20 @@ public class Car implements CarSpecification {
} }
/** /**
* Set move strategy * Returns the current move Strategy
*
* @return the current move Strategy
*/
public MoveStrategy getMoveStrategy() {
return this.moveStrategy;
}
/**
* Set the move Strategy of the car.
*
* @param moveStrategy Strategy to be implemented * @param moveStrategy Strategy to be implemented
*/ */
public void setMoveStrategy(MoveStrategy moveStrategy) { public void setMoveStrategy(MoveStrategy moveStrategy) {
this.moveStrategy = moveStrategy; this.moveStrategy = moveStrategy;
} }
/**
* Get current move strategy
* @return MoveStrategy
*/
public MoveStrategy getMoveStrategy() {
return this.moveStrategy;
}
} }

View File

@ -6,6 +6,7 @@ import ch.zhaw.pm2.racetrack.strategy.*;
import java.io.File; import java.io.File;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.List; import java.util.List;
import static ch.zhaw.pm2.racetrack.PositionVector.Direction; import static ch.zhaw.pm2.racetrack.PositionVector.Direction;
@ -19,81 +20,133 @@ public class Game implements GameSpecification {
public static final int NO_WINNER = -1; public static final int NO_WINNER = -1;
private Track track; private Track track;
private int currentCarIndex; private int currentCarIndex;
private final Config config;
private final UserInterface userInterface;
UserInterface userInterface; public Game(UserInterface userInterface, Config config) {
public Game(UserInterface userInterface) {
this.userInterface = userInterface; this.userInterface = userInterface;
this.config = config;
} }
/**
public boolean initPhase() throws InvalidTrackFormatException { * This method will initialize the game. Therefore, it interacts with the user via UserInterface
File folder = new File("tracks"); *
File[] listOfFiles = folder.listFiles(); * @return true if the initialization is completed. Returns false if there is an error.
if (listOfFiles.length > 0) { */
List<String> tracks = new ArrayList<>(); public boolean initPhase() {
for (File file : listOfFiles) { if (config.getTrackDirectory().listFiles().length > 0) {
tracks.add(file.getName()); File selectedTrack = config.getTrackDirectory().listFiles()[userInterface.selectOption("Select Track file", Arrays.asList(config.getTrackDirectory().list()))];
} try {
File selectedTrack = listOfFiles[userInterface.selectOption("Select Track file", tracks)];
selectTrack(selectedTrack); selectTrack(selectedTrack);
} catch (FileNotFoundException e) {
userInterface.printInformation("There is an unexpected Error with the track file Path. Add track files only to tracks path. Exit the Game and Fix the Problem");
return false;
} catch (InvalidTrackFormatException e) {
userInterface.printInformation("There is an unexpected Error with the track file. Format does not match specifications! Exit the Game and Fix the Problem");
return false;
}
List<String> moveStrategies = new ArrayList<>(); List<String> moveStrategies = new ArrayList<>();
moveStrategies.add("Do not move Strategy"); moveStrategies.add("Do not move Strategy");
moveStrategies.add("User Move Strategy"); moveStrategies.add("User Move Strategy");
moveStrategies.add("Move List Strategy"); moveStrategies.add("Move List Strategy");
moveStrategies.add("Path Follow Move Strategy"); moveStrategies.add("Path Follow Move Strategy");
for (int i = 0; i < track.getCarCount(); i++) { moveStrategies.add("Path Finder Move Strategy");
Car car = track.getCar(i); for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) {
while (car.getMoveStrategy() == null) { Car car = track.getCar(carIndex);
MoveStrategy moveStrategy = null;
while (moveStrategy == null) {
int moveStrategie = userInterface.selectOption( int moveStrategie = userInterface.selectOption(
"Select Strategy for Car " + i + " (" + track.getCarId(i) + ")", moveStrategies); "Select Strategy for Car " + carIndex + " (" + track.getCarId(carIndex) + ")", moveStrategies);
switch (moveStrategie + 1) { switch (moveStrategie) {
case 1: case 0 -> moveStrategy = new DoNotMoveStrategy();
selectMoveStrategy(car, new DoNotMoveStrategy()); case 1 -> moveStrategy = new UserMoveStrategy(userInterface, carIndex, track.getCarId(carIndex));
break; case 2 -> moveStrategy = getMoveListStrategy(selectedTrack, carIndex);
case 2: case 3 -> moveStrategy = getPathFollowerMoveStrategy(selectedTrack, carIndex);
selectMoveStrategy(car, new UserMoveStrategy(userInterface, i, track.getCarId(i))); case 4 -> moveStrategy = new PathFinderMoveStrategy(track, carIndex);
break; }
case 3: }
String path = ".\\moves\\" + selectedTrack.getName().split("\\.")[0] + "-car-" + track.getCar(i).getID() + ".txt";
try {
MoveStrategy moveStrategy = new MoveListStrategy(path);
selectMoveStrategy(car, moveStrategy); selectMoveStrategy(car, moveStrategy);
} catch (FileNotFoundException e) {
userInterface.printInformation("There is no MoveList implemented. Choose another Strategy!");
}
//TODO: Backslash kompatibel für Linux
break;
case 4:
//TODO: add Arguments
selectMoveStrategy(car, new PathFollowerMoveStrategy());
break;
}
}
} }
return true; return true;
} else { } else {
userInterface.printInformation("No Trackfile found!"); userInterface.printInformation("No track file found!");
return false; return false;
} }
} }
/** /**
* The functionality was taken out of init to automate testing * creates a PathFollowerMoveStrategy for a specific track and a specific car
* * @param selectedTrack the selected Track
* @param selectedTrack * @param carIndex the Index of the car
* @return the created Movestrategy, null if File not found or invalid
*/ */
Track selectTrack(File selectedTrack) { private MoveStrategy getPathFollowerMoveStrategy(File selectedTrack, int carIndex) {
try { File selectedFile = null;
track = new Track(selectedTrack); MoveStrategy moveStrategy = null;
return track; for (File file : config.getFollowerDirectory().listFiles()) {
} catch (FileNotFoundException | PositionVectorNotValid | InvalidTrackFormatException e) { if (file.toString().equals(config.getFollowerDirectory().toString() + "\\" + selectedTrack.getName().split("\\.")[0] + "_points.txt")) {
e.printStackTrace(); selectedFile = file;
} }
return null; }
if (selectedFile != null) {
try {
moveStrategy = new PathFollowerMoveStrategy(selectedFile, track.getCarPos(carIndex));
} catch (FileNotFoundException e) {
e.printStackTrace();
userInterface.printInformation("There is no Point-List implemented. Choose another Strategy!");
} catch (InvalidFileFormatException e) {
e.printStackTrace();
userInterface.printInformation("Invalid Point-List format. Change Strategy and clean Point-List");
}
} else {
userInterface.printInformation("There is no Point-List implemented. Choose another Strategy!");
}
return moveStrategy;
} }
/** /**
* creates a MoveListStrategy for a specific track and a specific car
* @param selectedTrack the selected Track
* @param carIndex the Index of the car
* @return the created Movestrategy, null if File not found or invalid
*/
private MoveStrategy getMoveListStrategy(File selectedTrack, int carIndex) {
File selectedFile = null;
MoveStrategy moveStrategy = null;
for (File file : config.getMoveDirectory().listFiles()) {
if (file.toString().equals(config.getMoveDirectory().toString() + "\\" + selectedTrack.getName().split("\\.")[0] + "-car-" + track.getCar(carIndex).getID() + ".txt")) {
selectedFile = file;
}
}
if (selectedFile != null) {
try {
moveStrategy = new MoveListStrategy(selectedFile);
} catch (FileNotFoundException e) {
userInterface.printInformation("There is no Move-List implemented. Choose another Strategy!");
e.printStackTrace();
} catch (InvalidFileFormatException e) {
userInterface.printInformation("Invalid Data in Move-List. Choose another Strategy and clean the File");
e.printStackTrace();
}
} else {
userInterface.printInformation("There is no Move-List implemented. Choose another Strategy!");
}
return moveStrategy;
}
/**
* Selects the desired track and returns it.
* The functionality was taken out of init to automate testing.
*
* @param selectedTrack the Track which was selected by user
*/
Track selectTrack(File selectedTrack) throws InvalidTrackFormatException, FileNotFoundException {
track = new Track(selectedTrack);
return track;
}
/**
* Sets a desired move strategy for a desired car.
* The functionality was taken out of init to automate testing * The functionality was taken out of init to automate testing
* *
* @param car to set the MoveStrategy * @param car to set the MoveStrategy
@ -115,7 +168,7 @@ public class Game implements GameSpecification {
} }
/** /**
* Get the id of the specified car. * Gets the id of the specified car.
* *
* @param carIndex The zero-based carIndex number * @param carIndex The zero-based carIndex number
* @return A char containing the id of the car * @return A char containing the id of the car
@ -154,14 +207,14 @@ public class Game implements GameSpecification {
*/ */
@Override @Override
public int getWinner() { public int getWinner() {
if (onlyOneCarLeft()) {
return currentCarIndex;
}
for (int i = 0; i < track.getCarCount(); i++) { for (int i = 0; i < track.getCarCount(); i++) {
if (track.getCar(i).getWinPoints() == 1) { if (track.getCar(i).getWinPoints() == 1) {
return i; return i;
} }
} }
if (onlyOneCarLeft()) {
return currentCarIndex;
}
return NO_WINNER; return NO_WINNER;
} }
@ -188,13 +241,12 @@ public class Game implements GameSpecification {
* <p>The calling method must check the winner state and decide how to go on. If the winner is different * <p>The calling method must check the winner state and decide how to go on. If the winner is different
* than {@link Game#NO_WINNER}, or the current car is already marked as crashed the method returns immediately.</p> * than {@link Game#NO_WINNER}, or the current car is already marked as crashed the method returns immediately.</p>
* *
* @param acceleration A Direction containing the current cars acceleration vector (-1,0,1) in x and y direction * @param acceleration A Direction containing the current car's acceleration vector (-1,0,1) in x and y direction
* for this turn * for this turn
*/ */
@Override @Override
public void doCarTurn(Direction acceleration) throws PositionVectorNotValid { public void doCarTurn(Direction acceleration) {
track.getCar(currentCarIndex).accelerate(acceleration); track.getCar(currentCarIndex).accelerate(acceleration);
PositionVector crashPosition = null; PositionVector crashPosition = null;
List<PositionVector> positionList = calculatePath(track.getCarPos(currentCarIndex), track.getCar(currentCarIndex).nextPosition()); List<PositionVector> positionList = calculatePath(track.getCarPos(currentCarIndex), track.getCar(currentCarIndex).nextPosition());
for (int i = 0; i < positionList.size(); i++) { for (int i = 0; i < positionList.size(); i++) {
@ -207,26 +259,45 @@ public class Game implements GameSpecification {
break; break;
} }
} }
int newWinPoints = track.calculateNewWinPoints(track.getCarPos(currentCarIndex), track.getCar(currentCarIndex).nextPosition());
if (newWinPoints == 1) {
track.getCar(currentCarIndex).increaseWinPoints();
} else if (newWinPoints == -1) {
track.getCar(currentCarIndex).deductWinPoints();
}
if (crashPosition != null) { if (crashPosition != null) {
track.carDoesCrash(currentCarIndex, crashPosition); track.carDoesCrash(currentCarIndex, crashPosition);
} else { } else {
calculateWinner(track.getCarPos(currentCarIndex), track.getCar(currentCarIndex).nextPosition(), currentCarIndex);
track.moveCar(currentCarIndex); track.moveCar(currentCarIndex);
} }
} }
public String gamePhase() throws PositionVectorNotValid { /**
while (carsMoving() && getWinner() == NO_WINNER) { * This method is in charge of changing the players and checking if a winner is found if there is no winner null will be returned.
* If a winner is found the game will return the char of the winning player.
*
* @return the ID of the winning car return null if there is no winner.
*/
public String gamePhase() {
boolean quit = false;
while (carsMoving() && getWinner() == NO_WINNER && !quit) {
userInterface.printInformation("Player " + track.getCar(currentCarIndex).getID() + "'s turn!");
userInterface.printTrack(track); userInterface.printTrack(track);
Direction direction; Direction direction;
direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove(); direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove();
if (direction == null) { if (direction == null) {
if (track.getCar(currentCarIndex).getMoveStrategy() instanceof UserMoveStrategy) {
quit = true;
direction = Direction.NONE;
} else {
track.getCar(currentCarIndex).setMoveStrategy(new DoNotMoveStrategy()); track.getCar(currentCarIndex).setMoveStrategy(new DoNotMoveStrategy());
direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove(); direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove();
} }
}
doCarTurn(direction); doCarTurn(direction);
switchToNextActiveCar(); switchToNextActiveCar();
} }
userInterface.printInformation("The game has finished!");
userInterface.printTrack(track); userInterface.printTrack(track);
int indexWinner = getWinner(); int indexWinner = getWinner();
if (indexWinner == NO_WINNER) { if (indexWinner == NO_WINNER) {
@ -247,7 +318,6 @@ public class Game implements GameSpecification {
currentCarIndex++; currentCarIndex++;
} }
} while (track.getCar(currentCarIndex).isCrashed()); } while (track.getCar(currentCarIndex).isCrashed());
// TODO: evtl andere Kapselung
} }
/** /**
@ -265,104 +335,9 @@ public class Game implements GameSpecification {
*/ */
@Override @Override
public List<PositionVector> calculatePath(PositionVector startPosition, PositionVector endPosition) { public List<PositionVector> calculatePath(PositionVector startPosition, PositionVector endPosition) {
ArrayList<PositionVector> pathList = new ArrayList<>(); return track.calculatePointsOnPath(startPosition, endPosition);
// 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;
}
private void calculateWinner(PositionVector start, PositionVector finish, int carIndex) {
List<PositionVector> path = calculatePath(start, finish);
for (PositionVector point : path) {
if (track.getSpaceType(point) != null) {
switch (track.getSpaceType(point)) {
case FINISH_UP:
if (start.getY() < finish.getY()) {
track.getCar(carIndex).increaseWinPoints();
} else if (start.getY() > finish.getY()) {
track.getCar(carIndex).deductWinPoints();
}
break;
case FINISH_DOWN:
if (start.getY() > finish.getY()) {
track.getCar(carIndex).increaseWinPoints();
} else if (start.getY() < finish.getY()) {
track.getCar(carIndex).deductWinPoints();
}
break;
case FINISH_RIGHT:
if (start.getX() < finish.getX()) {
track.getCar(carIndex).increaseWinPoints();
} else if (start.getX() > finish.getX()) {
track.getCar(carIndex).deductWinPoints();
}
break;
case FINISH_LEFT:
if (start.getX() > finish.getX()) {
track.getCar(carIndex).increaseWinPoints();
} else if (start.getX() < finish.getX()) {
track.getCar(carIndex).increaseWinPoints();
}
break;
}
}
}
}
/** /**
* Does indicate if a car would have a crash with a WALL space or another car at the given position. * Does indicate if a car would have a crash with a WALL space or another car at the given position.
* *
@ -371,10 +346,15 @@ public class Game implements GameSpecification {
* @return A boolean indicator if the car would crash with a WALL or another car. * @return A boolean indicator if the car would crash with a WALL or another car.
*/ */
@Override @Override
public boolean willCarCrash(int carIndex, PositionVector position) throws PositionVectorNotValid { public boolean willCarCrash(int carIndex, PositionVector position) {
return track.willCrashAtPosition(carIndex, position); return track.willCrashAtPosition(carIndex, position);
} }
/**
* Checks if there is just one player left in the game being able to make moves.
*
* @return true if there is just one car left false there are more than one car left in game
*/
public boolean onlyOneCarLeft() { public boolean onlyOneCarLeft() {
int carsLeft = 0; int carsLeft = 0;
for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) { for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) {
@ -385,6 +365,11 @@ public class Game implements GameSpecification {
return !(carsLeft > 1); return !(carsLeft > 1);
} }
/**
* Checks if all cars have implemented the do not move strategy, so the game can determine it will end in a draw.
*
* @return true if all players have implemented do not move false otherwise
*/
public boolean carsMoving() { public boolean carsMoving() {
for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) { for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) {
if (!(track.getCar(carIndex).isCrashed() || track.getCar(carIndex).getMoveStrategy().getClass() == DoNotMoveStrategy.class)) { if (!(track.getCar(carIndex).isCrashed() || track.getCar(carIndex).getMoveStrategy().getClass() == DoNotMoveStrategy.class)) {

View File

@ -1,9 +1,18 @@
package ch.zhaw.pm2.racetrack; package ch.zhaw.pm2.racetrack;
/** /**
* Class for Exception when invalid Fileformat is used. * Class for Exception when an invalid file format is used.
*/ */
public class InvalidFileFormatException extends Exception { public class InvalidFileFormatException extends Exception {
public InvalidFileFormatException() {
super();
}
/**
* Constructor that is used when an error message is given with the exception.
*
* @param errorMessage is the message to be displayed
*/
public InvalidFileFormatException(String errorMessage) { public InvalidFileFormatException(String errorMessage) {
super(errorMessage); super(errorMessage);
} }

View File

@ -4,10 +4,17 @@ package ch.zhaw.pm2.racetrack;
* Class for Exception when invalid track format is used. * Class for Exception when invalid track format is used.
*/ */
public class InvalidTrackFormatException extends Exception { public class InvalidTrackFormatException extends Exception {
public InvalidTrackFormatException(String errorMessage) {
super(errorMessage);
}
public InvalidTrackFormatException() { public InvalidTrackFormatException() {
super(); super();
} }
/**
* Constructor that is used when an error message is given with the exception.
*
* @param errorMessage is the message to be displayed
*/
public InvalidTrackFormatException(String errorMessage) {
super(errorMessage);
}
} }

View File

@ -1,15 +1,26 @@
package ch.zhaw.pm2.racetrack; package ch.zhaw.pm2.racetrack;
import java.io.FileNotFoundException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
/**
* Class containing the main method
*
* @author Roman Schenk
*/
public class Main { public class Main {
/**
public static void main(String[] args) throws InvalidTrackFormatException, PositionVectorNotValid { * Method creating the game and initializing the Configs and Userinterface.
* Starts and initializes a new game until the user decides to stop the game.
* In charge of closing the user interface when user decides to stop the game
*
* @param args no arguments needed
*/
public static void main(String[] args) {
UserInterface userInterface = new UserInterface("Hello and Welcome to Racetrack by Team02-\"AngryNerds\""); UserInterface userInterface = new UserInterface("Hello and Welcome to Racetrack by Team02-\"AngryNerds\"");
Config config = new Config();
while (true) { while (true) {
Game game = new Game(userInterface); Game game = new Game(userInterface, config);
String winner; String winner;
if (game.initPhase()) { if (game.initPhase()) {
winner = game.gamePhase(); winner = game.gamePhase();
@ -17,19 +28,17 @@ public class Main {
optionsNewGame.add("exit"); optionsNewGame.add("exit");
optionsNewGame.add("new game"); optionsNewGame.add("new game");
String winnerText; String winnerText;
if(winner == null){ if (winner == null) {
winnerText = "There was no winner."; winnerText = "There was no winner.";
} } else {
else {
winnerText = "The Winner was Car " + winner; winnerText = "The Winner was Car " + winner;
} }
int selectedOption = userInterface.selectOption(winnerText + "\nStart new Game?", optionsNewGame); int selectedOption = userInterface.selectOption(winnerText + "\nStart new Game?", optionsNewGame);
if(selectedOption == 0) { if (selectedOption == 0) {
userInterface.quit("Thank you and goodbye\npress enter to close the application."); userInterface.quit("Thank you and goodbye\npress enter to close the application.");
break; break;
} }
} } else {
else {
userInterface.quit("The initialisation of the game failed. Press enter to close the application."); userInterface.quit("The initialisation of the game failed. Press enter to close the application.");
break; break;
} }

View File

@ -1,9 +0,0 @@
package ch.zhaw.pm2.racetrack;
public class PositionVectorNotValid extends Throwable {
public PositionVectorNotValid(String message) {
super(message);
}
public PositionVectorNotValid() {}
}

View File

@ -3,7 +3,10 @@ package ch.zhaw.pm2.racetrack;
import ch.zhaw.pm2.racetrack.given.ConfigSpecification; import ch.zhaw.pm2.racetrack.given.ConfigSpecification;
import ch.zhaw.pm2.racetrack.given.TrackSpecification; import ch.zhaw.pm2.racetrack.given.TrackSpecification;
import java.io.*; import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Scanner; import java.util.Scanner;
@ -42,9 +45,9 @@ import java.util.Scanner;
* There are 1 to {@link Config#MAX_CARS} allowed. </li> * There are 1 to {@link Config#MAX_CARS} allowed. </li>
* </ul> * </ul>
* *
* <p>All lines must have the same length, used to initialize the grid width). * <p>All lines must have the same length, used to initialize the grid width.
* Beginning empty lines are skipped. * Beginning empty lines are skipped.
* The the tracks ends with the first empty line or the file end.<br> * The tracks ends with the first empty line or the file end.<br>
* An {@link InvalidTrackFormatException} is thrown, if * An {@link InvalidTrackFormatException} is thrown, if
* <ul> * <ul>
* <li>not all track lines have the same length</li> * <li>not all track lines have the same length</li>
@ -52,24 +55,25 @@ import java.util.Scanner;
* <li>the file contains more than {@link Config#MAX_CARS} cars</li> * <li>the file contains more than {@link Config#MAX_CARS} cars</li>
* </ul> * </ul>
* *
* <p>The Track can return a String representing the current state of the race (including car positons)</p> * <p>The Track can return a String representing the current state of the race (including car positions)</p>
*/ */
public class Track implements TrackSpecification { public class Track implements TrackSpecification {
public static final char CRASH_INDICATOR = 'X'; public static final char CRASH_INDICATOR = 'X';
private List<String> track; private final List<String> track;
private List<Car> cars; private final List<Car> cars;
private final List<PositionVector> finishLine; private final List<PositionVector> finishLine;
private ConfigSpecification.SpaceType finishTyp; private ConfigSpecification.SpaceType finishTyp;
/** /**
* Initialize a Track from the given track file. * Initializes the Track from the given track File including the cars.
* Throws a corresponding error if one of the conditions are not met to build a track.
* *
* @param trackFile Reference to a file containing the track data * @param trackFile Reference to a file containing the track data
* @throws FileNotFoundException if the given track file could not be found * @throws FileNotFoundException if the given track file could not be found
* @throws InvalidTrackFormatException if the track file contains invalid data (no tracklines, ...) * @throws InvalidTrackFormatException if the track file contains invalid data (no track lines, ...)
*/ */
public Track(File trackFile) throws FileNotFoundException, InvalidTrackFormatException, PositionVectorNotValid { public Track(File trackFile) throws FileNotFoundException, InvalidTrackFormatException {
track = new ArrayList<>(); track = new ArrayList<>();
cars = new ArrayList<>(); cars = new ArrayList<>();
finishLine = new ArrayList<>(); finishLine = new ArrayList<>();
@ -85,13 +89,17 @@ public class Track implements TrackSpecification {
* @throws FileNotFoundException if the FilePath is invalid. * @throws FileNotFoundException if the FilePath is invalid.
*/ */
private void readFile(File trackFile) throws FileNotFoundException { private void readFile(File trackFile) throws FileNotFoundException {
Scanner scanner = new Scanner(new FileInputStream(trackFile),"UTF-8"); Scanner scanner = new Scanner(new FileInputStream(trackFile), StandardCharsets.UTF_8);
while (scanner.hasNextLine()) { while (scanner.hasNextLine()) {
track.add(scanner.nextLine()); track.add(scanner.nextLine());
} }
} }
/**
* Goes through the track ArrayList and determines the locations of each car and initializes them at the location.
*
* @throws InvalidTrackFormatException is thrown if a car is found more than once inside the track.
*/
private void addCars() throws InvalidTrackFormatException { private void addCars() throws InvalidTrackFormatException {
ConfigSpecification.SpaceType[] spaceTypes = ConfigSpecification.SpaceType.values(); ConfigSpecification.SpaceType[] spaceTypes = ConfigSpecification.SpaceType.values();
List<Character> allSpaceTypesAsChar = new ArrayList<>(); List<Character> allSpaceTypesAsChar = new ArrayList<>();
@ -101,23 +109,26 @@ public class Track implements TrackSpecification {
allSpaceTypesAsChar.add(spaceType.getValue()); allSpaceTypesAsChar.add(spaceType.getValue());
} }
for (int yPosition = 0; yPosition < track.size(); yPosition++) {
for (int j = 0; j < track.size(); j++) { String line = track.get(yPosition);
String line = track.get(j); for (int xPosition = 0; xPosition < line.length(); xPosition++) {
for (int i = 0; i < line.length(); i++) { char possibleCarChar = line.charAt(xPosition);
char possibleCarChar = line.charAt(i);
if (!allSpaceTypesAsChar.contains(possibleCarChar)) { if (!allSpaceTypesAsChar.contains(possibleCarChar)) {
if (usedSymbolForCar.contains(possibleCarChar)) { if (usedSymbolForCar.contains(possibleCarChar)) {
throw new InvalidTrackFormatException(); throw new InvalidTrackFormatException("More than one car on track!");
} }
usedSymbolForCar.add(possibleCarChar); usedSymbolForCar.add(possibleCarChar);
cars.add(new Car(possibleCarChar, new PositionVector(i, j))); cars.add(new Car(possibleCarChar, new PositionVector(xPosition, yPosition)));
}
} }
} }
} }
} /**
* Determines the finish line and saves it in a list, throws an Exception if none is found.
*
* @throws InvalidTrackFormatException thrown if no finish line is found
*/
private void findFinish() throws InvalidTrackFormatException { private void findFinish() throws InvalidTrackFormatException {
for (int i = 0; i < track.size(); i++) { for (int i = 0; i < track.size(); i++) {
String line = track.get(i); String line = track.get(i);
@ -131,16 +142,22 @@ public class Track implements TrackSpecification {
} }
} }
if (finishLine.size() == 0) { if (finishLine.size() == 0) {
throw new InvalidTrackFormatException(); throw new InvalidTrackFormatException("No finish line found!");
} }
finishTyp = getSpaceType(finishLine.get(0)); finishTyp = getSpaceType(finishLine.get(0));
for (PositionVector positionVector : finishLine) { for (PositionVector positionVector : finishLine) {
if (getSpaceType(positionVector) != finishTyp) { if (getSpaceType(positionVector) != finishTyp) {
throw new InvalidTrackFormatException(); throw new InvalidTrackFormatException("Inconsistent finish line found!");
} }
} }
} }
/**
* Method to find the PositionVector of a chosen character
*
* @param symbol char that we are looking for on the track
* @return the PositionVector of the desired char
*/
private PositionVector findChar(char symbol) { private PositionVector findChar(char symbol) {
PositionVector vector = null; PositionVector vector = null;
for (int i = 0; i < track.size(); i++) { for (int i = 0; i < track.size(); i++) {
@ -154,6 +171,12 @@ public class Track implements TrackSpecification {
return vector; return vector;
} }
/**
* Method that places a character at a chosen position
*
* @param positionVector position where char will be placed
* @param symbol char that should be placed at desired position
*/
private void drawCharOnTrackIndicator(PositionVector positionVector, char symbol) { private void drawCharOnTrackIndicator(PositionVector positionVector, char symbol) {
String line = track.get(positionVector.getY()); String line = track.get(positionVector.getY());
line = line.substring(0, positionVector.getX()) + symbol + line.substring(positionVector.getX() + 1); line = line.substring(0, positionVector.getX()) + symbol + line.substring(positionVector.getX() + 1);
@ -161,30 +184,19 @@ public class Track implements TrackSpecification {
track.add(positionVector.getY(), line); track.add(positionVector.getY(), line);
} }
private void isPositionVectorOnTrack(PositionVector positionVector) throws PositionVectorNotValid {
try{
track.get(positionVector.getY()).charAt(positionVector.getX());
}catch (IndexOutOfBoundsException e) {
throw new PositionVectorNotValid();
}
}
/** /**
* @return all Cars * Method that returns the finish line as a List
*/ *
public List<Car> getCars() { * @return finishLine List
return cars;
}
/**
* @return finishLine
*/ */
public List<PositionVector> getFinishLine() { public List<PositionVector> getFinishLine() {
return finishLine; return finishLine;
} }
/** /**
* @return the track * Returns the whole Track as List of Strings
*
* @return track as List of Strings
*/ */
public List<String> getTrack() { public List<String> getTrack() {
return track; return track;
@ -203,7 +215,7 @@ public class Track implements TrackSpecification {
} }
/** /**
* This class does change the Position of the car only in the track. * This Method does change the Position of the car inside the track object.
* *
* @param carIndex of the current car * @param carIndex of the current car
*/ */
@ -212,9 +224,9 @@ public class Track implements TrackSpecification {
//Removes the Car at Current Pos //Removes the Car at Current Pos
drawCharOnTrackIndicator(carPositionVector, ConfigSpecification.SpaceType.TRACK.getValue()); drawCharOnTrackIndicator(carPositionVector, ConfigSpecification.SpaceType.TRACK.getValue());
//Redraw finishline if Car was on finish-line Position //Redraw finish line if Car was on finish-line Position
for(PositionVector finishLinePositionVector : finishLine){ for (PositionVector finishLinePositionVector : finishLine) {
if(finishLinePositionVector.equals(carPositionVector)){ if (finishLinePositionVector.equals(carPositionVector)) {
drawCharOnTrackIndicator(carPositionVector, finishTyp.getValue()); drawCharOnTrackIndicator(carPositionVector, finishTyp.getValue());
} }
} }
@ -225,13 +237,12 @@ public class Track implements TrackSpecification {
} }
/** /**
* This Method will check if the Car could crash at the specific position * This Method will check if the Car would crash at the specific position
* *
* @param positionVector the position to check if the car could crash * @param positionVector the position to check if the car would crash
* @return true if car would crash. Else false. * @return true if crash otherwise false
*/ */
public boolean willCrashAtPosition(int carIndex, PositionVector positionVector) throws PositionVectorNotValid { public boolean willCrashAtPosition(int carIndex, PositionVector positionVector) {
isPositionVectorOnTrack(positionVector); //TODO: remove this line? Or Method?
char charAtPosition = track.get(positionVector.getY()).charAt(positionVector.getX()); char charAtPosition = track.get(positionVector.getY()).charAt(positionVector.getX());
if (getCarId(carIndex) == charAtPosition) return false; if (getCarId(carIndex) == charAtPosition) return false;
return !(charAtPosition == ConfigSpecification.SpaceType.TRACK.value || return !(charAtPosition == ConfigSpecification.SpaceType.TRACK.value ||
@ -242,13 +253,12 @@ public class Track implements TrackSpecification {
} }
/** /**
* This Method will make the Car Crash. In Track and in the Car Object * This Method will mark the Car as crashed inside the track and the car Object.
* *
* @param carIndex representing current Car * @param carIndex of car that will be marked as crashed
* @param crashPositionVector where the Crash did happen * @param crashPositionVector of the location of the crash
*/ */
public void carDoesCrash(int carIndex, PositionVector crashPositionVector) throws PositionVectorNotValid{ public void carDoesCrash(int carIndex, PositionVector crashPositionVector) {
isPositionVectorOnTrack(crashPositionVector); //TODO: remove this line? and Method?
PositionVector currentCarPosition = getCarPos(carIndex); PositionVector currentCarPosition = getCarPos(carIndex);
drawCharOnTrackIndicator(new PositionVector(currentCarPosition.getX(), currentCarPosition.getY()), ConfigSpecification.SpaceType.TRACK.getValue()); drawCharOnTrackIndicator(new PositionVector(currentCarPosition.getX(), currentCarPosition.getY()), ConfigSpecification.SpaceType.TRACK.getValue());
Car car = cars.get(carIndex); Car car = cars.get(carIndex);
@ -262,11 +272,10 @@ public class Track implements TrackSpecification {
* If the location is outside the track bounds, it is considered a wall. * If the location is outside the track bounds, it is considered a wall.
* *
* @param position The coordinates of the position to examine * @param position The coordinates of the position to examine
* @return The type of track position at the given location * @return The type of space at the desired position
*/ */
@Override @Override
public Config.SpaceType getSpaceType(PositionVector position) { public Config.SpaceType getSpaceType(PositionVector position) {
//isPositionVectorOnTrack(position); Should be used but we are not allowed to change method head. We don't use function anyway
char charAtPosition = track.get(position.getY()).charAt(position.getX()); char charAtPosition = track.get(position.getY()).charAt(position.getX());
ConfigSpecification.SpaceType[] spaceTypes = ConfigSpecification.SpaceType.values(); ConfigSpecification.SpaceType[] spaceTypes = ConfigSpecification.SpaceType.values();
for (ConfigSpecification.SpaceType spaceType : spaceTypes) { for (ConfigSpecification.SpaceType spaceType : spaceTypes) {
@ -275,13 +284,13 @@ public class Track implements TrackSpecification {
} }
} }
return null; return ConfigSpecification.SpaceType.WALL;
} }
/** /**
* Return the number of cars. * Return the number of cars that are located in a track
* *
* @return Number of cars * @return number of cars as int
*/ */
@Override @Override
public int getCarCount() { public int getCarCount() {
@ -338,7 +347,7 @@ public class Track implements TrackSpecification {
* If there is a crashed car at the position, {@link #CRASH_INDICATOR} is returned. * If there is a crashed car at the position, {@link #CRASH_INDICATOR} is returned.
* *
* @param y position Y-value * @param y position Y-value
* @param x position X-vlaue * @param x position X-value
* @param currentSpace char to return if no car is at position (x,y) * @param currentSpace char to return if no car is at position (x,y)
* @return character representing position (x,y) on the track * @return character representing position (x,y) on the track
*/ */
@ -355,6 +364,118 @@ public class Track implements TrackSpecification {
return currentSpace.getValue(); return currentSpace.getValue();
} }
/**
* Determines all points that lie between the two position vectors including the endpoint VectorPosition using the Bresenham algorithm.
*
* @param startPosition PositionVector of the finish coordinate
* @param endPosition PositionVector of the start coordinate
* @return ArrayList containing PositionVectors of all position that are between the start and finish including the finish position.
*/
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;
}
/**
* This method will check if a car is passing the finish line.
* If the car is passing the finish line in the wrong direction, the car will lose a winpoint.
* If the car is passing the finish line in the correct direction, the car will gain a winpoint.
*
* @param start the start position of the car
* @param finish the expected finish position of the car after the move
* @return Number of new winpoints for the current player.
*/
public int calculateNewWinPoints(PositionVector start, PositionVector finish) {
List<PositionVector> path = calculatePointsOnPath(start, finish);
for (PositionVector point : path) {
switch (getSpaceType(point)) {
case FINISH_UP:
if (start.getY() > finish.getY()) {
return 1;
} else if (start.getY() < finish.getY()) {
return -1;
}
break;
case FINISH_DOWN:
if (start.getY() < finish.getY()) {
return 1;
} else if (start.getY() > finish.getY()) {
return -1;
}
break;
case FINISH_RIGHT:
if (start.getX() < finish.getX()) {
return 1;
} else if (start.getX() > finish.getX()) {
return -1;
}
break;
case FINISH_LEFT:
if (start.getX() > finish.getX()) {
return 1;
} else if (start.getX() < finish.getX()) {
return -1;
}
break;
}
}
return 0;
}
/** /**
* Return a String representation of the track, including the car locations. * Return a String representation of the track, including the car locations.
* *

View File

@ -6,24 +6,31 @@ import org.beryx.textio.TextTerminal;
import java.util.List; import java.util.List;
/**
* Class representing the Userinterface.
* Used to get inputs from users via text io.
*
* @author Roman Schenk
*/
public class UserInterface { public class UserInterface {
private final TextIO textIO; private final TextIO textIO;
private final TextTerminal<?> textTerminal; private final TextTerminal<?> textTerminal;
/** /**
* Opens a new Terminal Window and prints the welcome Text * Opens a new Terminal Window and prints the welcome Text.
*
* @param welcomeText The Text which will be printed after the windows is opened. * @param welcomeText The Text which will be printed after the windows is opened.
*/ */
public UserInterface(String welcomeText) { public UserInterface(String welcomeText) {
textIO = TextIoFactory.getTextIO(); textIO = TextIoFactory.getTextIO();
textTerminal = textIO.getTextTerminal(); textTerminal = textIO.getTextTerminal();
textTerminal.println(welcomeText + "\n"); textTerminal.println(welcomeText + "\n");
} }
/** /**
* Prints the given Text in textTerminal * Prints the given Text in textTerminal
*
* @param text The Text which should be printed. * @param text The Text which should be printed.
*/ */
public void printInformation(String text) { public void printInformation(String text) {
@ -31,21 +38,23 @@ public class UserInterface {
} }
/** /**
* asks the user to choose one of the options given. * Method which asks the user to choose one of the options given.
* @param text Text which is printed befor the options are printed. Example: "Select Track file:" *
* @param text Text which is printed before the options are printed. Example: "Select Track file:"
* @param options List with the options which can be selected. * @param options List with the options which can be selected.
* @return the list index of the selected option * @return the list index of the selected option
*/ */
public int selectOption(String text, List<String> options) { public int selectOption(String text, List<String> options) {
textTerminal.println(text + ":"); textTerminal.println(text + ":");
for(int option = 0; option < options.size(); option ++) { for (int option = 0; option < options.size(); option++) {
textTerminal.println(" " + (option + 1) + ": " + options.get(option)); textTerminal.println(" " + (option + 1) + ": " + options.get(option));
} }
return textIO.newIntInputReader().withMinVal(1).withMaxVal(options.size()).read("Enter your choice: ") - 1; return textIO.newIntInputReader().withMinVal(1).withMaxVal(options.size()).read("Enter your choice: ") - 1;
} }
/** /**
* gives information which player's turn it is and asks for the direction to accelerate * Gives information which player is at turn and asks for the direction to accelerate or quit the game.
*
* @param playingCarIndex the index of the player * @param playingCarIndex the index of the player
* @param playingCarID the ID of the player * @param playingCarID the ID of the player
* @return the direction which is selected by the player. If null -> quit game * @return the direction which is selected by the player. If null -> quit game
@ -70,7 +79,8 @@ public class UserInterface {
} }
/** /**
* returns the the associated direction Object * Method which returns the associated direction Object.
*
* @param number the number which was typed by the user * @param number the number which was typed by the user
* @return the associated direction. If null -> unknown number * @return the associated direction. If null -> unknown number
*/ */
@ -90,7 +100,8 @@ public class UserInterface {
} }
/** /**
* prints the given Track in the terminal * Method to print the given Track in the terminal
*
* @param track the track which should be printed * @param track the track which should be printed
*/ */
public void printTrack(Track track) { public void printTrack(Track track) {
@ -98,14 +109,12 @@ public class UserInterface {
} }
/** /**
* Method to dispose the Textterminal * Method to dispose of the Textterminal
* @param text OUtput Text *
* @param text Output Text
*/ */
public void quit(String text){ public void quit(String text) {
textIO.newStringInputReader().withMinLength(0).read(text); textIO.newStringInputReader().withMinLength(0).read(text);
textTerminal.dispose(); textTerminal.dispose();
} }
} }

View File

@ -1,7 +1,6 @@
package ch.zhaw.pm2.racetrack.given; package ch.zhaw.pm2.racetrack.given;
import ch.zhaw.pm2.racetrack.PositionVector; import ch.zhaw.pm2.racetrack.PositionVector;
import ch.zhaw.pm2.racetrack.PositionVectorNotValid;
import java.util.List; import java.util.List;
@ -19,11 +18,11 @@ public interface GameSpecification {
int getWinner(); int getWinner();
void doCarTurn(PositionVector.Direction acceleration) throws PositionVectorNotValid; void doCarTurn(PositionVector.Direction acceleration);
void switchToNextActiveCar(); void switchToNextActiveCar();
List<PositionVector> calculatePath(PositionVector startPosition, PositionVector endPosition); List<PositionVector> calculatePath(PositionVector startPosition, PositionVector endPosition);
boolean willCarCrash(int carIndex, PositionVector position) throws PositionVectorNotValid; boolean willCarCrash(int carIndex, PositionVector position);
} }

View File

@ -5,10 +5,15 @@ import ch.zhaw.pm2.racetrack.PositionVector;
import static ch.zhaw.pm2.racetrack.PositionVector.Direction; import static ch.zhaw.pm2.racetrack.PositionVector.Direction;
/** /**
* Do not accelerate in any direction. * This Class represents the DoNotMoveStrategy.
*/ */
public class DoNotMoveStrategy implements MoveStrategy { public class DoNotMoveStrategy implements MoveStrategy {
/**
* This method will be used to return the next Direction for the car.
*
* @return a NONE Direction
*/
@Override @Override
public Direction nextMove() { public Direction nextMove() {
return PositionVector.Direction.NONE; return PositionVector.Direction.NONE;

View File

@ -1,39 +1,62 @@
package ch.zhaw.pm2.racetrack.strategy; package ch.zhaw.pm2.racetrack.strategy;
import ch.zhaw.pm2.racetrack.InvalidFileFormatException;
import ch.zhaw.pm2.racetrack.PositionVector.Direction; import ch.zhaw.pm2.racetrack.PositionVector.Direction;
import java.io.File; import java.io.File;
import java.io.FileInputStream; import java.io.FileInputStream;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Scanner; import java.util.Scanner;
/**
* This Class represent the MoveListStrategy. The Directions returned by the
* nextMove() are written down in a List.
*/
public class MoveListStrategy implements MoveStrategy { public class MoveListStrategy implements MoveStrategy {
private List<Direction> moveList; private final List<Direction> moveList;
private int pointer; private int pointer;
public MoveListStrategy(String path) throws FileNotFoundException{ public MoveListStrategy(File moveListFile) throws FileNotFoundException, InvalidFileFormatException {
moveList = new ArrayList<>(); moveList = new ArrayList<>();
pointer = -1; pointer = -1;
readFile(new File(path)); readFile(moveListFile);
} }
private void readFile(File trackFile) throws FileNotFoundException { /**
Scanner scanner = new Scanner(new FileInputStream(trackFile), "UTF-8"); * This Method will read in a File and checks line by line if the file contains a valid direction.
* If so the direction will be added to the moveList.
*
* @param trackFile the file to read in the directions
* @throws FileNotFoundException if the file does not exist.
*/
private void readFile(File trackFile) throws FileNotFoundException, InvalidFileFormatException {
Scanner scanner = new Scanner(new FileInputStream(trackFile), StandardCharsets.UTF_8);
Direction[] directions = Direction.values(); Direction[] directions = Direction.values();
while (scanner.hasNextLine()) { while (scanner.hasNextLine()) {
boolean validLine = false;
String line = scanner.nextLine(); String line = scanner.nextLine();
for (Direction dir : directions) { for (Direction direction : directions) {
if (dir.toString().equals(line)) { if (direction.toString().equals(line)) {
moveList.add(dir); moveList.add(direction);
validLine = true;
break; break;
} }
} }
if (!(validLine || line.equals(""))) {
throw new InvalidFileFormatException("The File contains invalid data!");
}
} }
} }
/**
* This method will be used to return the next Direction for the car.
*
* @return the next direction from the list. Returns null if the list is empty.
*/
@Override @Override
public Direction nextMove() { public Direction nextMove() {
pointer += 1; pointer += 1;

View File

@ -0,0 +1,223 @@
package ch.zhaw.pm2.racetrack.strategy;
import ch.zhaw.pm2.racetrack.PositionVector;
import ch.zhaw.pm2.racetrack.Track;
import java.util.ArrayList;
import java.util.List;
/**
* Strategy which calculates the path automatically
*/
public class PathFinderMoveStrategy implements MoveStrategy {
private final Track track;
private final int carIndex;
private List<PositionVector.Direction> moveList;
// the index of the next move in moveList
private int pointer;
// all Directions which can be used for acceleration
private final PositionVector.Direction[] allDirections;
// List of all States (combination of Position and Velocity) which are already reached with a calculated move.
private List<State> calculatedStates;
/**
* Constructor which initialises the needed variables and creates the MoveList
*
* @param track track instance of the game
* @param carIndex index of the car which owns this moveStrategy
*/
public PathFinderMoveStrategy(Track track, int carIndex) {
this.track = track;
this.carIndex = carIndex;
allDirections = PositionVector.Direction.values();
createMoveList();
}
/**
* Method to create a working moveList
*/
private void createMoveList() {
// if Movelist is recreated next move will be the first move in moveList
pointer = 0;
calculatedStates = new ArrayList<>();
PossibleMove finishedMove = null;
List<PossibleMove> possibleMoves = new ArrayList<>();
// create a PossibleMove object for each direction which doesn't end with a crash.
for (PositionVector.Direction direction : allDirections) {
PossibleMove newMove = new PossibleMove(null, direction);
if (!newMove.crashed()) {
possibleMoves.add(newMove);
}
}
// while no PossibleMove crosses the finish line
// every PossibleMove will be accelerated in each direction to find a Move which finishes.
while (finishedMove == null) {
List<PossibleMove> newMoves = new ArrayList<>();
for (PossibleMove previousMove : possibleMoves) {
for (PositionVector.Direction direction : allDirections) {
PossibleMove newMove = new PossibleMove(previousMove, direction);
State newState = new State(newMove.endPosition, newMove.endVelocity);
//only use the new created Possible Move if it doesn't crash, end State isn't in List of calculatedStates
// and if there is no move found yet which is finished.
if (!(newMove.crashed() || alreadyCalculated(newState) || finishedMove != null)) {
if (newMove.finished()) {
finishedMove = newMove;
} else {
calculatedStates.add(newState);
newMoves.add(newMove);
}
}
}
}
possibleMoves = newMoves;
}
// if a finished Move is found save its directions as moveList
moveList = finishedMove.directions;
}
/**
* Method to check if a State is already in List calculatedStates
*
* @param state the State which should be checked
* @return true if it is in List, false if it isn't in List
*/
private boolean alreadyCalculated(State state) {
for (State calculatedState : calculatedStates) {
if (state.equals(calculatedState)) {
return true;
}
}
return false;
}
/**
* Combination of position and velocity
*/
public static class State {
final PositionVector position;
final PositionVector velocity;
/**
* Constructor of State
*
* @param position the PositionVector object with coordinates of the Position
* @param velocity the PositionVector object with coordinates of the Velocity
*/
public State(PositionVector position, PositionVector velocity) {
this.position = position;
this.velocity = velocity;
}
/**
* Checks if a state has the same Position and the same Velocity
*
* @param compareState the State object to compare
* @return true if it is equal, false if it is not equal
*/
public boolean equals(State compareState) {
return compareState.position.equals(position) && compareState.velocity.equals(velocity);
}
}
/**
* PossibleMove represents a move which can be done by the player.
*/
public class PossibleMove {
// List of all directions used for the previous moves and the direction of the current move (the highest Index).
final List<PositionVector.Direction> directions;
// Position of the car bevor the move is executed
final PositionVector startPosition;
// Position of the car after the move is executed
final PositionVector endPosition;
// Velocity of the car after the move is executed
final PositionVector endVelocity;
/**
* Constructor of PossibleMove
*
* @param previousMove The move which must be executed bevor this move can be executed
* @param nextDirection The direction of the move
*/
public PossibleMove(PossibleMove previousMove, PositionVector.Direction nextDirection) {
// Velocity of the car bevor the move is executed
PositionVector startVelocity;
directions = new ArrayList<>();
// check if there was a previousMove.
if (previousMove != null) {
directions.addAll(previousMove.directions); //copy the LIst of Directions from the previousMove
startPosition = previousMove.endPosition; //use the endPosition from previousMove as startPosition
startVelocity = previousMove.endVelocity; //use the endVelocity from previousMove as startVelocity
} else { //if there was no previousMove
startPosition = track.getCarPos(carIndex); //use the current Position of the car from track as startPosition
startVelocity = track.getCar(carIndex).getVelocity(); //use the current Velocity of the car from track as startVelocity
}
directions.add(nextDirection);
endVelocity = new PositionVector(startVelocity.getX() + nextDirection.vector.getX(), startVelocity.getY() + nextDirection.vector.getY());
endPosition = new PositionVector(startPosition.getX() + endVelocity.getX(), startPosition.getY() + endVelocity.getY());
}
/**
* check if the finish line is crossed (in correct direction) if this move is executed
*
* @return true if finish line will be crossed
*/
public boolean finished() {
return track.calculateNewWinPoints(startPosition, endPosition) == 1;
}
/**
* checks if the car will crash or finishline will be crossed in wrong direction if this move is executed
*
* @return true if car will crash
*/
public boolean crashed() {
List<PositionVector> points = track.calculatePointsOnPath(startPosition, endPosition);
for (PositionVector point : points) {
if (track.willCrashAtPosition(carIndex, point)) {
return true;
}
}
return track.calculateNewWinPoints(startPosition, endPosition) == -1;
}
}
/**
* Checks if the next Move in moveList will crash. If no crash next move in moveList will be executed.
* If crash the moveList will be recreated.
*
* @return the direction of acceleration which should be executed.
*/
@Override
public PositionVector.Direction nextMove() {
if (pointer < moveList.size()) {
PositionVector.Direction direction = moveList.get(pointer);
PositionVector currentVelocity = track.getCarVelocity(carIndex);
PositionVector newVelocity = new PositionVector(currentVelocity.getX() + direction.vector.getX(), currentVelocity.getY() + direction.vector.getY());
PositionVector currentPosition = track.getCarPos(carIndex);
PositionVector newPosition = new PositionVector(currentPosition.getX() + newVelocity.getX(), currentPosition.getY() + newVelocity.getY());
for (PositionVector point : track.calculatePointsOnPath(currentPosition, newPosition)) {
if (track.willCrashAtPosition(carIndex, point)) {
createMoveList();
pointer = 0;
direction = moveList.get(pointer);
break;
}
}
pointer += 1;
return direction;
}
return null;
}
}

View File

@ -1,15 +1,133 @@
package ch.zhaw.pm2.racetrack.strategy; package ch.zhaw.pm2.racetrack.strategy;
import ch.zhaw.pm2.racetrack.InvalidFileFormatException;
import ch.zhaw.pm2.racetrack.PositionVector;
import ch.zhaw.pm2.racetrack.PositionVector.Direction; import ch.zhaw.pm2.racetrack.PositionVector.Direction;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Scanner;
/** /**
* The PathFollowerMoveStrategy class determines the next move based on a file containing points on a path. * The PathFollowerMoveStrategy class determines the next move based on a file containing points on a path.
*/ */
public class PathFollowerMoveStrategy implements MoveStrategy { 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 final 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 trackFile 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(File trackFile, PositionVector startPosition) throws FileNotFoundException, InvalidFileFormatException {
pointList = new ArrayList<>();
pointer = 0;
readFile(trackFile);
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, InvalidFileFormatException {
Scanner scanner = new Scanner(new FileInputStream(trackFile), StandardCharsets.UTF_8);
while (scanner.hasNextLine()) {
String line = scanner.nextLine();
String[] coordinates = line.split("(\\(X:|, Y:|\\))");
try {
pointList.add(new PositionVector(Integer.parseInt(coordinates[1]), Integer.parseInt(coordinates[2])));
} catch (NumberFormatException e) {
throw new InvalidFileFormatException("Invalid File Format");
}
}
}
/**
* 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 @Override
public Direction nextMove() { public Direction nextMove() {
// TODO: implementation // if no more points in the list --> return null
throw new UnsupportedOperationException(); 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;
} }
} }

View File

@ -5,11 +5,12 @@ import ch.zhaw.pm2.racetrack.UserInterface;
/** /**
* Let the user decide the next move. * Let the user decide the next move.
* Therefore, it uses the UserInterface class to ask for a direction.
*/ */
public class UserMoveStrategy implements MoveStrategy { public class UserMoveStrategy implements MoveStrategy {
private UserInterface userInterface; private final UserInterface userInterface;
private int carIndex; private final int carIndex;
private char carID; private final char carID;
public UserMoveStrategy(UserInterface userInterface, int carIndex, char carID) { public UserMoveStrategy(UserInterface userInterface, int carIndex, char carID) {
this.userInterface = userInterface; this.userInterface = userInterface;
@ -17,6 +18,11 @@ public class UserMoveStrategy implements MoveStrategy {
this.carID = carID; this.carID = carID;
} }
/**
* Uses the interface to determine which move the user takes.
*
* @return the next taken move as Direction
*/
@Override @Override
public Direction nextMove() { public Direction nextMove() {
return userInterface.selectDirection(carIndex, carID); return userInterface.selectDirection(carIndex, carID);

View File

@ -6,33 +6,38 @@ import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.io.File;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.List; import java.util.List;
import static org.junit.jupiter.api.Assertions.*; import static org.junit.jupiter.api.Assertions.*;
/** /**
* Tests for Class Car * Class that contains all test for the Class Car
*
* @author Roman Schenk
*/ */
class CarTest { class CarTest {
Car car; Car car;
// Default coordinates for tests // Default coordinates for tests
int DEFAULT_X = 10; final int DEFAULT_X = 10;
int DEFAULT_Y = 10; final int DEFAULT_Y = 10;
char DEFAULT_ID = 'f'; final char DEFAULT_ID = 'f';
/** /**
* Create a new Car Object and set Position to a defined Default Position * Creates a new Car Object and set Position to a defined Default Position
*/ */
@BeforeEach @BeforeEach
void setUp() { void setUp() {
car = new Car(DEFAULT_ID, new PositionVector(DEFAULT_X, DEFAULT_Y)); car = new Car(DEFAULT_ID, new PositionVector(DEFAULT_X, DEFAULT_Y));
} }
/**
* Checks if the method getID returns the correct value
*/
@Test @Test
void getID() { void getID() {
assertEquals(DEFAULT_ID, car.getID()); assertEquals(DEFAULT_ID, car.getID());
@ -49,8 +54,8 @@ class CarTest {
} }
/** /**
* - checks if the position of the car can be set and saved correctly with valid positions. * Checks if the position of the car can be set and saved correctly with valid positions.
* - checks if an exception is throwed and position keeps unchanged if invalid coordinates are entered. * Checks if an exception is thrown and position kept unchanged if invalid coordinates are entered.
*/ */
@Test @Test
void setPosition() { void setPosition() {
@ -101,14 +106,13 @@ class CarTest {
@Test @Test
void movement() { void movement() {
// add all possible directions in a List // add all possible directions in a List
List<PositionVector.Direction> directions = Arrays.asList(PositionVector.Direction.values()); PositionVector.Direction[] directions = PositionVector.Direction.values();
//position shouldn't be changed because velocity should be 0. //position shouldn't be changed because velocity should be 0.
car.move(); car.move();
checkNextPosition(DEFAULT_X, DEFAULT_Y); checkNextPosition(DEFAULT_X, DEFAULT_Y);
for (PositionVector.Direction direction1 : directions) { for (PositionVector.Direction direction1 : directions) {
for (PositionVector.Direction direction2 : directions) { for (PositionVector.Direction direction2 : directions) {
@ -119,7 +123,7 @@ class CarTest {
int expectedNextPosX = DEFAULT_X; int expectedNextPosX = DEFAULT_X;
int expectedNextPosY = DEFAULT_Y; int expectedNextPosY = DEFAULT_Y;
//variables to save the acutal expected result of method getVelocity //variables to save the actual expected result of method getVelocity
int expectedVelocityX = 0; int expectedVelocityX = 0;
int expectedVelocityY = 0; int expectedVelocityY = 0;
@ -157,7 +161,8 @@ class CarTest {
/** /**
* test for methods crash and isCrashed. checks if state crashed is set and returned correctly. * Test for methods crash and isCrashed.
* Checks if state crashed is set and returned correctly.
*/ */
@Test @Test
void crash() { void crash() {
@ -167,8 +172,8 @@ class CarTest {
} }
/** /**
* test for methods setMoveStrategy. Checks if the MoveStrategy Object is saved and returned correctly * Test for methods setMoveStrategy.
* with all Types of MoveStrategy. * Checks if the MoveStrategy Object is saved and returned correctly with all Types of MoveStrategy.
*/ */
@Test @Test
void MoveStrategy() { void MoveStrategy() {
@ -179,46 +184,50 @@ class CarTest {
assertEquals(moveStrategy, car.getMoveStrategy()); assertEquals(moveStrategy, car.getMoveStrategy());
try { try {
moveStrategy = new MoveListStrategy(".\\moves\\challenge-car-a.txt"); moveStrategy = new MoveListStrategy(new File(".\\moves\\challenge-car-a.txt"));
} catch (FileNotFoundException e) { } catch (FileNotFoundException | InvalidFileFormatException e) {
Assertions.fail(); Assertions.fail();
} }
car.setMoveStrategy(moveStrategy); car.setMoveStrategy(moveStrategy);
assertEquals(moveStrategy, car.getMoveStrategy()); assertEquals(moveStrategy, car.getMoveStrategy());
moveStrategy = new PathFollowerMoveStrategy(); try {
moveStrategy = new PathFollowerMoveStrategy(new File(".\\follower\\challenge_points.txt"), new PositionVector(0, 0));
} catch (FileNotFoundException | InvalidFileFormatException e) {
e.printStackTrace();
}
car.setMoveStrategy(moveStrategy); car.setMoveStrategy(moveStrategy);
assertEquals(moveStrategy, car.getMoveStrategy()); assertEquals(moveStrategy, car.getMoveStrategy());
moveStrategy = new UserMoveStrategy(new UserInterface("Hello"),0,'a'); moveStrategy = new UserMoveStrategy(new UserInterface("Hello"), 0, 'a');
car.setMoveStrategy(moveStrategy); car.setMoveStrategy(moveStrategy);
assertEquals(moveStrategy, car.getMoveStrategy()); assertEquals(moveStrategy, car.getMoveStrategy());
} }
/** /**
* Test for get WinPoints * Tests if getWinPoints returns the correct value.
*/ */
@Test @Test
void getWinPoints() { void getWinPoints() {
assertEquals(0,car.getWinPoints()); assertEquals(0, car.getWinPoints());
} }
/** /**
* Test for increase WinPoints * Tests if winpoints increase functions properly.
*/ */
@Test @Test
void increaseWinPoints() { void increaseWinPoints() {
car.increaseWinPoints(); car.increaseWinPoints();
assertEquals(1,car.getWinPoints()); assertEquals(1, car.getWinPoints());
} }
/** /**
* Test for deduct WinPoints * Tests if the deductions of winpoints functions properly.
*/ */
@Test @Test
void deductWinPoints() { void deductWinPoints() {
car.deductWinPoints(); car.deductWinPoints();
assertEquals(-1,car.getWinPoints()); assertEquals(-1, car.getWinPoints());
} }
} }

View File

@ -1,46 +1,58 @@
package ch.zhaw.pm2.racetrack; package ch.zhaw.pm2.racetrack;
import ch.zhaw.pm2.racetrack.strategy.UserMoveStrategy; import ch.zhaw.pm2.racetrack.strategy.UserMoveStrategy;
import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.*;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Assertions;
import java.io.File; import java.io.File;
import java.io.FileNotFoundException;
import java.util.List; import java.util.List;
import static ch.zhaw.pm2.racetrack.Game.NO_WINNER; import static ch.zhaw.pm2.racetrack.Game.NO_WINNER;
import static ch.zhaw.pm2.racetrack.PositionVector.Direction.*; import static ch.zhaw.pm2.racetrack.PositionVector.Direction.*;
/** /**
* Test for Class Game * Test for Class Game. The Class is split up in nested classes.
*
* @author Andrin Fassbind
*/ */
class GameTest { class GameTest {
private UserInterface userInterface; private UserInterface userInterface;
private Game game; private Game game;
private Track track; private Track track;
private String TRACK_FILE_PATH = ".\\tracks\\challenge.txt"; private final String TRACK_FILE_PATH = ".\\tracks\\challenge.txt";
private int CAR_INDEX_ONE = 0; private final int CAR_INDEX_ONE = 0;
private int CAR_INDEX_TWO = 1; private final int CAR_INDEX_TWO = 1;
/** /**
* This nested Class tests if the game gets initiatet correctly * This nested Class tests if the game gets initiated correctly.
*/ */
@Nested @Nested
@DisplayName("Test correct Setup") @DisplayName("Test correct Setup")
class Setup { class Setup {
/**
* Sets up getting the Config, Game and Userinterface for the following tests.
*/
@BeforeEach @BeforeEach
void setup() { void setup() {
userInterface = new UserInterface("Test"); userInterface = new UserInterface("Test");
game = new Game(userInterface); Config config = new Config();
game = new Game(userInterface, config);
try {
track = game.selectTrack(new File(TRACK_FILE_PATH)); track = game.selectTrack(new File(TRACK_FILE_PATH));
} catch (InvalidTrackFormatException | FileNotFoundException e) {
e.printStackTrace();
Assertions.fail();
}
game.selectMoveStrategy(track.getCar(CAR_INDEX_ONE), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_ONE, track.getCarId(CAR_INDEX_ONE))); game.selectMoveStrategy(track.getCar(CAR_INDEX_ONE), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_ONE, track.getCarId(CAR_INDEX_ONE)));
game.selectMoveStrategy(track.getCar(CAR_INDEX_TWO), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_TWO, track.getCarId(CAR_INDEX_TWO))); game.selectMoveStrategy(track.getCar(CAR_INDEX_TWO), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_TWO, track.getCarId(CAR_INDEX_TWO)));
} }
/**
* Tests if car index is correct
*/
@Test @Test
void getCurrentCarIndex() { void getCurrentCarIndex() {
Assertions.assertEquals(CAR_INDEX_ONE, game.getCurrentCarIndex()); Assertions.assertEquals(CAR_INDEX_ONE, game.getCurrentCarIndex());
@ -48,34 +60,52 @@ class GameTest {
Assertions.assertEquals(CAR_INDEX_TWO, game.getCurrentCarIndex()); Assertions.assertEquals(CAR_INDEX_TWO, game.getCurrentCarIndex());
} }
/**
* Checks if CarId matches char given in track file
*/
@Test @Test
void getCarId() { void getCarId() {
Assertions.assertEquals('a', game.getCarId(0)); Assertions.assertEquals('a', game.getCarId(0));
Assertions.assertEquals('b', game.getCarId(1)); Assertions.assertEquals('b', game.getCarId(1));
} }
/**
* Checks initial car position
*/
@Test @Test
void getCarPosition() { void getCarPosition() {
Assertions.assertEquals(new PositionVector(24, 22), game.getCarPosition(0)); Assertions.assertEquals(new PositionVector(24, 22), game.getCarPosition(0));
Assertions.assertEquals(new PositionVector(24, 24), game.getCarPosition(1)); Assertions.assertEquals(new PositionVector(24, 24), game.getCarPosition(1));
} }
/**
* Checks if initial car velocity is 0,0
*/
@Test @Test
void getCarVelocity() { void getCarVelocity() {
Assertions.assertEquals(new PositionVector(0, 0), game.getCarVelocity(0)); Assertions.assertEquals(new PositionVector(0, 0), game.getCarVelocity(0));
Assertions.assertEquals(new PositionVector(0, 0), game.getCarVelocity(1)); Assertions.assertEquals(new PositionVector(0, 0), game.getCarVelocity(1));
} }
/**
* Checks initial winner
*/
@Test @Test
void getWinner() { void getWinner() {
Assertions.assertEquals(NO_WINNER, game.getWinner()); Assertions.assertEquals(NO_WINNER, game.getWinner());
} }
/**
* Checks correct initial state
*/
@Test @Test
void onlyOneCarLeft() { void onlyOneCarLeft() {
Assertions.assertFalse(game.onlyOneCarLeft()); Assertions.assertFalse(game.onlyOneCarLeft());
} }
/**
* Checks if cars are able to move
*/
@Test @Test
void carsMoving() { void carsMoving() {
Assertions.assertTrue(game.carsMoving()); Assertions.assertTrue(game.carsMoving());
@ -92,45 +122,53 @@ class GameTest {
@BeforeEach @BeforeEach
void setup() { void setup() {
userInterface = new UserInterface("Test"); userInterface = new UserInterface("Test");
game = new Game(userInterface); Config config = new Config();
game = new Game(userInterface, config);
try {
track = game.selectTrack(new File(TRACK_FILE_PATH)); track = game.selectTrack(new File(TRACK_FILE_PATH));
} catch (InvalidTrackFormatException | FileNotFoundException e) {
e.printStackTrace();
Assertions.fail();
}
game.selectMoveStrategy(track.getCar(CAR_INDEX_ONE), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_ONE, track.getCarId(CAR_INDEX_ONE))); game.selectMoveStrategy(track.getCar(CAR_INDEX_ONE), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_ONE, track.getCarId(CAR_INDEX_ONE)));
game.selectMoveStrategy(track.getCar(CAR_INDEX_TWO), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_TWO, track.getCarId(CAR_INDEX_TWO))); game.selectMoveStrategy(track.getCar(CAR_INDEX_TWO), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_TWO, track.getCarId(CAR_INDEX_TWO)));
} }
/**
* Checks if car does change velocity specified by direction input
*/
@Test @Test
void carTurnCorrect() { void carTurnCorrect() {
try {
game.doCarTurn(RIGHT); game.doCarTurn(RIGHT);
Assertions.assertEquals(new PositionVector(1, 0), game.getCarVelocity(0)); Assertions.assertEquals(new PositionVector(1, 0), game.getCarVelocity(0));
} catch (PositionVectorNotValid positionVectorNotValid) {
positionVectorNotValid.printStackTrace();
}
} }
/**
* Checks if car crash is set if a car crashes.
*/
@Test @Test
void carCrash() { void carCrash() {
try {
game.doCarTurn(PositionVector.Direction.UP); game.doCarTurn(PositionVector.Direction.UP);
Assertions.assertTrue(game.onlyOneCarLeft()); Assertions.assertTrue(game.onlyOneCarLeft());
} catch (PositionVectorNotValid positionVectorNotValid) {
positionVectorNotValid.printStackTrace();
}
} }
} }
/** /**
* This nested Class tests a Playtrough. And implements a UserInterface interagtion to pretend a real player * This nested Class tests a play trough and implements a userInterface which pretends to be a real player.
* At the end of every Test the user interface stays open for 10 more sec to visualize the game.
*/ */
@Nested @Nested
@DisplayName("Playtrough") @DisplayName("Playtrough")
class Play { class Play {
private Game game; private Game game;
/**
* This method will start a game instance on the challenge track. Car a uses MoveListStrategy. Car b uses DoNotMoveStrategy
*/
@Test @Test
void winner() { void winner() {
game = new Game(new interFace("Test",new Integer[]{0,2,1},new PositionVector.Direction[]{RIGHT, game = new Game(new Interface("Test",new Integer[]{0,2,0},new PositionVector.Direction[]{RIGHT,
RIGHT, RIGHT,
RIGHT, RIGHT,
NONE, NONE,
@ -168,43 +206,75 @@ class GameTest {
UP_RIGHT, UP_RIGHT,
UP_RIGHT, UP_RIGHT,
RIGHT, RIGHT,
RIGHT})); RIGHT}), new Config());
try {
game.initPhase(); game.initPhase();
Assertions.assertEquals("a",game.gamePhase()); Assertions.assertEquals("a",game.gamePhase());
} catch (InvalidTrackFormatException | PositionVectorNotValid e) {
e.printStackTrace();
}
} }
/**
* Will start a game instance where car a does crash.
*/
@Test @Test
void crashA() { void crashA() {
game = new Game(new interFace("Test",new Integer[]{0,2,2},new PositionVector.Direction[]{UP})); game = new Game(new Interface("Test",new Integer[]{0,1,0},new PositionVector.Direction[]{UP}), new Config());
try {
game.initPhase(); game.initPhase();
Assertions.assertEquals("b",game.gamePhase()); Assertions.assertEquals("b",game.gamePhase());
} catch (InvalidTrackFormatException | PositionVectorNotValid e) { }
/**
* Checks that a car cant win before finishing a complete round around the track.
*/
@Test
void passFinishLineInWrongDirection() {
game = new Game(new Interface("Test",new Integer[]{1,0,1},new PositionVector.Direction[]{LEFT,NONE,NONE,RIGHT,RIGHT}), new Config());
game.initPhase();
Assertions.assertEquals("a",game.gamePhase());
}
/**
* Does wait 10 seconds before closing the textio.
*/
@AfterEach
void cleanUp() {
try {
Thread.sleep(10000);
} catch (InterruptedException e) {
e.printStackTrace(); e.printStackTrace();
} }
} }
} }
private class interFace extends UserInterface { /**
* This Class is used to communicate with the UserInterface. It overrides crucial methods and returns an instruction based on the instructions' data field.
* To implement the right instructions the user has to be aware of the game sequence.
*/
private class Interface extends UserInterface {
private final PositionVector.Direction[] directions; private final PositionVector.Direction[] directions;
private final Integer[] instructions; private final Integer[] instructions;
private int pointerDir,pointerInstruction; private int pointerDir,pointerInstruction;
/**
public interFace(String welcometxt, Integer[] instructions, PositionVector.Direction[] directions) { * Constructor to create a new Interface Object
super(welcometxt); * @param welcometext The first Text which will be printed in the UserInterface Window
* @param instructions list of instructions to simulate userinput
* @param directions list of Directions to simulate userinput
*/
public Interface(String welcometext, Integer[] instructions, PositionVector.Direction[] directions) {
super(welcometext);
pointerDir = -1; pointerDir = -1;
pointerInstruction = -1; pointerInstruction = -1;
this.instructions = instructions; this.instructions = instructions;
this.directions = directions; this.directions = directions;
} }
/**
* Overwriting Method for testing without userinteraction
* @param text Text which is printed before the options are printed. Example: "Select Track file:"
* @param options List with the options which can be selected.
* @return the selected Option
*/
@Override @Override
public int selectOption(String text, List<String> options) { public int selectOption(String text, List<String> options) {
pointerInstruction++; pointerInstruction++;
@ -212,15 +282,29 @@ class GameTest {
} }
/**
* Overwriting Method for testing without userinteraction
* @param text The Text which should be printed.
*/
@Override
public void printInformation(String text) { public void printInformation(String text) {
} }
public void printTrack(Track track) { /**
} * Overwriting Method for testing without userinteraction
* @param text Output Text
*/
@Override
public void quit(String text) { public void quit(String text) {
} }
/**
* Overwriting Method for testing without userinteraction
* @param playingCarIndex the index of the player
* @param playingCarID the ID of the player
* @return the direction to accelerate
*/
@Override
public PositionVector.Direction selectDirection(int playingCarIndex, char playingCarID) { public PositionVector.Direction selectDirection(int playingCarIndex, char playingCarID) {
pointerDir += 1; pointerDir += 1;
if(pointerDir < directions.length) { if(pointerDir < directions.length) {

View File

@ -4,26 +4,38 @@ import ch.zhaw.pm2.racetrack.strategy.MoveListStrategy;
import ch.zhaw.pm2.racetrack.strategy.MoveStrategy; import ch.zhaw.pm2.racetrack.strategy.MoveStrategy;
import org.junit.jupiter.api.*; import org.junit.jupiter.api.*;
import java.io.File;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
public class MoveStrategyTest { /**
* This Class tests the MoveStrategy.
*
* @author Andrin Fassbind
*/
public class MoveListStrategyTest {
private MoveStrategy moveList; private MoveStrategy moveList;
@Nested @Nested
@DisplayName("MoveListStrategy") @DisplayName("MoveListStrategy")
class MoveList { class MoveList {
/**
* Creates a new MoveListStrategy
*/
@BeforeEach @BeforeEach
void setup() { void setup() {
try { try {
moveList = new MoveListStrategy(".\\moves\\challenge-car-a.txt"); moveList = new MoveListStrategy(new File(".\\moves\\challenge-car-a.txt"));
}catch (FileNotFoundException e) { }catch (FileNotFoundException | InvalidFileFormatException e) {
e.printStackTrace(); e.printStackTrace();
} }
} }
/**
* Checks if the directions are returned correct by method nextMove
*/
@Test @Test
void checkMove() { void checkMove() {
Assertions.assertEquals(PositionVector.Direction.RIGHT,moveList.nextMove()); Assertions.assertEquals(PositionVector.Direction.RIGHT,moveList.nextMove());

View File

@ -2,37 +2,50 @@ package ch.zhaw.pm2.racetrack;
import ch.zhaw.pm2.racetrack.given.ConfigSpecification; import ch.zhaw.pm2.racetrack.given.ConfigSpecification;
import org.junit.jupiter.api.*; import org.junit.jupiter.api.*;
import java.io.File; import java.io.File;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
/**
* This Class tests the track
*
* @author Andrin Fassbind
*/
public class TrackTest { public class TrackTest {
Track trackObj; Track trackObj;
@Nested @Nested
@DisplayName("Positiv Test Cases") @DisplayName("Positive Test Cases")
class positivClass { class positiveClass {
/**
* Sets up the Test cases by loading the file and setting a new track.
*/
@BeforeEach @BeforeEach
void setup() { void setup() {
File file = new File(".\\tracks\\challenge.txt"); File file = new File(".\\tracks\\challenge.txt");
try { try {
trackObj = new Track(file); trackObj = new Track(file);
} catch (FileNotFoundException | InvalidTrackFormatException e) {
} catch (Exception | PositionVectorNotValid e) { e.printStackTrace();
System.err.println("Error in Test compareTrack" + e.getMessage()); Assertions.fail();
}
} }
}
/**
* Checks if correct amount of cars has been instantiated
*/
@Test @Test
@DisplayName("Create correct amount of Car instance") @DisplayName("Create correct amount of Car instance")
void checkCars() { void checkCars() {
Assertions.assertEquals(2, trackObj.getCarCount()); Assertions.assertEquals(2, trackObj.getCarCount());
} }
/**
* Checks if car id matches track file symbol
*/
@Test @Test
@DisplayName("Create Car instance with correct Symbols / Id") @DisplayName("Create Car instance with correct Symbols / Id")
void checkCarId() { void checkCarId() {
@ -40,13 +53,18 @@ public class TrackTest {
Assertions.assertEquals('b', trackObj.getCarId(1)); Assertions.assertEquals('b', trackObj.getCarId(1));
} }
/**
* checks if track reads space typ from track file correctly
*/
@Test @Test
@DisplayName("Check getSpaceTyp") @DisplayName("Check getSpaceTyp")
void getSpaceTyp() { void getSpaceTyp() {
Assertions.assertEquals(ConfigSpecification.SpaceType.FINISH_RIGHT, trackObj.getSpaceType(new PositionVector(22, 24))); Assertions.assertEquals(ConfigSpecification.SpaceType.FINISH_RIGHT, trackObj.getSpaceType(new PositionVector(22, 24)));
} }
/**
* checks if track finds the finish line at the correct positions
*/
@Test @Test
@DisplayName("Find FinishLine") @DisplayName("Find FinishLine")
void findFinish() { void findFinish() {
@ -57,8 +75,11 @@ public class TrackTest {
Assertions.assertEquals(expected, trackObj.getFinishLine()); Assertions.assertEquals(expected, trackObj.getFinishLine());
} }
/**
* Checks if track does read in track file correctly
*/
@Test @Test
@DisplayName("Converts Trackfile correctly to List<String>") @DisplayName("Converts track file correctly to List<String>")
void checkTrack() { void checkTrack() {
Track trackObj; Track trackObj;
try { try {
@ -79,11 +100,14 @@ public class TrackTest {
track.add("##################################################"); track.add("##################################################");
track.add("##################################################"); track.add("##################################################");
Assertions.assertLinesMatch(track, trackObj.getTrack()); Assertions.assertLinesMatch(track, trackObj.getTrack());
} catch (FileNotFoundException | InvalidTrackFormatException | PositionVectorNotValid e) { } catch (FileNotFoundException | InvalidTrackFormatException e) {
e.printStackTrace(); e.printStackTrace();
} }
} }
/**
* checks if track does process car move correctly
*/
@Test @Test
@DisplayName("Make Car move down on track") @DisplayName("Make Car move down on track")
void makeCarMoveDown() { void makeCarMoveDown() {
@ -95,6 +119,9 @@ public class TrackTest {
Assertions.assertEquals(beforeMove.getX(), afterMove.getX()); Assertions.assertEquals(beforeMove.getX(), afterMove.getX());
} }
/**
* Checks if car does not move if there is no acceleration
*/
@Test @Test
@DisplayName("Make Car move with (0,0) acceleration on track") @DisplayName("Make Car move with (0,0) acceleration on track")
void makeCarStay() { void makeCarStay() {
@ -105,52 +132,58 @@ public class TrackTest {
Assertions.assertEquals(beforeMove.getX(), afterMove.getX()); Assertions.assertEquals(beforeMove.getX(), afterMove.getX());
} }
/**
* Checks if car does crash
*/
@Test @Test
@DisplayName("Will Car Crash") @DisplayName("Will Car Crash")
void willCarCrash() { void willCarCrash() {
try {
//Car will Crash //Car will Crash
Assertions.assertTrue(trackObj.willCrashAtPosition(0, new PositionVector(25, 21))); Assertions.assertTrue(trackObj.willCrashAtPosition(0, new PositionVector(25, 21)));
//Car will not Crash and is on track //Car will not Crash and is on track
Assertions.assertFalse(trackObj.willCrashAtPosition(0, new PositionVector(7, 22))); Assertions.assertFalse(trackObj.willCrashAtPosition(0, new PositionVector(7, 22)));
//Car will not Crash and is on finishLine //Car will not Crash and is on finishLine
Assertions.assertFalse(trackObj.willCrashAtPosition(0, trackObj.getFinishLine().get(0))); Assertions.assertFalse(trackObj.willCrashAtPosition(0, trackObj.getFinishLine().get(0)));
} catch (PositionVectorNotValid positionVectorNotValid) {
positionVectorNotValid.printStackTrace();
Assertions.fail("Test should not throw error");
}
} }
/**
* checks if track is updated after car crash
*/
@Test @Test
@DisplayName("Make Car Crash") @DisplayName("Make Car Crash")
void makeCarCrash() { void makeCarCrash() {
try {
trackObj.carDoesCrash(0, new PositionVector(6, 22)); trackObj.carDoesCrash(0, new PositionVector(6, 22));
} catch (PositionVectorNotValid positionVectorNotValid) {
positionVectorNotValid.printStackTrace();
Assertions.fail("Test should not throw exception");
}
Assertions.assertEquals(Track.CRASH_INDICATOR, trackObj.getTrack().get(22).charAt(6)); Assertions.assertEquals(Track.CRASH_INDICATOR, trackObj.getTrack().get(22).charAt(6));
Assertions.assertTrue(trackObj.getCar(0).isCrashed()); Assertions.assertTrue(trackObj.getCar(0).isCrashed());
} }
} }
/**
* This testcase does check for negative test cases
*/
@Nested @Nested
@DisplayName("Negative TestCase") @DisplayName("Negative TestCase")
class negativeClass { class negativeClass {
File file; File file;
/**
* Sets up the negative Test cases by loading the file and setting a new track.
*/
@BeforeEach @BeforeEach
void setup() { void setup() {
file = new File(".\\tracks\\challenge.txt"); file = new File(".\\tracks\\challenge.txt");
try { try {
trackObj = new Track(file); trackObj = new Track(file);
} catch (Exception | PositionVectorNotValid e) { } catch (InvalidTrackFormatException | FileNotFoundException e) {
System.err.println("Error in Test compareTrack" + e.getMessage()); System.err.println("Error in Test compareTrack" + e.getMessage());
} }
} }
/**
* Tries to read not valid file
*/
@Test @Test
@DisplayName("Throw error if File not found") @DisplayName("Throw error if File not found")
void canReadFile() { void canReadFile() {
@ -158,20 +191,14 @@ public class TrackTest {
Assertions.assertThrows(FileNotFoundException.class, () -> new Track(file)); Assertions.assertThrows(FileNotFoundException.class, () -> new Track(file));
} }
/**
* Tries to read not valid file with 2 cars with same symbol
*/
@Test @Test
@DisplayName("Throw error if File is invalid") @DisplayName("Throw error if File is invalid")
void invalidTrackFile() { void invalidTrackFile() {
File testfile = new File(".\\src\\test\\InvalidTracks\\sameCar.txt"); File testFile = new File(".\\src\\test\\InvalidTracks\\sameCar.txt");
Assertions.assertThrows(InvalidTrackFormatException.class, () -> new Track(testfile)); Assertions.assertThrows(InvalidTrackFormatException.class, () -> new Track(testFile));
} }
@Test
@DisplayName("Invalid Position Vector used")
void invalidPositionVector() {
Assertions.assertThrows(PositionVectorNotValid.class, () -> trackObj.willCrashAtPosition(0, new PositionVector(100, 200)));
Assertions.assertThrows(PositionVectorNotValid.class, () -> trackObj.carDoesCrash(1,new PositionVector(200,100)));
} }
}
} }