File indexing completed on 2024-04-28 04:02:06

 /*
     This file is part of the KDE games kwin4 program
     SPDX-FileCopyrightText: 2006 Martin Heni <kde@heni-online.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef DISPLAY_GAME_H
 #define DISPLAY_GAME_H
 
 // own
 #include "thememanager.h"
 // Qt
 #include <QGraphicsView>
 #include <QList>
 #include <QTimer>
 
 // Forward declaration
 class ThemeManager;
 class PieceSprite;
 class SpriteNotify;
 class PixmapSprite;
 class ScoreSprite;
 class ReflectionGraphicsScene;
 
 /**
  * The display engine for the actual game.
  */
 class DisplayGame : public QObject, public virtual Themeable
 {
     Q_OBJECT
 
 public:
     /**
      * Constructor for the game display.
      *  @param scene         The graphics scene
      *  @param theme         The theme manager
      *  @param parent        The parent window
      */
     DisplayGame(ReflectionGraphicsScene *scene, ThemeManager *theme, QGraphicsView *parent = nullptr);
 
     /**
      * Destructor
      */
     ~DisplayGame() override;
 
     /**
      * Start the display (setup and initialization)
      */
     void start();
 
     /**
      * Main theme function. Called by the theme manager. Redraw and resize
      * display.
      */
     void changeTheme() override;
 
     /**
      * Set a game piece to a certain position on the game board. If an animation
      * is requested the piece 'falls' to this position.
      * @param x         The x-position on the game board [0-6]
      * @param y         The y-position on the game board [0-5]
      * @param color     Which color to use for the piece [0:hide piece, 1: yellow, 2: red]
      * @param no        Which sprite to use for the piece [0-41]
      * @param animation True to use animation, false to just plot the piece
      * @return The sprite notification object. Its signal indicate the end of the animation.
      */
     SpriteNotify *displayPiece(int x, int y, int color, int no, bool animation);
 
     /**
      * Sets the movement indicator arrow to the given position.
      * @param x      The x position [0-6]
      * @param color  The arrow color [0:hide piece, 1: yellow, 2: red]
      */
     void displayArrow(int x, int color);
 
     /**
      * Sets the hint indicator on the game board. This is a little symbol to suggest
      * where the next move is recommended to go.
      * @param x         The x-position on the game board [0-6]
      * @param y         The y-position on the game board [0-5]
      * @param show      True to show the indicator, false to hide it.
      */
     void displayHint(int x, int y, bool show);
 
     /**
      * Sets on of the winning move indicator sprites on the game board.
      * They should be set on top of the winning pieces to show them.
      * @param x         The x-position on the game board [0-6]
      * @param y         The y-position on the game board [0-5]
      * @param no        Which sprite to use for the piece [0-3]
      */
     void displayStar(int x, int y, int no);
 
     /**
      * Transform the mouse coordinates to a game board movement coordinate.
      * That is a coordinate [0-6] corresponding to a move on the board.
      * @param pos  The mouse position.
      * @return     The game board position [0-6] or [-1] on error.
      */
     int mapMouseToMove(const QPoint &pos);
 
     /**
      * Shows the game over sprite.
      */
     void displayEnd();
 
     /**
      * Retrieve the score status sprite.
      * @return The score sprite.
      */
     ScoreSprite *score();
 
 protected Q_SLOTS:
     /**
      * Run the main game animation (if existent). This is done via a periodic timer.
      */
     void advance();
 
 private:
     // The theme manager
     ThemeManager *mTheme;
 
     // The grapics scene used for display
     ReflectionGraphicsScene *mScene;
 
     // The graphics view used for display
     QGraphicsView *mView;
 
     // List of all sprites used
     QList<QGraphicsItem *> mSprites;
 
     // List of all game pieces used #=42
     QList<PieceSprite *> mPieces;
 
     // The game boad sprite
     PixmapSprite *mBoard;
 
     // All arrow sprites
     QList<PixmapSprite *> mArrows;
 
     // The score sprite
     ScoreSprite *mScoreBoard;
 
     // The winning indicator sprites
     QList<PixmapSprite *> mStars;
 
     // The hint sprite
     PixmapSprite *mHint;
 
     // The time used for advance()
     QTimer *mTimer;
 };
 
 #endif