Merge pull request #168 from Longwater1234/dev

Now clicked cell is also highlighted

Author: Longwater1234

TODO.md

@@ -2,7 +2,7 @@
 
 - [ ] (Online mode) Display countdown timer (40 s), waiting for player's move. Reset it when they make a move.
 - [ ] Record and list all previous moves and captures (for current match), in a scroll panel.
-- [ ] highlight cell color blue after clicking a piece, reset when click srcCell = null
+- [x] highlight cell color blue after clicking a piece, reset when click srcCell = null
 - [ ] write unit tests using googletests
 
 ### (Extras) Standard CJK font paths

src/Cell.hpp

@@ -14,43 +14,46 @@ namespace chk
 class Cell final : public sf::Drawable
 {
   public:
-    explicit Cell(int idx, const sf::RectangleShape &rec, const sf::Vector2f &pos, const sf::Font &font);
+    explicit Cell(int idx, const sf::RectangleShape &rec, const sf::Font &font);
     Cell() = delete;
     Cell &operator=(const Cell &) = delete;
     Cell(const Cell &) = delete;
     bool containsPoint(const sf::Vector2i &pos) const;
     bool isAtPosition(const sf::Vector2f &pos) const;
     const sf::Vector2f &getPos() const;
     int getIndex() const;
-    void setEvenRow(bool is_even);
+    void setEvenRow(bool val);
     bool getIsEvenRow() const;
+    void highlightActive();
+    void resetColor();
 
   private:
     sf::RectangleShape rec;
-    int index; // Darker cells have index in range [1~32]. Lighter cells are all -1
+    sf::Color DARK_BROWN = sf::Color{82, 55, 27};
+    sf::Color BABY_BLUE = sf::Color{98, 174, 239};
+    int index = -1; // Darker cells have index in range [1~32]. Lighter cells are all -1
     bool isEvenRow = false;
     sf::Vector2f cell_pos;
     sf::Text sfText;
     void draw(sf::RenderTarget &target, sf::RenderStates states) const override;
 };
 
-inline Cell::Cell(const int idx, const sf::RectangleShape &rect, const sf::Vector2f &pos, const sf::Font &font)
+inline Cell::Cell(const int idx, const sf::RectangleShape &rect, const sf::Font &font)
 {
     this->rec = rect;
     this->index = idx;
-    this->cell_pos = pos;
+    this->cell_pos = rec.getPosition();
 
     sf::Text text;
     text.setFont(font);
     text.setFillColor(sf::Color{255, 255, 255, 100});
     text.setString(std::to_string(this->index));
-    text.setPosition(pos);
+    text.setPosition(this->cell_pos);
     this->sfText = text;
 }
 
 inline void Cell::draw(sf::RenderTarget &target, sf::RenderStates states) const
 {
-
     target.draw(rec, states);
     if (this->index != -1)
     {
@@ -69,7 +72,8 @@ inline bool Cell::getIsEvenRow() const
 }
 
 /**
- * Check whether mouse cursor is anywhere within this Cell region
+ * Check whether mouse cursor is anywhere INSIDE this Cell region
+ *
  * @param pos position x,y (int) relative to main Window
  * @return TRUE or FALSE
  */
@@ -80,6 +84,7 @@ inline bool Cell::containsPoint(const sf::Vector2i &pos) const
 
 /**
  * Check whether given object's position is EQUAL to this Cell's position
+ *
  * @param pos position x,y (float) relative to main window
  * @return TRUE or FALSE
  */
@@ -99,11 +104,11 @@ inline int Cell::getIndex() const
 
 /**
  * Set whether this cell's row is even
- * @param is_even TRUE or FALSE
+ * @param val TRUE or FALSE
  */
-inline void Cell::setEvenRow(bool is_even)
+inline void Cell::setEvenRow(bool val)
 {
-    this->isEvenRow = is_even;
+    this->isEvenRow = val;
 }
 
 /**
@@ -115,4 +120,20 @@ const inline sf::Vector2f &Cell::getPos() const
     return this->cell_pos;
 }
 
+/**
+ * (ONLY FOR PLAYABLE CELLS) Highlight the currently clicked cell with a piece with BLUE
+ */
+inline void Cell::highlightActive()
+{
+    this->rec.setFillColor(BABY_BLUE);
+}
+
+/**
+ * Restore the original color
+ */
+inline void Cell::resetColor()
+{
+    this->rec.setFillColor(DARK_BROWN);
+}
+
 } // namespace chk

