src/core/behaviour.h

   1 /*
   2   Copyright (c) 2007 Paolo Capriotti <p.capriotti@gmail.com>
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8 */
   9
  10 #ifndef CORE__BEHAVIOUR_H
  11 #define CORE__BEHAVIOUR_H
  12
  13 #include "component.h"
  14 #include "export.h"
  15 #include "point.h"
  16
  17 class IColor;
  18 class IState;
  19 class Move;
  20
  21 /**
  22   * @brief Encapsulates general rules on piece movement.
  23   */
  24 class TAGUA_EXPORT IBehaviour: public Component {
  25 Q_OBJECT
  26 public:
  27   virtual ~IBehaviour();
  28
  29   /**
  30     * Perform a capture on a given square. In variants with drops, this
  31     * adds the captured piece to the opponent pool. In games like chess,
  32     * this does nothing.
  33     */
  34   virtual void captureOn(IState* state, const Point& square) const = 0;
  35
  36   /**
  37     * Set the moving piece in its destination square, without affecting
  38     * the current turn or flags.
  39     * This is a helper function normally called by move.
  40     */
  41   virtual void move(IState* state, const Move& m) const = 0;
  42
  43   /**
  44     * Set next turn as the current turn.
  45     */
  46   virtual void advanceTurn(IState* state) const = 0;
  47
  48   /**
  49     * @return The square where a given move would capture if executed.
  50     */
  51   virtual Point captureSquare(const IState* state, const Move& m) const = 0;
  52
  53   /**
  54     * @return The opponent of @a color.
  55     */
  56   virtual const IColor* opponent(const IColor* player) const = 0;
  57
  58   /**
  59     * Players can have associated directions. For example, in chess,
  60     * white pieces move towards the 8th rank.
  61     * Associated directions are often used during move validation.
  62     * @return Direction associated with @a player.
  63     */
  64   virtual Point direction(const IColor* player) const = 0;
  65
  66   virtual void setDelegator(IBehaviour* behaviour) = 0;
  67 };
  68
  69 #endif // CORE__BEHAVIOUR_H