Should pause at device lock
[ghostsoverboard] / seascene.cpp
index 3183161..b29c068 100644 (file)
@@ -1,9 +1,39 @@
+/**************************************************************************
+        Ghosts Overboard - a game for Maemo 5
+
+        Copyright (C) 2011  Heli Hyvättinen
+
+        This file is part of Ghosts Overboard
+
+        Ghosts Overboard is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 2 of the License, or
+        (at your option) any later version.
+
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+
+        You should have received a copy of the GNU General Public License
+        along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+**************************************************************************/
+
 #include "seascene.h"
-#include "timercontrolledtursas.h"
+#include "octopus.h"
 #include "ship.h"
 #include <QGraphicsPixmapItem>
 #include <QDebug>
 #include <QMessageBox>
+#include <QTime>
+#include <QApplication>
+#include <QAction>
+#include <QPushButton>
+#include <QLabel>
+#include <QVBoxLayout>
+#include <QSettings>
+#include <QPixmap>
 
 const QString ghostImageFilename_ = ":/pix/aave.png";
 const QString rockImageFilename_ =":/pix/kari.png";
@@ -14,15 +44,80 @@ SeaScene::SeaScene(QObject *parent) :
     QGraphicsScene(parent)
 {
 
+    setItemPointersNull();
+
+    paused_ = false;
+    screenLitKeeper_.keepScreenLit(true);
+
+    //set background
+
+    QPixmap waves (":/pix/meri.png");
+    waves.scaled(20,20);
+    setBackgroundBrush(QBrush(waves));
+
+    //set random seed
+
+    qsrand(QTime::currentTime().msec()+2);  //+2 to avoid setting it to 1
+
+//Setup the level list
+
+    Level level1(5,10);
+    levelList_.append(level1);
+    Level level2(5,10,2,50);
+    levelList_.append(level2);
+    Level level3(5,15,2,50);
+    levelList_.append(level3);
+    Level level4(5,15,4,50);
+    levelList_.append(level4);
+    Level level5(5,15,5,100);
+    levelList_.append(level5);
+
+    currentLevel_ = 0;
+
+
+    connect(this,SIGNAL(allGhostsPicked()),this,SLOT(nextLevel()));
+
+
+    pVibrateAction_ = new QAction(tr("Vibration effects"),this);
+    pVibrateAction_->setCheckable(true);
+    connect(pVibrateAction_,SIGNAL(toggled(bool)),this,SLOT(vibrationActivate(bool)));
+    QSettings settings;
+    pVibrateAction_->setChecked(settings.value("vibration",false).toBool());
+
+
+    pPauseAction_ = new QAction(tr("Pause"),this);
+    pPauseAction_->setCheckable(true);
+    connect(pPauseAction_,SIGNAL(toggled(bool)),this,SLOT(pause(bool)));
+
+    connect(&deviceInfo_,SIGNAL(lockStatusChanged(bool)),this,SLOT(handleDeviceLocked(bool)));
+
+
+    autopauseTimer.setSingleShot(true);
+    autopauseTimer.setInterval(15*60*1000);
+    connect(&autopauseTimer,SIGNAL(timeout()),this,SLOT(turnPauseOn()));
+
 
 }
 
