A lot of code beautifications

Author: iUltimateLP

CardStack.cpp

@@ -14,8 +14,6 @@ CCardStack::CCardStack(QWidget *parent)
 
 void CCardStack::addCard(CCard *cardToAdd)
 {
- //   qDebug() << "CCardStack::addCard";
-
     // Make sure the card is valid
     if (cardToAdd)
     {
@@ -99,8 +97,6 @@ bool CCardStack::canDropCard(CCard* cardToDrop)
 {
     Q_UNUSED(cardToDrop);
 
-    qDebug() << "CanDropCard not overwritten!";
-
     // By default, allow dropping
     return true;
 }
@@ -113,5 +109,5 @@ int CCardStack::getIndexOfCard(CCard* card)
 
 void CCardStack::handleCardsChanged()
 {
-    //qDebug() << "handleCardsChanged!";
+
 }

DrawStack.cpp

@@ -7,10 +7,6 @@
 CDrawStack::CDrawStack(QWidget* parent)
     : CCardStack(parent)
 {
-    //TODO: why do we need setGeometry? -> does not change anything when commented out
-    // This widget has always the size of a card
-    //this->setGeometry(0, 0, CCard::cardTileSize.width(), CCard::cardTileSize.height());
-
     // Create the dummy vbox layout with zero spacing, so they get overlayed
     hbox = new CCardHBoxLayout(20, this);
 
@@ -36,19 +32,16 @@ CDrawStack::CDrawStack(QWidget* parent)
     boxLayout->addWidget(drawStackPlaceholder);
     boxLayout->addWidget(this);
 
+    // Connect the clicked event with the showNextCard function
     QObject::connect(drawStackPlaceholder, &CClickableLabel::clicked, this, &CDrawStack::showNextCard);
 }
 
-void CDrawStack::addCard(CCard* cardToAdd)
-{
-    CCardStack::addCard(cardToAdd);
-}
-
 void CDrawStack::removeCard(CCard* cardToRemove)
 {
-
     // Call the superclasses' removeCard
     CCardStack::removeCard(cardToRemove);
+
+    // Remove the card from the UI
     removeCardFromUi();
 }
 
@@ -59,11 +52,12 @@ bool CDrawStack::canDropCard(CCard *cardToDrop)
     // Adding a card to the drawStack is not possible, due to that, this method is not necessary
     qDebug() << "nothing happens";
 
-    return true;
+    return false;
 }
 
 CCard* CDrawStack::getTopCard()
 {
+    // Return the current top card
     return getCards()[currentCard];
 }
 
@@ -103,12 +97,11 @@ void CDrawStack::removeCardFromUi()
     // The next card should be interactable, if there is one
     if(currentCard <= getNumCards()-1)
     {
-        qDebug() << "next card is set to interact";
         getCards()[currentCard]->setCanInteract(true);
+
         // When a card is removed, the last third card in the stack will be displayed, if existent
         if(currentCard + 2 <= getNumCards()-1)
         {
-            qDebug() << "next card should be displayed";
             hbox->push_back(getCards()[currentCard+2]);
             getCards()[currentCard+2]->setVisible(true);
         }
@@ -117,7 +110,6 @@ void CDrawStack::removeCardFromUi()
 
 void CDrawStack::showNextCard()
 {
-    qDebug() << "current card" << currentCard;
     // The cards that shouldn't be displayed have to be invisible, even if the card is removed from
     // the layout (the card is still in the background of the layout)
     // If there are cards left on the stack, the variable "currentCard" is decremented
@@ -128,8 +120,6 @@ void CDrawStack::showNextCard()
     }
     else if(currentCard == 0)
     {
-        qDebug() << "set to last card";
-
         // CurrentCard = 0 means, that the stack is empty, so the drawStack gets recycled
         drawStackPlaceholder->setPixmap(cardBackPixmap);
 

DrawStack.h

@@ -18,7 +18,6 @@ class CDrawStack : public CCardStack
 
 public:
     //~ Begin CCardStack interface
-    virtual void addCard(CCard *cardToAdd) override;
     virtual void removeCard(CCard *cardToRemove) override;
     virtual bool canDropCard(CCard* cardToDrop) override;
     virtual CCard* getTopCard() override;

FinalStack.cpp

@@ -4,6 +4,9 @@
 #include "Main.h"
 #include <QDebug>
 
+// Set the static variables
+int CFinalStack::NumCardsToRender = 5;
+
 CFinalStack::CFinalStack(QWidget* parent, ECardSymbol symbol)
     : CCardStack(parent)
     , stackSymbol(symbol)
@@ -28,15 +31,10 @@ CFinalStack::CFinalStack(QWidget* parent, ECardSymbol symbol)
 
 void CFinalStack::addCard(CCard* cardToAdd)
 {
-    // Hide the current top card, if any
-    /*if (this->getNumCards() > 0)
-    {
-        this->getTopCard()->hide();
-    }*/
-
     // Call the superclasses' addCard
     CCardStack::addCard(cardToAdd);
 
+    // Add it to the vbox
     vbox->addWidget(cardToAdd);
 }
 
@@ -48,13 +46,8 @@ void CFinalStack::removeCard(CCard* cardToRemove)
     // Call the superclasses' removeCard
     CCardStack::removeCard(cardToRemove);
 
+    // Remove it from the vbox
     vbox->removeWidget(cardToRemove);
-
-    // Show the next top card, if any
-    /*if (this->getNumCards() > 0)
-    {
-        this->getTopCard()->show();
-    }*/
 }
 
 bool CFinalStack::canDropCard(CCard *cardToDrop)
@@ -86,10 +79,10 @@ bool CFinalStack::canDropCard(CCard *cardToDrop)
 
 void CFinalStack::handleCardsChanged()
 {
-    // Only show the last five cards to avoid weird overlapping shadows
+    // Only show the last NumCardsToRender cards to avoid weird overlapping shadows
     for (int i = 0; i < getCards().length(); i++)
     {
-        if (i >= getCards().length() - 5)
+        if (i >= getCards().length() - CFinalStack::NumCardsToRender)
         {
             getCards()[i]->show();
         }

FinalStack.h

@@ -11,6 +11,10 @@ class CFinalStack : public CCardStack
 {
     Q_OBJECT
 
+public:
+    // How many cards to render on a final stack to avoid glitches with the shadows
+    static int NumCardsToRender;
+
 public:
     // Constructor
     CFinalStack(QWidget* parent = nullptr, ECardSymbol symbol = ECardSymbol::Heart);

Game.cpp

@@ -346,7 +346,10 @@ void CGame::undoLastMove()
 
 void CGame::restartGame()
 {
+    // Set up the new game board
     setUp();
+
+    // Reset the score
     score = 0;
     emit onScoreChanged();
 }

GameWindow.cpp

@@ -66,7 +66,8 @@ CGameWindow::CGameWindow(QWidget* parent)
     ui->time_label->setStyleSheet("QLabel {color: white}");
     ui->statusbar->hide();
 
-    QWidget *layout = new QWidget();
+    // Create the main layout
+    QWidget* layout = new QWidget();
     mainGrid = new QGridLayout();
     mainGrid->setSpacing(12);
     layout->setLayout(mainGrid);
@@ -75,7 +76,7 @@ CGameWindow::CGameWindow(QWidget* parent)
 
 void CGameWindow::displayHoldingStack(CHoldingStack* stack, int column)
 {
-   // stack->resize(CCard::getCardScreenSize().width(), this->size().height() - stack->pos().y());
+    // Set a minimum height to avoid layout glitches
     stack->setMinimumHeight(CCard::getCardScreenSize().height());
     mainGrid->addWidget(stack, 1, column, 1, 1, Qt::AlignTop);
 
@@ -90,37 +91,43 @@ void CGameWindow::displayHoldingStack(CHoldingStack* stack, int column)
 
 void CGameWindow::displayFinalStack(CFinalStack* final, int column)
 {
-    //final->resize(CCard::getCardScreenSize().width(), this->size().height() - final->pos().y());
+    // Add the final stack to the widget
     mainGrid->addWidget(final, 0, column + 3, 1, 1);
-    // SetRowMinimumHeight is needed, so that the layout is not changing, when cards are added to the holdingstacks
+
+    // setRowMinimumHeight is needed, so that the layout is not changing, when cards are added to the holdingstacks
     mainGrid->setRowMinimumHeight(0, 200);
 }
 
-void CGameWindow::displayDrawStack(CDrawStack *draw)
+void CGameWindow::displayDrawStack(CDrawStack* draw)
 {
+    // Add the stack to the layout
     mainGrid->addLayout(draw->getHBoxLayout(), 0, 0, 1, 2);
 }
 
 void CGameWindow::incrementMove()
 {
+    // Increment the moves and update the text
     ++moves;
     ui->move_label->setText("Moves: " + QString::number(moves));
 }
 
 void CGameWindow::decrementMove()
 {
+    // Decrement the moves and update the text
     --moves;
     ui->move_label->setText("Moves: " + QString::number(moves));
 }
 
-void CGameWindow::incrementScore(int gameScore)
+void CGameWindow::incrementScore(int scoreToAdd)
 {
-    score += gameScore;
+    // Increment the score by the given value and update the text
+    score += scoreToAdd;
     ui->score_label->setText("Score: " + QString::number(score));
 }
 
 void CGameWindow::updateTimer()
 {
+    // Add a second to the timer and update the text
     *time = time->addSecs(1);
     ui->time_label->setText("Timer: " + time->toString("mm:ss"));
 }
@@ -137,12 +144,14 @@ Created by Annie Berend (5033782) and Jonathan Verbeek (5058288)");
 
 void CGameWindow::updateScore()
 {
+    // Get the score off the game instance and update the text
     score = CMain::get()->getGameInstance()->getScore();
     ui->score_label->setText("Score: " + QString::number(score));
 }
 
 void CGameWindow::resetGameWindow()
 {
+    // Removes all widgets, resets the time and moves
     removeAllWidgets(mainGrid);
     time = new QTime(0,0);
     moves = 0;
@@ -190,6 +199,7 @@ void CGameWindow::removeAllWidgets(QLayout* layout)
 
 void CGameWindow::setUndoButtonEnabled(bool enabled)
 {
+    // Sets the undo button to be enabled or not
     ui->undoButton->setEnabled(enabled);
 }
 

GameWindow.h

@@ -35,7 +35,7 @@ class CGameWindow : public QMainWindow
     // Is called after every move
     void incrementMove();
     void decrementMove();
-    void incrementScore(int gameScore);
+    void incrementScore(int scoreToAdd);
 
     // Clears the gridlayout where all cards are displayed, needed, when new game is chosen
     void removeAllWidgets(QLayout *layout);

Main.cpp

@@ -24,8 +24,6 @@ int CMain::run(int argc, char* argv[])
     // Create the sound manager instance
     soundManager = new CSoundManager();
 
-    qDebug() << "Entering app loop";
-
     // Run the app loop
     return app.exec();
 }

SoundManager.cpp

@@ -51,6 +51,6 @@ void CSoundManager::setEnableSoundEffects(bool enabled)
 
 void CSoundManager::setEnableMusic(bool enabled)
 {
-    // Set the music's volume
+    // Set the music's volume so it won't completely stop when disabled
     this->bgMusicPlayer->setVolume(enabled ? 50 : 0);
 }