src/GameManager.hpp

@@ -54,7 +54,7 @@ class GameManager
     bool playerRedTurn = true;
     // bottom display message
     mutable std::string currentMsg;
-    // whether match is over
+    // whether match is over (for offline play only)
     bool gameOver = false;
     // used for atomic updates
     std::mutex my_mutex;

src/MainMenu.hpp

@@ -20,6 +20,7 @@ namespace chk
 {
 constexpr auto ICON_PATH = "win-icon-16.png";
 constexpr auto FONT_PATH = "notosans-regular.ttf";
+constexpr unsigned FONT_SIZE{16};
 
 enum class UserChoice
 {

src/Piece.hpp

@@ -5,12 +5,13 @@
 #include <SFML/Graphics/RenderStates.hpp>
 #include <SFML/Graphics/RenderTarget.hpp>
 #include <SFML/Graphics/Texture.hpp>
+#include <iostream>
 
 namespace chk
 {
 enum class PieceType
 {
-    Red = 69995,
+    Red = 67895,
     Black,
 };
 

src/WsClient.cpp

@@ -16,7 +16,8 @@ chk::WsClient::WsClient()
     this->webSocketPtr->setPingInterval(30);
     ix::SocketTLSOptions tlsOptions;
 #ifndef _WIN32
-    // Currently system CAs are not supported on non-Windows platforms with mbedtls
+    // Currently system CAs are not supported on non-Windows platforms with
+    // mbedtls
     tlsOptions.caFile = "NONE";
 #endif // _WIN32
     this->webSocketPtr->setTLSOptions(tlsOptions);
@@ -200,9 +201,9 @@ void WsClient::runMainLoop()
 
     else {
         // already connected
-        this->runServerLoop(); 
+        this->runServerLoop();
     }
-    
+
     // some error happened 🙁
     if (this->isDead) {
         if (this->_onDeathCallback != nullptr) {
@@ -212,11 +213,10 @@ void WsClient::runMainLoop()
     } else if (this->haveWinner) {
         this->showWinnerPopup();
     }
-    // clang-format on
 }
 
 /**
- * Try to connect to Server
+ * Try to connect to Server.
  * @param address server IP or URI
  */
 void WsClient::tryConnect(std::string_view address)
@@ -282,7 +282,7 @@ void WsClient::setOnReadyConnectedCallback(const onConnectedServer &callback)
 }
 
 /**
- * Set the callback to handle starting game after signal from server
+ * Set the callback to handle starting game after signal from server.
  * @param callback the callback function
  */
 void WsClient::setOnReadyStartGameCallback(const onReadyStartGame &callback)
@@ -291,7 +291,7 @@ void WsClient::setOnReadyStartGameCallback(const onReadyStartGame &callback)
 }
 
 /**
- * Set the callback to handle connection failures or server kickouts
+ * Set the callback to handle connection failures or server kickouts.
  * @param callback the callback function
  */
 void WsClient::setOnDeathCallback(const onDeathCallback &callback)
@@ -300,7 +300,7 @@ void WsClient::setOnDeathCallback(const onDeathCallback &callback)
 }
 
 /**
- * Set the callback for handling Opponent moving their piece
+ * Set the callback for handling Opponent moving their piece.
  * @param callback the callback function
  */
 void WsClient::setOnMovePieceCallback(const onMovePieceCallback &callback)
@@ -309,7 +309,7 @@ void WsClient::setOnMovePieceCallback(const onMovePieceCallback &callback)
 }
 
 /**
- * Set the callback for handling Opponent capturing my Piece
+ * Set the callback for handling Opponent capturing my Piece.
  * @param callback the callback function
  */
 void WsClient::setOnCapturePieceCallback(const onCaptureCallback &callback)
