src/graphicalinfo.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 GRAPHICALINFO_H
  12 #define GRAPHICALINFO_H
  13
  14 #include <boost/shared_ptr.hpp>
  15 #include <QObject>
  16 #include "kboard.h"
  17 #include "element.h"
  18 #include "graphicalposition.h"
  19
  20 class ChessTable;
  21 class Board;
  22 class Animator;
  23 class GraphicalPosition;
  24 class UserEntity;
  25 class GraphicalInfo;
  26
  27 class GraphicalInfoProxy : public QObject {
  28 Q_OBJECT
  29   friend class GraphicalInfo;
  30   GraphicalInfo *m_info;
  31   GraphicalInfoProxy(GraphicalInfo *i) : QObject(), m_info(i) {}
  32
  33 public slots:
  34   void settingsChanged();
  35 };
  36
  37 /**
  38   * @class GraphicalInfo <graphicalinfo.h>
  39   * @brief The graphical information about sprites and pieces.
  40   *
  41   * This class provides the variant's animator the facilites requires to add/remove
  42   * pieces to and from the board, keeping syncronized the sprites and the underlaying
  43   * board pieces.
  44   */
  45 class GraphicalInfo : private GraphicalPosition {
  46 public: // TODO: temporarily remove access limitations.
  47         // NOTE to Maurizio:why are getElement, setElement, etc... private?
  48   typedef boost::shared_ptr<PieceSprite> SpritePtr;
  49
  50   /** The current chess table */
  51   ChessTable* m_view;
  52
  53   /** The current board */
  54   Board* m_board;
  55
  56   /** The position data */
  57   AbstractPosition::Ptr m_pos;
  58
  59   /** The variant specific animator */
  60   AbstractAnimator::Ptr m_animator;
  61
  62   /** The current variant */
  63   VariantInfo* m_variant;
  64
  65   /** signal proxy */
  66   GraphicalInfoProxy* m_proxy;
  67
  68   /** @a GraphicalPosition interface function implementation */
  69   virtual int getIntSetting(const QString& key, int def_value) const;
  70
  71   /** @a GraphicalPosition interface function implementation */
  72   virtual bool getBoolSetting(const QString& key, bool def_value) const;
  73
  74   /** @a GraphicalPosition interface function implementation */
  75   virtual QString getStringSetting(const QString& key, const QString& def_value) const;
  76
  77   /** @a GraphicalPosition interface function implementation */
  78   virtual SpritePtr getSprite(const Point& p) const;
  79
  80   /** @a GraphicalPosition interface function implementation */
  81   virtual SpritePtr setPiece(const Point& p, AbstractPiece::Ptr e,
  82                               bool usedrop = false, bool show = true);
  83
  84   /** @a GraphicalPosition interface function implementation */
  85   virtual Element getElement(const Point& p) const;
  86
  87   /** @a GraphicalPosition interface function implementation */
  88   virtual void setElement(const Point& p, const Element& e);
  89
  90   /** @a GraphicalPosition interface function implementation */
  91   virtual void removeElement(const Point& p);
  92
  93   /** @a GraphicalPosition interface function implementation */
  94   virtual void updatePool(AbstractPosition::PoolPtr pool);
  95
  96   /** @a GraphicalPosition interface function implementation */
  97   virtual void addTag(const QString& name, Point, bool over = false);
  98
  99   /** @a GraphicalPosition interface function implementation */
 100   virtual void clearTags(const QString& name);
 101
 102   /** @a GraphicalPosition interface function implementation */
 103   virtual void setTags(const QString& name, Point p1 = Point::invalid(), Point p2 = Point::invalid(),
 104                                       Point p3 = Point::invalid(), Point p4 = Point::invalid(),
 105                                       Point p5 = Point::invalid(), Point p6 = Point::invalid() );
 106
 107   /** @a GraphicalPosition interface function implementation */
 108   virtual Point first() const;
 109
 110   /** @a GraphicalPosition interface function implementation */
 111   virtual Point last() const;
 112
 113   /** @a GraphicalPosition interface function implementation */
 114   virtual Point next(const Point& p) const;
 115
 116   /** @a GraphicalPosition interface function implementation */
 117   virtual bool valid(const Point& p) const;
 118
 119
 120   /** @a GraphicalPosition interface function implementation */
 121   virtual bool consistent() const;
 122
 123   /** internal function */
 124   void settingsChanged();
 125
 126   /** internal function */
 127   virtual void addToPool(AbstractPiece::Ptr p, int n);
 128
 129   /** internal function */
 130   virtual void removeFromPool(AbstractPiece::Ptr p, int n);
 131
 132 public:
 133   /** Constructor */
 134   GraphicalInfo(ChessTable* view, AbstractPosition::Ptr startingPosition,
 135                                               VariantInfo* variant);
 136   virtual ~GraphicalInfo();
 137
 138   /** Sets the reference entity */
 139   void setup(const boost::shared_ptr<UserEntity>& entity);
 140
 141   /** Goes forward playing a move, that has to be legal and checked */
 142   void forward(AbstractMove::Ptr move, AbstractPosition::Ptr pos,
 143                const boost::shared_ptr<PieceSprite>& = boost::shared_ptr<PieceSprite>());
 144
 145   /** Goes back undoing a move, that has to be legal and checked */
 146   void back(AbstractMove::Ptr lastMove, AbstractMove::Ptr move, AbstractPosition::Ptr pos);
 147
 148   /** Warps to a new position */
 149   void warp(AbstractMove::Ptr lastMove, AbstractPosition::Ptr pos);
 150
 151   /** Adjusts a sprite to the correct position */
 152   void adjustSprite(const Point& p);
 153
 154   /** Sets the current turn */
 155   void setTurn(int turn);
 156
 157   /** Returns the position */
 158   AbstractPosition::Ptr position() const { return m_pos; }
 159 };
 160
 161
 162 #endif //GRAPHICALINFO_H