-void SeaScene::setupMap(int ghosts, int rocks, int octopuses)
+void SeaScene::setupMap(int ghosts, int rocks, int octopuses, int octopusSpeed)
 {
     //empty the map
 
     clear();
 
+    setItemPointersNull();
+
+    createMenuItems();
+
+    createAboutBoxItems();
+
+    createVictoryItems();
+
+
+    //empty the list of moving items
+
+    movingItems_.clear();
+
     //empty the list of free slots
     freeTiles_.clear();
 
@@ -31,8 +126,8 @@ void SeaScene::setupMap(int ghosts, int rocks, int octopuses)
     int numberOfXTiles  = width() / 40;
     int numberOfYTiles = height() /40;
 
-    qDebug() << numberOfXTiles << " slots in x direction";
-    qDebug() << numberOfYTiles << " slots in y rirection";
+//    qDebug() << numberOfXTiles << " slots in x direction";
+//    qDebug() << numberOfYTiles << " slots in y rirection";
 
     for (int i = 0; i < numberOfXTiles; i++ )
     {
@@ -70,6 +165,7 @@ void SeaScene::setupMap(int ghosts, int rocks, int octopuses)
 
     //spread the octopuses
 
+    QList <Octopus*> octopusList;
 
     for (int i=0; i < octopuses; i++)
     {
@@ -80,11 +176,15 @@ void SeaScene::setupMap(int ghosts, int rocks, int octopuses)
             break;
 
     QPixmap octopusPixmap (":/pix/tursas.png");
-    TimerControlledTursas * pOctopus = new TimerControlledTursas (octopusPixmap,100);
+    Octopus * pOctopus = new Octopus(octopusPixmap,octopusSpeed);
     pOctopus->setData(0,"octopus");
     pOctopus->setPos(*pPosition);
     addItem(pOctopus);
     pOctopus->startMoving();
+    movingItems_.append(pOctopus);
+    connect(this,SIGNAL(pauseOn()),pOctopus,SLOT(stopMoving()));
+    connect(this,SIGNAL(pauseOff()),pOctopus,SLOT(startMoving()));
+    octopusList.append(pOctopus);
     delete pPosition;
 
     }
@@ -101,19 +201,99 @@ void SeaScene::setupMap(int ghosts, int rocks, int octopuses)
         return;
     }
 
-    Ship * pShip = new Ship (QPixmap(":/pix/laiva.png"));
+    QList<QPixmap> shipImages;
+    shipImages.append(QPixmap(":/pix/laiva.png"));
+    shipImages.append(QPixmap(":/pix/laiva_1aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_2aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_3aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_4aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_5aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_6aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_7aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_8aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_9aave.png"));
+    shipImages.append(QPixmap(":/pix/laiva_10aave.png"));
+
+    Ship * pShip = new Ship (shipImages);
     pShip->setData(0,"ship");
     pShip->setPos(*pPosition);
     addItem(pShip);
     connect(pShip,SIGNAL(pickingGhost(QGraphicsItem*)),this, SLOT(removeGhost(QGraphicsItem*)) );
     connect(pShip,SIGNAL(droppingGhosts(int)),this,SLOT(ghostsDropped(int)));
+    connect(this,SIGNAL(vibrationActivated(bool)),pShip,SLOT(setVibrationActivate(bool)));
     pShip->startMoving();
+    movingItems_.append(pShip);
+    connect(this,SIGNAL(pauseOn()),pShip,SLOT(stopMoving()));
+    connect(this,SIGNAL(pauseOff()),pShip,SLOT(startMoving()));
+    foreach (Octopus* pOctopus, octopusList)
+    {
+        connect(pOctopus,SIGNAL(droppingGhosts()),pShip,SLOT(dropAllGhosts()));
+    }
     delete pPosition;
+
+
 }
 
+void SeaScene::setupMap(Level level)
+{
+    setupMap(level.getNumberOfGhosts(),level.getNumberOfRocks(),level.getNumberOfOctopuses(),level.getOctopusSpeed());
+}
 
 void SeaScene::spreadGhosts(int ghosts)
 {
+
+
+    //the octopuses and the ship may have moved from their original positions,
+    //so the list of free slots must be adjusted to exclude their current positions
+
+    QList<QPointF> temporarilyReservedSlots;
+
+    foreach (QGraphicsItem* pItem, movingItems_)
+    {
+        if (pItem == NULL)
+        {
+ //           qDebug() << "NULL item in movingItems_";
+            continue;
+        }
+
+        //round x and y down to fit the slot size
+        int x = pItem->x();
+        x = x/40;
+        x = x*40;
+
+        int y = pItem->y();
+        y = y/40;
+        y=y*40;
+
+
+        QPointF position (x,y);
+
+        //remove the tiles (potentially) occupied by the item from free slots and place in temp list if was in the list before
+
+        if (freeTiles_.removeOne(position))
+            temporarilyReservedSlots.append(position);
+
+
+        position.setX(x+40);
+
+        if (freeTiles_.removeOne(position))
+            temporarilyReservedSlots.append(position);
+
+        position.setY(y+40);
+
+        if (freeTiles_.removeOne(position))
+            temporarilyReservedSlots.append(position);
+
+        position.setX(x);
+
+        if (freeTiles_.removeOne(position))
+            temporarilyReservedSlots.append(position);
+
+    }
+
+
+    //spread ghosts in random free slots
+
     for (int i=0; i < ghosts; i++)
     {
         QPointF * pPosition = findRandomFreeSlot();
@@ -128,6 +308,12 @@ void SeaScene::spreadGhosts(int ghosts)
         pGhost->setPos(*pPosition);
         delete pPosition;
     }
+
+    //return the slots occupied by moving items to free slots
+    freeTiles_.append(temporarilyReservedSlots);
+
+    //clear temp for the next round
+    temporarilyReservedSlots.clear();
 }
 
 QPointF* SeaScene::findRandomFreeSlot()
