b483311d37d5c9ae397c977660728c1d19ced00b
[ghostsoverboard] / seascene.cpp
1 /**************************************************************************
2         Ghosts Overboard - a game for Maemo 5
3
4         Copyright (C) 2011  Heli Hyvättinen
5
6         This file is part of Ghosts Overboard
7
8         Ghosts Overboard is free software: you can redistribute it and/or modify
9         it under the terms of the GNU General Public License as published by
10         the Free Software Foundation, either version 2 of the License, or
11         (at your option) any later version.
12
13         This program is distributed in the hope that it will be useful,
14         but WITHOUT ANY WARRANTY; without even the implied warranty of
15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16         GNU General Public License for more details.
17
18         You should have received a copy of the GNU General Public License
19         along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
21 **************************************************************************/
22
23 #include "seascene.h"
24 #include "octopus.h"
25 #include "ship.h"
26 #include <QGraphicsPixmapItem>
27 #include <QDebug>
28 #include <QMessageBox>
29 #include <QTime>
30 #include <QApplication>
31 #include <QAction>
32 #include <QPushButton>
33 #include <QLabel>
34 #include <QVBoxLayout>
35
36 const QString ghostImageFilename_ = ":/pix/aave.png";
37 const QString rockImageFilename_ =":/pix/kari.png";
38 const QString octopusImageFilename_= ":/pix/tursas.png";
39
40
41 SeaScene::SeaScene(QObject *parent) :
42     QGraphicsScene(parent)
43 {
44     paused_ = false;
45     screenLitKeeper_.keepScreenLit(true);
46
47     //set background
48
49     QPixmap waves (":/pix/meri.png");
50     waves.scaled(20,20);
51     setBackgroundBrush(QBrush(waves));
52
53     //set random seed
54
55     qsrand(QTime::currentTime().msec()+2);  //+2 to avoid setting it to 1
56
57 //Setup the level list
58
59     Level level1(5,10);
60     levelList_.append(level1);
61     Level level2(5,10,2,50);
62     levelList_.append(level2);
63     Level level3(5,15,2,50);
64     levelList_.append(level3);
65     Level level4(5,15,4,50);
66     levelList_.append(level4);
67     Level level5(5,15,5,100);
68     levelList_.append(level5);
69
70     currentLevel_ = 0;
71
72     connect(this,SIGNAL(allGhostsPicked()),this,SLOT(nextLevel()));
73
74
75     pVibrateAction_ = new QAction(tr("Vibration effects"),this);
76     pVibrateAction_->setCheckable(true);
77     connect(pVibrateAction_,SIGNAL(toggled(bool)),this,SLOT(vibrationActivate(bool)));
78
79
80     pPauseAction_ = new QAction(tr("Pause"),this);
81     pPauseAction_->setCheckable(true);
82     connect(pPauseAction_,SIGNAL(toggled(bool)),this,SLOT(pause(bool)));
83
84
85     autopauseTimer.setInterval(15*60*1000);
86     connect(&autopauseTimer,SIGNAL(timeout()),this,SLOT(forcePause()));
87
88
89 }
90
91 void SeaScene::setupMap(int ghosts, int rocks, int octopuses, int octopusSpeed)
92 {
93     //empty the map
94
95     clear();
96
97     createMenuItems();
98
99     //empty the list of moving items
100
101     movingItems_.clear();
102
103     //empty the list of free slots
104     freeTiles_.clear();
105
106     //fill the list of free slots
107
108     int numberOfXTiles  = width() / 40;
109     int numberOfYTiles = height() /40;
110
111 //    qDebug() << numberOfXTiles << " slots in x direction";
112 //    qDebug() << numberOfYTiles << " slots in y rirection";
113
114     for (int i = 0; i < numberOfXTiles; i++ )
115     {
116         for (int j = 0; j < numberOfYTiles; j++)
117         {
118             freeTiles_.append(QPointF(i*40,j*40));
119         }
120     }
121
122
123     //spread the rocks
124
125     for (int i = 0; i < rocks; i++)
126     {
127         QPointF * pPosition = findRandomFreeSlot();
128
129         //If there was no room no point to continue
130         if (pPosition == NULL)
131             break;
132
133         QPixmap rockPixmap (":/pix/kari.png");
134         QGraphicsPixmapItem * pRock = addPixmap(rockPixmap);
135         pRock->setData(0,"rock");
136         pRock->setPos(*pPosition);
137         delete pPosition;
138
139     }
140
141     //spread the ghosts
142
143     ghostsLeft_ = ghosts;
144     spreadGhosts(ghosts);
145
146
147
148     //spread the octopuses
149
150     QList <Octopus*> octopusList;
151
152     for (int i=0; i < octopuses; i++)
153     {
154         QPointF * pPosition = findRandomFreeSlot();
155
156         //If there was no room no point to continue
157         if (pPosition == NULL)
158             break;
159
160     QPixmap octopusPixmap (":/pix/tursas.png");
161     Octopus * pOctopus = new Octopus(octopusPixmap,octopusSpeed);
162     pOctopus->setData(0,"octopus");
163     pOctopus->setPos(*pPosition);
164     addItem(pOctopus);
165     pOctopus->startMoving();
166     movingItems_.append(pOctopus);
167     connect(this,SIGNAL(pauseOn()),pOctopus,SLOT(stopMoving()));
168     connect(this,SIGNAL(pauseOff()),pOctopus,SLOT(startMoving()));
169     octopusList.append(pOctopus);
170     delete pPosition;
171
172     }
173
174
175     //place the ship
176
177     QPointF * pPosition = findRandomFreeSlot();
178     if (pPosition == NULL)
179     {
180         // Game cannot begin without a free position for ship, so give an error message and return
181
182         QMessageBox::critical(NULL,"Error! Too many objects on screen","No free space to place the ship. The game cannot start. Please choose another level.");
183         return;
184     }
185
186     QList<QPixmap> shipImages;
187     shipImages.append(QPixmap(":/pix/laiva.png"));
188     shipImages.append(QPixmap(":/pix/laiva_1aave.png"));
189     shipImages.append(QPixmap(":/pix/laiva_2aave.png"));
190     shipImages.append(QPixmap(":/pix/laiva_3aave.png"));
191     shipImages.append(QPixmap(":/pix/laiva_4aave.png"));
192     shipImages.append(QPixmap(":/pix/laiva_5aave.png"));
193     shipImages.append(QPixmap(":/pix/laiva_6aave.png"));
194     shipImages.append(QPixmap(":/pix/laiva_7aave.png"));
195     shipImages.append(QPixmap(":/pix/laiva_8aave.png"));
196     shipImages.append(QPixmap(":/pix/laiva_9aave.png"));
197     shipImages.append(QPixmap(":/pix/laiva_10aave.png"));
198
199     Ship * pShip = new Ship (shipImages);
200     pShip->setData(0,"ship");
201     pShip->setPos(*pPosition);
202     addItem(pShip);
203     connect(pShip,SIGNAL(pickingGhost(QGraphicsItem*)),this, SLOT(removeGhost(QGraphicsItem*)) );
204     connect(pShip,SIGNAL(droppingGhosts(int)),this,SLOT(ghostsDropped(int)));
205     connect(this,SIGNAL(vibrationActivated(bool)),pShip,SLOT(setVibrationActivate(bool)));
206     pShip->startMoving();
207     movingItems_.append(pShip);
208     connect(this,SIGNAL(pauseOn()),pShip,SLOT(stopMoving()));
209     connect(this,SIGNAL(pauseOff()),pShip,SLOT(startMoving()));
210     foreach (Octopus* pOctopus, octopusList)
211     {
212         connect(pOctopus,SIGNAL(droppingGhosts()),pShip,SLOT(dropAllGhosts()));
213     }
214     delete pPosition;
215
216
217 }
218
219 void SeaScene::setupMap(Level level)
220 {
221     setupMap(level.getNumberOfGhosts(),level.getNumberOfRocks(),level.getNumberOfOctopuses(),level.getOctopusSpeed());
222 }
223
224 void SeaScene::spreadGhosts(int ghosts)
225 {
226
227
228     //the octopuses and the ship may have moved from their original positions,
229     //so the list of free slots must be adjusted to exclude their current positions
230
231     QList<QPointF> temporarilyReservedSlots;
232
233     foreach (QGraphicsItem* pItem, movingItems_)
234     {
235         if (pItem == NULL)
236         {
237  //           qDebug() << "NULL item in movingItems_";
238             continue;
239         }
240
241         //round x and y down to fit the slot size
242         int x = pItem->x();
243         x = x/40;
244         x = x*40;
245
246         int y = pItem->y();
247         y = y/40;
248         y=y*40;
249
250
251         QPointF position (x,y);
252
253         //remove the tiles (potentially) occupied by the item from free slots and place in temp list if was in the list before
254
255         if (freeTiles_.removeOne(position))
256             temporarilyReservedSlots.append(position);
257
258
259         position.setX(x+40);
260
261         if (freeTiles_.removeOne(position))
262             temporarilyReservedSlots.append(position);
263
264         position.setY(y+40);
265
266         if (freeTiles_.removeOne(position))
267             temporarilyReservedSlots.append(position);
268
269         position.setX(x);
270
271         if (freeTiles_.removeOne(position))
272             temporarilyReservedSlots.append(position);
273
274     }
275
276
277     //spread ghosts in random free slots
278
279     for (int i=0; i < ghosts; i++)
280     {
281         QPointF * pPosition = findRandomFreeSlot();
282
283         //If there was no room no point to continue
284         if (pPosition == NULL)
285             return;
286
287         QPixmap ghostPixmap(":/pix/aave.png");
288         QGraphicsPixmapItem * pGhost = addPixmap(ghostPixmap);
289         pGhost->setData(0,"ghost");
290         pGhost->setPos(*pPosition);
291         delete pPosition;
292     }
293
294     //return the slots occupied by moving items to free slots
295     freeTiles_.append(temporarilyReservedSlots);
296
297     //clear temp for the next round
298     temporarilyReservedSlots.clear();
299 }
300
301 QPointF* SeaScene::findRandomFreeSlot()
302 {
303     if (freeTiles_.isEmpty())
304         return NULL;
305
306     int index = qrand()%freeTiles_.size();
307
308 //    qDebug()  << index << " index";
309     return new QPointF (freeTiles_.takeAt(index));
310
311 }
312
313 void SeaScene::removeGhost(QGraphicsItem *pGhost)
314 {
315     removeItem(pGhost);  //remove the item from scene
316     freeTiles_.append(pGhost->scenePos()); //add the item's position to free slots
317     delete pGhost;
318     ghostsLeft_--;
319     if (ghostsLeft_ == 0)
320     {
321         emit allGhostsPicked();
322  //       qDebug() << "All ghosts picked!";
323     }
324 }
325
326 void SeaScene::ghostsDropped(int ghosts)
327 {
328     ghostsLeft_ += ghosts;
329
330     spreadGhosts(ghosts);
331 }
332
333 void SeaScene::pause(bool paused)
334 {
335     //    qDebug() << "pause pressed " << paused;
336         if (paused_ == paused)
337                 return;
338
339         paused_ = paused;
340
341         if (paused == false)
342         {
343      //       qDebug() << "starting to move again";
344             emit pauseOff();
345             screenLitKeeper_.keepScreenLit(true);
346             if (pPausetextItem_)
347                 pPausetextItem_->hide();
348
349             autopauseTimer.start(); //Start counting towards autopause
350         }
351
352         else
353         {
354          qDebug("about to stop movement");
355             emit pauseOn();
356             screenLitKeeper_.keepScreenLit(false);
357             if (pPausetextItem_ != NULL)
358             {
359                 qDebug() << "about to show the pause text";
360                 pPausetextItem_->show();
361                 qDebug() << "showing pause text";
362             }
363                 else qDebug() << "No pause text available";
364
365             autopauseTimer.stop(); //No need to count toward autopause when already paused
366         }
367 }
368
369 void SeaScene::vibrationActivate(bool on)
370 {
371     emit vibrationActivated(on);
372 }
373
374 void SeaScene::handleScreenTapped()
375 {
376
377     //If the game is going just pause it
378     if (!paused_)
379     {
380         pPauseAction_->setChecked(true);
381         return;
382     }
383
384     //If the game is paused, chacl if menu item was selected
385
386     QList<QGraphicsItem *> items = selectedItems();
387
388     //if nothing selected resume play
389
390     if (items.isEmpty())
391     {
392         pPauseAction_->setChecked(false);
393         return;
394
395     }
396
397     //If something was selected check if it was one of the menu items and act on it
398     //(Nothing else should be made selectable anyway)
399
400     //Menu functions
401
402     QGraphicsItem* pItem = items.at(0); //Selecting an item brings here, thus only selecting one item should be possible
403                                        //... so we can just take the first one
404
405
406     if (pItem == pRestartGameItem_)
407     {
408         qDebug() << "game restart requested";
409         restartGame();
410     }
411
412     else if (pItem == pRestartLevelItem_)
413     {
414         qDebug() << "Level restart requested";
415         restartLevel();
416
417     }
418
419     else if (pItem == pSettingsItem_)
420     {
421     //Temporary code for settings, likely to be turned into a QML dialog
422
423           QMessageBox::StandardButton buttonpressed = QMessageBox::question(NULL,"Settings","Do you wish to have vibration effects enabled?", QMessageBox::Yes | QMessageBox::No);
424
425           if (buttonpressed == QMessageBox::Yes)
426               pVibrateAction_->setChecked(true);
427           if (buttonpressed == QMessageBox::No)
428               pVibrateAction_->setChecked(false);
429     }
430
431     else if (pItem == pAboutItem_)
432     {
433         about();
434     }
435
436     else if (pItem == pQuitItem_)
437     {
438         qApp->quit();
439     }
440
441
442     //Selection is just used to get notice of a menu item being clicked, removed after use
443
444     clearSelection();
445
446     //The user propably went to paused state just to access menu, so unpause
447
448     pPauseAction_->setChecked(false);
449
450 }
451
452
453
454 void SeaScene::createMenuItems()
455 {
456
457     QFont font;
458     font.setPixelSize(35);
459
460
461
462     pPausetextItem_ = new QGraphicsTextItem;
463     pPausetextItem_->setHtml("<font size = \"5\" color = darkorange> Game paused. Tap to continue.");
464     pPausetextItem_->setZValue(1000);
465     pPausetextItem_->setPos(200,50);
466     addItem(pPausetextItem_);
467     pPausetextItem_->hide();
468
469     menuItemCount_ = 0;
470
471     QString menufonthtml = "<font size = \"4\" color = darkorange>";
472
473     pRestartGameItem_ = new QGraphicsTextItem;
474     pRestartGameItem_->setHtml(tr("Restart <br> game").prepend(menufonthtml));
475     prepareForMenu(pRestartGameItem_);
476
477     pRestartLevelItem_ = new QGraphicsTextItem;
478     pRestartLevelItem_->setHtml(tr("Restart <br> level").prepend(menufonthtml));
479     prepareForMenu(pRestartLevelItem_);
480
481     pSettingsItem_ = new QGraphicsTextItem;
482     pSettingsItem_->setHtml(tr("Vibration <br> effects").prepend(menufonthtml));
483     prepareForMenu(pSettingsItem_);
484
485     pAboutItem_ = new QGraphicsTextItem;
486     pAboutItem_->setHtml(tr("About <br> game").prepend(menufonthtml));
487     prepareForMenu(pAboutItem_);
488
489     pQuitItem_ = new QGraphicsTextItem;
490     pQuitItem_->setHtml(tr("Quit <br> game").prepend(menufonthtml));
491     prepareForMenu(pQuitItem_);
492
493 }
494
495 void SeaScene::prepareForMenu(QGraphicsItem * pItem)
496 {
497
498     //Menu items have pause text item as their parent and are thus added to scene automatically
499     //They are also shown and hidden with it, resulting in the menu being visble when the game is paused
500     //Their coordinates are given relative to the parent.
501
502
503     pItem->setParentItem(pPausetextItem_);
504     pItem->setZValue(1000);
505     pItem->setFlag(QGraphicsItem::ItemIsSelectable);
506     pItem->setY(150);
507     pItem->setX(menuItemCount_++*160-150);
508  }
509
510
511 void SeaScene::about()
512 {
513     QMessageBox::about(NULL, tr("About %1").arg(QApplication::applicationName()),
514                        tr("Version %1"
515                           "<p>Copyright 2011 Heli Hyv&auml;ttinen"
516                           "<p>License: General Public License v2"
517                           "<p>Bug Reports: https://bugs.maemo.org/ "
518                           "enter_bug.cgi?product=Ghosts%20Overboard"
519                           ).arg(QApplication::applicationVersion()));
520
521
522
523 }
524
525
526 void SeaScene::restartLevel()
527 {
528     setupMap(levelList_.value(currentLevel_));  //value() returns default constructor Level if index is invalid, so no risk of crash
529     vibrationActivate(pVibrateAction_->isChecked());  //Vibration effects are lost without this
530    // qDebug() << pVibrateAction_->isChecked();
531     autopauseTimer.start();  //reset counting towards autopause
532 }
533
534
535
536 void SeaScene::nextLevel()
537 {
538
539     currentLevel_++;
540
541     if (levelList_.empty())
542         setupMap(Level());
543
544
545     if ( currentLevel_ < levelList_.size() )
546     {
547        restartLevel();
548     }
549
550     else //Victory!
551     {
552
553        QDialog* pVictoryDialog = new QDialog();
554        pVictoryDialog->setWindowTitle(tr("You won!"));
555
556
557        QPushButton* pPlayAgainButton = new QPushButton(tr("Play again"));
558 //       QPushButton* pQuitButton = new QPushButton(tr("Quit game"));
559
560        QPixmap victoryIcon (":/pix/aavesaari.png");
561        QLabel* pVictoryLabel = new QLabel();
562        pVictoryLabel->setPixmap(victoryIcon);
563
564        QLabel* pTextLabel = new QLabel(tr("Congratulations! <p>You have saved all the ghosts."));
565
566
567        QVBoxLayout* pMainLayout = new QVBoxLayout;
568
569        QHBoxLayout* pTopLayout = new QHBoxLayout;
570        pMainLayout->addLayout(pTopLayout);
571
572        pTopLayout->addWidget(pVictoryLabel);
573        pTopLayout->addWidget(pTextLabel);
574
575
576
577        QHBoxLayout* pButtonLayout = new QHBoxLayout();
578        pMainLayout->addLayout(pButtonLayout);
579
580  //      pButtonLayout->addWidget(pQuitButton);
581        pButtonLayout->addWidget(pPlayAgainButton);
582
583
584
585        pVictoryDialog->setLayout(pMainLayout);
586
587        connect(pPlayAgainButton, SIGNAL(clicked()),pVictoryDialog,SLOT(accept()));
588
589        pVictoryDialog->exec();
590
591         //Never mind if the user cancels the dialog: restart the game anyway
592
593        restartGame();
594     }
595 }
596
597
598 void SeaScene::restartGame()
599 {
600     currentLevel_ = 0;
601     restartLevel();
602 }
603
604
605 void SeaScene::forcePause()
606 {
607     //Pause without setting the pause action state
608     pause(true);
609 }
610
611 void::SeaScene::softContinue()
612 {
613     //Continue if not being paused by the user
614     // Reverts forcePause()
615
616     pause(pPauseAction_->isChecked());
617 }