kapman/gamescene.h

   1 /*
   2  * Copyright 2007-2008 Thomas Gallinari <tg8187@yahoo.fr>
   3  * Copyright 2007-2008 Alexandre Galinier <alex.galinier@hotmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef GAMESCENE_H
  20 #define GAMESCENE_H
  21
  22 #include "game.h"
  23 #include "elementitem.h"
  24 #include "mazeitem.h"
  25 #include "ghostitem.h"
  26 #include "kapmanitem.h"
  27
  28 #include <QGraphicsScene>
  29 #include <QList>
  30 #include <KPixmapCache>
  31 #include <KSvgRenderer>
  32 #include <KGameTheme>
  33
  34 /**
  35  * @brief This class contains all the Game elements to be drawn on the screen by the GameView instance.
  36  */
  37 class GameScene : public QGraphicsScene {
  38
  39         Q_OBJECT
  40
  41         private:
  42
  43                 /** The Game instance */
  44                 Game* m_game;
  45
  46                 /** The KapmanItem to be drawn */
  47                 KapmanItem* m_kapmanItem;
  48
  49                 /** The MazeItem to be drawn */
  50                 MazeItem* m_mazeItem;
  51
  52                 /** The GhostItem of each Ghost to be drawn */
  53                 QList<GhostItem*> m_ghostItems;
  54
  55                 /** The ElementItem to be drawn (each Pill and Energizers) */
  56                 ElementItem*** m_elementItems;
  57
  58                 /** The Bonus ElementItem */
  59                 ElementItem* m_bonusItem;
  60
  61                 /** A list with labels to display when a ghost or a bonus is eaten */
  62                 QList<QGraphicsTextItem*> m_wonPointsLabels;
  63
  64                 /** The labels to be displayed during the game */
  65                 QGraphicsTextItem* m_introLabel;
  66                 QGraphicsTextItem* m_introLabel2;
  67                 QGraphicsTextItem* m_newLevelLabel;
  68                 QGraphicsTextItem* m_scoreLabel;
  69                 QGraphicsTextItem* m_livesLabel;
  70                 QGraphicsTextItem* m_levelLabel;
  71                 QGraphicsTextItem* m_pauseLabel;
  72
  73                 /** The pixmap cache */
  74                 KPixmapCache* m_cache;
  75
  76                 /** The SVG renderer */
  77                 KSvgRenderer* m_renderer;
  78
  79                 /** The Game theme */
  80                 KGameTheme* m_theme;
  81
  82         public:
  83
  84                 /**
  85                  * Creates a new GameScene instance.
  86                  * @param p_game the Game instance whose elements must be contained in the GameScene in order to be drawn
  87                  */
  88                 GameScene(Game* p_game);
  89
  90                 /**
  91                  * Deletes the Game instance.
  92                  */
  93                 ~GameScene();
  94
  95                 /**
  96                  * @return the Game instance
  97                  */
  98                 Game* getGame() const;
  99
 100                 /**
 101                  * Loads the game theme.
 102                  */
 103                 void loadTheme();
 104
 105         private slots:
 106
 107                 /**
 108                  * Updates the elements to be drawn on Game introduction.
 109                  * @param p_newLevel true a new level has begun, false otherwise
 110                  */
 111                 void intro(const bool p_newLevel);
 112
 113                 /**
 114                  * Updates the elements to be drawn when the Game starts.
 115                  */
 116                 void start();
 117
 118                 /**
 119                  * Updates the elements to be drawn considering the Game state (paused or running).
 120                  * @param p_pause if true the Game has been paused, if false the Game has been resumed
 121                  * @param p_fromUser if true the Game has been paused due to an action from the user
 122                  */
 123                 void setPaused(const bool p_pause, const bool p_fromUser);
 124
 125                 /**
 126                  * Removes the Element at the given coordinates from the GameScene.
 127                  * @param p_wonPoints value of the won Points, used when a ghost or a Bonus is eaten
 128                  * @param p_x x-coordinate of the Element
 129                  * @param p_y y-coordinate of the Element
 130                  */
 131                 void hideElement(const qreal p_x, const qreal p_y);
 132
 133                 /**
 134                  * Displays the Bonus.
 135                  */
 136                 void displayBonus();
 137
 138                 /**
 139                  * Remove the Bonus from the GameScene.
 140                  */
 141                 void hideBonus();
 142
 143                 /**
 144                  * Upadates the Game information labels.
 145                  * @param p_info the type of the information to be updated
 146                  */
 147                 void updateInfo(const Game::InformationTypes p_info);
 148
 149                 /**
 150                  * Display won Points on the scene when a Bonus or a Ghosts is eaten
 151                  * @param p_wonPoints the value to display
 152                  * @param p_xPos the position of the eaten element on X axis
 153                  * @param p_yPos the position of the eaten element on Y axis
 154                  */
 155                 void displayPoints(long p_wonPoints, qreal p_xPos, qreal p_yPos);
 156
 157                 /**
 158                  * Hide the first label in the list of won points labels
 159                  */
 160                 void hidePoints();
 161
 162                 /**
 163                  * Update theme id elements.
 164                  */
 165                 void updateSvgIds();
 166
 167                 /**
 168                  * Update theme properties.
 169                  */
 170                 void updateThemeProperties();
 171 };
 172
 173 #endif
 174