@@ -137,7 +323,7 @@ QPointF* SeaScene::findRandomFreeSlot()
 
     int index = qrand()%freeTiles_.size();
 
-    qDebug()  << index << " index";
+//    qDebug()  << index << " index";
     return new QPointF (freeTiles_.takeAt(index));
 
 }
@@ -150,8 +336,8 @@ void SeaScene::removeGhost(QGraphicsItem *pGhost)
     ghostsLeft_--;
     if (ghostsLeft_ == 0)
     {
-        //here whatever happens when a level is complete / a signal
-        qDebug() << "All ghosts picked!";
+        emit allGhostsPicked();
+ //       qDebug() << "All ghosts picked!";
     }
 }
 
@@ -161,3 +347,379 @@ void SeaScene::ghostsDropped(int ghosts)
 
     spreadGhosts(ghosts);
 }
+
+void SeaScene::pause(bool paused)
+{
+    //    qDebug() << "pause pressed " << paused;
+        if (paused_ == paused)
+                return;
+
+        paused_ = paused;
+
+        if (paused == false)
+        {
+     //       qDebug() << "starting to move again";
+            emit fullscreenRequested();
+            emit pauseOff();
+            screenLitKeeper_.keepScreenLit(true);
+            if (pPausetextItem_)
+                pPausetextItem_->hide();
+
+            autopauseTimer.start(); //Start counting towards autopause
+        }
+
+        else
+        {
+//         qDebug("about to stop movement");
+            emit pauseOn();
+            screenLitKeeper_.keepScreenLit(false);
+            if (pPausetextItem_ != NULL)
+            {
+//                qDebug() << "about to show the pause text";
+                pPausetextItem_->show();
+//                qDebug() << "showing pause text";
+            }
+//                else qDebug() << "No pause text available";
+
+            autopauseTimer.stop(); //No need to count toward autopause when already paused
+        }
+}
+
+void SeaScene::vibrationActivate(bool on)
+{
+    emit vibrationActivated(on);
+}
+
+void SeaScene::handleScreenTapped()
+{
+
+    //If the game is going just pause it
+    if (!paused_)
+    {
+        pPauseAction_->setChecked(true);
+        return;
+    }
+
+    //If the game is paused and about box is shown, close it and show the pause text and menu again
+
+    if(pAboutBoxItem_)
+    {
+        if(pAboutBoxItem_->isVisible())
+        {
+            pAboutBoxItem_->hide();
+            pPausetextItem_->show();
+        }
+    }
+
+  
+    //If the game is paused, check if the victory item is being shown
+    if(pVictoryCongratulationsItem_)
+    {
+        if (pVictoryCongratulationsItem_->isVisibleTo(NULL)) //returns visibility to scene
+        {
+            pVictoryCongratulationsItem_->hide();
+            restartGame();
+            pPauseAction_->setChecked(false); // unpause
+            return;
+        }
+    }
+
+    //If the game is paused and no victory, check if menu item was selected
+
+    QList<QGraphicsItem *> items = selectedItems();
+
+    //if nothing selected resume play
+
+    if (items.isEmpty())
+    {
+        pPauseAction_->setChecked(false);
+        return;
+
+    }
+
+    //If something was selected check if it was one of the menu items and act on it
+    //(Nothing else should be made selectable anyway)
+
+    //Menu functions
+
+    QGraphicsItem* pItem = items.at(0); //Selecting an item brings here, thus only selecting one item should be possible
+                                       //... so we can just take the first one
+
+    //Selection is just used to get notice of a menu item being clicked, removed after use
+
+    clearSelection();
+
+
+    //Act upon the selected item
+
+
+    if (pItem == pRestartGameItem_)
+    {
+//        qDebug() << "game restart requested";
+        restartGame();
+        pPauseAction_->setChecked(false); //unpause game
+
+    }
+
+    else if (pItem == pRestartLevelItem_)
+    {
+//        qDebug() << "Level restart requested";
+        restartLevel();
+        pPauseAction_->setChecked(false); //unpause game
+
+    }
+
+    else if (pItem == pSettingsItem_)
+    {
+        pVibrateAction_->toggle();
+
+        QSettings settings;
+        settings.setValue("vibration",pVibrateAction_->isChecked());
+
+        QString text = pSettingsItem_->toHtml();
+        if (pVibrateAction_->isChecked())
+            text.replace(" on"," off"); //don't remove spaces or you get vibratioff...
+        else
+            text.replace(" off"," on");
+        pSettingsItem_->setHtml(text);
+    }
+
+    else if (pItem == pAboutItem_)
+    {
+        about();
+    }
+
+    else if(pItem == pMinimizeItem_)
+    {
+        emit minimizeRequested();
+    }
+
+    else if (pItem == pQuitItem_)
+    {
+        qApp->quit();
+    }
+}
+
+
+
+void SeaScene::createMenuItems()
+{
+
+    QFont font;
+    font.setPixelSize(35);
+
+
+
+    pPausetextItem_ = new QGraphicsTextItem;
+    pPausetextItem_->setHtml("<font size = \"5\" color = darkorange> Game paused. Tap to continue.");
+    pPausetextItem_->setZValue(1000);
+    pPausetextItem_->setPos(165,50);
+    addItem(pPausetextItem_);
+    pPausetextItem_->hide();
+
+    menuItemCount_ = 0;
+
+    QString menufonthtml = "<font size = \"4\" color = darkorange>";
+
+    pRestartGameItem_ = new QGraphicsTextItem;
+    pRestartGameItem_->setHtml(tr("Restart <br> game").prepend(menufonthtml));
+    prepareForMenu(pRestartGameItem_);
+
+    pRestartLevelItem_ = new QGraphicsTextItem;
+    pRestartLevelItem_->setHtml(tr("Restart <br> level").prepend(menufonthtml));
+    prepareForMenu(pRestartLevelItem_);
+
+    pSettingsItem_ = new QGraphicsTextItem;
+    QString vibraText(tr("Turn vibration <br> effects "));
+    QString statusText;
+    if (pVibrateAction_->isChecked())
+    {
+        statusText = "off";
+    }
+    else
+    {
+        statusText = "on";
+    }
+    vibraText.append(statusText);
+    pSettingsItem_->setHtml(vibraText.prepend(menufonthtml));
+    prepareForMenu(pSettingsItem_);
+
+    pAboutItem_ = new QGraphicsTextItem;
+    pAboutItem_->setHtml(tr("About <br> game").prepend(menufonthtml));
+    prepareForMenu(pAboutItem_);
+
+    pMinimizeItem_ = new QGraphicsTextItem;
+    pMinimizeItem_->setHtml(tr("Show <br> status bar").prepend(menufonthtml));
+    prepareForMenu(pMinimizeItem_);
+
+    pQuitItem_ = new QGraphicsTextItem;
+    pQuitItem_->setHtml(tr("Quit <br> game").prepend(menufonthtml));
+    prepareForMenu(pQuitItem_);
+
+}
+
+void SeaScene::prepareForMenu(QGraphicsItem * pItem)
+{
+
+    //Menu items have pause text item as their parent and are thus added to scene automatically
+    //They are also shown and hidden with it, resulting in the menu being visble when the game is paused
+    //Their coordinates are given relative to the parent.
+
+
+
+
+    int itemsPerRow = 3;
+
+    pItem->setParentItem(pPausetextItem_);
+    pItem->setZValue(1000);
+    pItem->setFlag(QGraphicsItem::ItemIsSelectable);
+
+    int row = menuItemCount_/(itemsPerRow);
+    pItem->setY(150+row*120);
+    pItem->setX(((menuItemCount_%(itemsPerRow))*180+5));
+
+    menuItemCount_++;
+ }
+
+
+void SeaScene::about()
+{
+    pPausetextItem_->hide();
+    pAboutBoxItem_->show();
+}
+
+
+void SeaScene::restartLevel()
+{
+    setupMap(levelList_.value(currentLevel_));  //value() returns default constructor Level if index is invalid, so no risk of crash
+    vibrationActivate(pVibrateAction_->isChecked());  //Vibration effects are lost without this
+   // qDebug() << pVibrateAction_->isChecked();
+    autopauseTimer.start();  //reset counting towards autopause
+}
+
+
+
+void SeaScene::nextLevel()
+{
+
+    currentLevel_++;
+
+    if (levelList_.empty())
+        setupMap(Level());
+
+
+    if ( currentLevel_ < levelList_.size() )
+    {
+       restartLevel();
+    }
+
+    else //Victory!
+    {
+
+        pPauseAction_->setChecked(true); //Pause the game while showing the victory dialog
+
+        pPausetextItem_->hide();
+
+        pVictoryCongratulationsItem_->show();
+
+    }
+}
+
+
+void SeaScene::restartGame()
+{
+    currentLevel_ = 0;
+    restartLevel();
+}
+
+
+void SeaScene::forcePause()
+{
+    //Pause without setting the pause action state
+    pause(true);
+}
+
+void SeaScene::softContinue()
+{
+    //Continue if not being paused by the user
+    // Reverts forcePause()
+
+    pause(pPauseAction_->isChecked());
+}
+
+
+void SeaScene::createVictoryItems()
+{
+    pVictoryCongratulationsItem_ = new QGraphicsTextItem;
+    pVictoryCongratulationsItem_->setHtml("<font size=\"6\" color = darkorange> Victory!");
+    pVictoryCongratulationsItem_->hide();
+    pVictoryCongratulationsItem_->setPos(355,50);
+    pVictoryCongratulationsItem_->setZValue(1000);
+    addItem(pVictoryCongratulationsItem_);
+
+
+    //coordinates are relative to the parent
+
+    QGraphicsTextItem * pTextItem = new QGraphicsTextItem(pVictoryCongratulationsItem_);
+    pTextItem->setHtml("<font size=\"5\" color = darkorange> Congratulations!");
+    pTextItem->setPos(-50,100);
+    pTextItem->setZValue(1000);
+
+    QGraphicsTextItem * pMiddleTextItem = new QGraphicsTextItem(pVictoryCongratulationsItem_);
+    pMiddleTextItem->setHtml("<font size=\"5\" color = darkorange> You have saved all the ghosts.");
+    pMiddleTextItem->setPos(-145,140);
+    pMiddleTextItem->setZValue(1000);
+
+    QGraphicsTextItem * pLowestTextItem = new QGraphicsTextItem(pVictoryCongratulationsItem_);
+    pLowestTextItem->setHtml("<font size=\"5\" color = darkorange> Tap to play again");
+    pLowestTextItem->setPos(-50,220);
+    pLowestTextItem->setZValue(1000);
+}
+
+void SeaScene::createAboutBoxItems()
+{
+    pAboutBoxItem_ = new QGraphicsTextItem;
+    addItem(pAboutBoxItem_);
+    pAboutBoxItem_->setPos(25,50);
+    pAboutBoxItem_->setZValue(1000);
+    pAboutBoxItem_->hide();
+
+    pAboutBoxItem_->setHtml(tr("<font color = darkorange size = \"7\">"
+                          "%1 <br> <font size = \"5\"> Version %2"
+                          "<p><font size = \"4\"> Copyright 2011 Heli Hyv&auml;ttinen"
+                          "<p><font size = \"4\"> License: General Public License v2"
+                          "<p><font size = \"3\"> Web: http://ghostsoverboard.garage.maemo.org/<br>"
+                          "Bug Reports: <br> https://bugs.maemo.org/"
+                          "enter_bug.cgi?product=Ghosts%20Overboard"
+                          ).arg(QApplication::applicationName(),QApplication::applicationVersion()));
+
+}
+
+void SeaScene::setItemPointersNull()
+{
+    pPausetextItem_ = NULL;
+    pRestartLevelItem_ = NULL;
+    pRestartGameItem_ = NULL;
+    pSettingsItem_ = NULL;
+    pAboutItem_ = NULL;
+    pQuitItem_ = NULL ;
+    pMinimizeItem_ = NULL;
+
+    pAboutBoxItem_ = NULL;
+    pVictoryCongratulationsItem_ = NULL;
+
+}
+
+void SeaScene::turnPauseOn()
+{
+    pPauseAction_->setChecked(true);
+}
+
+void SeaScene::handleDeviceLocked(bool isLocked)
+{
+    //pauses if locked but does not unpause if unlocked
+    if(isLocked)
+    {
+        pPauseAction_->setChecked(true);
+    }
+}