@@ -318,7 +318,7 @@ void WsClient::setOnCapturePieceCallback(const onCaptureCallback &callback)
 }
 
 /**
- * Set the callback for handling Winner or Loser of match
+ * Set the callback for handling Winner or Loser of match.
  * @param callback the callback function
  */
 void WsClient::setOnWinLoseCallback(const onWinLoseCallback &callback)
@@ -327,7 +327,8 @@ void WsClient::setOnWinLoseCallback(const onWinLoseCallback &callback)
 }
 
 /**
- * Send Protobuf response back to server
+ * Send Protobuf response back to server.
+ * 
  * @param payload the request body
  * @return TRUE if sent successfully, else FALSE
  */
@@ -347,7 +348,8 @@ bool WsClient::replyServer(const chk::payload::BasePayload &payload) const
 }
 
 /**
- * Exchange messages with the server and update the game accordingly. if any error happen, close connection
+ * Exchange messages with the server and update the game accordingly. if any
+ * error happens, close connection
  */
 void WsClient::runServerLoop()
 {
@@ -360,15 +362,14 @@ void WsClient::runServerLoop()
         chk::payload::BasePayload basePayload;
         if (!basePayload.ParseFromString(msg))
         {
-            std::scoped_lock lg(this->mut);
+            std::scoped_lock lg{this->mut};
             this->deathNote = "Profobuf: Could not parse payload";
             this->isDead = true;
             return;
         }
 
         if (basePayload.has_welcome())
         {
-            /* code */
             chk::payload::WelcomePayload welcome = basePayload.welcome();
             if (this->_onReadyConnected != nullptr)
             {
@@ -414,7 +415,7 @@ void WsClient::runServerLoop()
             if (this->_onWinLoseCallback != nullptr)
             {
                 this->_onWinLoseCallback(basePayload.notice());
-                std::scoped_lock lg(this->mut);
+                std::scoped_lock lg{this->mut};
                 this->deathNote = basePayload.notice();
                 this->haveWinner = true;
             }

src/WsClient.hpp

@@ -56,7 +56,7 @@ class WsClient final
     std::atomic_bool haveWinner{false};             // whether server returned Winner or Loser
     std::atomic_bool isConnected{false};            // if done connected to server (else, show loading)
     chk::CircularBuffer<std::string> msgBuffer{1};  // keep only recent 1 incoming message
-    mutable std::string deathNote;                  // reason from server for disconnected (KICKED or WIN or LOSE)
+    mutable std::string deathNote;                  // reason from server for disconnecting
     mutable std::string protoBucket;                // REUSABLE container to store OUTGOING protobuf
     std::atomic_bool connClicked = false;           // if 'connect' button clicked
     std::vector<chk::ServerLocation> publicServers; // list of public servers (fetched from CDN)

src/main.cpp

@@ -23,7 +23,7 @@ int main()
     std::unique_ptr<chk::GameManager> manager = nullptr;
 
     // SHOW MAIN MENU
-    chk::MainMenu homeMenu(&window);
+    chk::MainMenu homeMenu{&window};
     const auto userChoice = homeMenu.runMainLoop();
     if (userChoice == chk::UserChoice::ONLINE_PLAY)
     {
@@ -37,7 +37,7 @@ int main()
     // LOAD FONT for IMGUI
     ImGuiIO &io = ImGui::GetIO();
     io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;
-    ImFont *imfont = io.Fonts->AddFontFromFileTTF(chk::getResourcePath(chk::FONT_PATH).c_str(), 16);
+    ImFont *imfont = io.Fonts->AddFontFromFileTTF(chk::getResourcePath(chk::FONT_PATH).c_str(), chk::FONT_SIZE);
     IM_ASSERT(imfont != nullptr);
     ImGui::SFML::UpdateFontTexture();
 
@@ -66,7 +66,7 @@ int main()
     chk::CircularBuffer<short> circularBuffer{1};
 
     // THE STATUS TEXT
-    sf::Text txtPanel{"Space Checkers", font, 16};
+    sf::Text txtPanel{"Space Checkers", font, chk::FONT_SIZE};
     txtPanel.setFillColor(sf::Color::White);
     txtPanel.setPosition(sf::Vector2f{10.0f, 8.5 * chk::SIZE_CELL});
     manager->updateMessage("Welcome to Space Checkers");