src/graphicalsystem.h

   1 /*
   2   Copyright (c) 2006 Paolo Capriotti <p.capriotti@sns.it>
   3             (c) 2006 Maurizio Monge <maurizio.monge@kdemail.net>
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9 */
  10
  11 #ifndef GRAPHICALSYSTEM_H
  12 #define GRAPHICALSYSTEM_H
  13
  14 #include <boost/shared_ptr.hpp>
  15 #include <QObject>
  16 #include "graphicalapi.h"
  17
  18 class ChessTable;
  19 class Board;
  20 class UserEntity;
  21
  22 class GraphicalSystem : public QObject, private GraphicalAPI {
  23 Q_OBJECT
  24
  25 public:
  26
  27   /** The current chess table */
  28   ChessTable* m_view;
  29
  30   /** The current board */
  31   Board* m_board;
  32
  33   /** The position data */
  34   AbstractPosition::Ptr m_pos;
  35
  36   /** The variant specific animator */
  37   AbstractAnimator::Ptr m_animator;
  38
  39   /** The current variant */
  40   VariantInfo* m_variant;
  41
  42   /** @a GraphicalPosition interface function implementation */
  43 //   virtual void addTag(const QString& name, Point, bool over = false);
  44
  45   /** @a GraphicalPosition interface function implementation */
  46 //   virtual void clearTags(const QString& name);
  47
  48   /** @a GraphicalPosition interface function implementation */
  49 //   virtual void setTags(const QString& name, Point p1 = Point::invalid(), Point p2 = Point::invalid(),
  50 //                                       Point p3 = Point::invalid(), Point p4 = Point::invalid(),
  51 //                                       Point p5 = Point::invalid(), Point p6 = Point::invalid() );
  52
  53 private Q_SLOTS:
  54   /** internal function to listen at setting changes */
  55   void settingsChanged();
  56
  57 private:
  58   /**
  59     * \return the current abstract position. (interface for GraphicalAPI)
  60     */
  61   virtual const PointConverter* converter() const;
  62
  63   /**
  64     * \return the current abstract position. (interface for GraphicalAPI)
  65     */
  66   virtual AbstractPosition::Ptr position() const;
  67
  68   /**
  69     * \return a sprite at the position \a index in the graphical pool. (interface for GraphicalAPI)
  70     */
  71   virtual NamedSprite getSprite(const Point& p);
  72
  73   /**
  74     * Removes a sprite at the position \a index in the graphical pool. (interface for GraphicalAPI)
  75     * \return the newly created sprite.
  76     */
  77   virtual NamedSprite takeSprite(const Point& p);
  78
  79   /**
  80     * Sets the piece at the position \a index in the graphical pool. (interface for GraphicalAPI)
  81     * \return the newly created sprite.
  82     */
  83   virtual NamedSprite setPiece(const Point& p, const AbstractPiece* piece, bool show);
  84
  85   /**
  86     *  Create a new piece, but do not add it to the graphical system.
  87     * \return the newly created sprite.
  88     */
  89   virtual NamedSprite createPiece(const Point& p, const AbstractPiece* piece, bool show);
  90
  91   /**
  92     * Sets the sprite at the position \a index in the graphical pool. (interface for GraphicalAPI)
  93     * \return the newly created sprite.
  94     */
  95   virtual void setSprite(const Point& p, const NamedSprite& sprite);
  96
  97   /**
  98     * \return how many sprites are contained in the pool
  99     */
 100   virtual int poolSize(int pool);
 101
 102   /**
 103     * \return the sprite at the position \a index in the graphical pool. (interface for GraphicalAPI)
 104     */
 105   //virtual NamedSprite getPoolSprite(int pool, int index);
 106
 107   /**
 108     * Removes the sprite at the position \a index in the graphical pool. (interface for GraphicalAPI)
 109     */
 110   virtual void removePoolSprite(int pool, int index);
 111
 112   /**
 113     * Removes the sprite at the position \a index in the graphical pool (only for drops).
 114     * (interface for GraphicalAPI)
 115     * \return the removed sprite.
 116     */
 117   virtual NamedSprite takePoolSprite(int pool, int index);
 118
 119   /**
 120     * Inserts a sprite at the position \a index in the graphical pool. (interface for GraphicalAPI)
 121     * \return the newly created sprite.
 122     */
 123   virtual NamedSprite insertPoolPiece(int pool, int index, const AbstractPiece* piece);
 124
 125   /**
 126     * \return the piece of the pool that has been dropped, or (-1,-1). (interface for GraphicalAPI)
 127     */
 128   virtual std::pair<int, int> droppedPoolPiece();
 129
 130   /**
 131     * Create an animation from a scheme.
 132     */
 133   virtual AnimationPtr animate(const Animate::Scheme& scheme, Animate::AnimationType type);
 134 public:
 135   /** Constructor */
 136   GraphicalSystem(ChessTable* view, AbstractPosition::Ptr startingPosition,
 137                                               VariantInfo* variant);
 138   virtual ~GraphicalSystem();
 139
 140   /** Sets the reference entity */
 141   void setup(const boost::shared_ptr<UserEntity>& entity);
 142
 143   /** Goes forward playing a move, that has to be legal and checked */
 144   void forward(const AbstractMove::Ptr& move,
 145                const AbstractPosition::Ptr& pos,
 146                const SpritePtr& = SpritePtr());
 147
 148   /** Goes back undoing a move, that has to be legal and checked */
 149   void back(const AbstractMove::Ptr& lastMove,
 150             const AbstractMove::Ptr& move,
 151             const AbstractPosition::Ptr& pos);
 152
 153   /** Warps to a new position */
 154   void warp(const AbstractMove::Ptr& lastMove,
 155             const AbstractPosition::Ptr& pos);
 156
 157   /** Adjusts a sprite to the correct position */
 158   void adjustSprite(const Point& p);
 159
 160   /** Sets the current turn */
 161   void setTurn(int turn);
 162 };
 163
 164
 165 #endif //GRAPHICALSYSTEM_H