src/core/type.h

   1 /*
   2   Copyright (c) 2007 Paolo Capriotti <p.capriotti@gmail.com>
   3             (c) 2007 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 CORE__TYPE_H
  12 #define CORE__TYPE_H
  13
  14 #include <QString>
  15 #include "export.h"
  16
  17 class Piece;
  18 class Move;
  19 class IState;
  20
  21 /**
  22   * @brief A piece type.
  23   *
  24   * Piece types are associated to graphical representation of pieces,
  25   * and to movement rules.
  26   */
  27 class TAGUA_EXPORT IType {
  28 public:
  29   virtual ~IType();
  30
  31   /**
  32     * @return The name of this type.
  33     */
  34   virtual QString name() const = 0;
  35
  36   /**
  37     * Check if this piece type can perform a given move.
  38     * @param piece A piece of this type.
  39     * @param target The piece that would be captured by the move.
  40     * @param move The move to be checked.
  41     * @param state The state in which @a move is to be played.
  42     */
  43   virtual bool canMove(const Piece& piece, const Piece& target,
  44                        Move& move, const IState* state) const = 0;
  45
  46   /**
  47     * A symbolic index associated to this type.
  48     * This is not required to uniquely identify the type.
  49     * It can be used to sort a collection of types.
  50     */
  51   virtual int index() const = 0;
  52 };
  53
  54 #endif // CORE__TYPE_H
  55