File indexing completed on 2024-04-28 04:04:30

 /***************************************************************************
                           cannonsprite.h  -  description
                              -------------------
     begin                : 
     copyright            : (C) 2003-2007 by Gael de Chalendar
     email                : kleag@free.fr
  ***************************************************************************/
 
 /***************************************************************************
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either either version 2
    of the License, or (at your option) any later version.of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  *   02110-1301, USA
  ***************************************************************************/
 
 #ifndef KSIRKCANNONSPRITE_H
 #define KSIRKCANNONSPRITE_H
 
 #include "armysprite.h"
 
 namespace Ksirk {
 
 namespace GameLogic
 {
   class Country;
 }
 
 /**
   * A CannonSprite is an army sprite that represents ten armies
   * @author Gaël de Chalendar
   */
 class CannonSprite : public ArmySprite
 {
 public:
   /**
     * This simplified constructor allows to create a new @ref CannonSpritewith
     * default values for svg pool id and skin elements names
     * @param zoom The current zoom factor
     * @param aBackGnd The background giving info about the world geometry and
     * access to the underlying QGraphicsScene
     * @param visibility Measures how much this sprite is visible. It gives its
     * Z value on the graphics scene.
     */
   CannonSprite(double zoom,
                 BackGnd* aBackGnd,
                 unsigned int visibility = 200);
 
   /**
     * This constructor allows to create a new @ref CannonSprite whose images are
     * taken from the given svg pool element with the given number of frames and
     * number of look directions
     * @param svgid The id of the SVG element from which to load images
     * @param nbFrames The number of different frames in this sprite animation,
     * thus the number of columns in the sprite image
     * @param nbDirs The number of different views on the sprite,
     * thus the number of rows in the sprite image
     * @param zoom The current zoom factor
     * @param aBackGnd The background giving info about the world geometry and
     * access to the underlying QGraphicsScene
     * @param visibility Measures how much this sprite is visible. It gives its
     * Z value on the graphics scene.
     */
   CannonSprite(const QString &svgid,
                 unsigned int width,
                 unsigned int height,
                 unsigned int nbFrames,
                 unsigned int nbDirs,
                 double zoom,
                 BackGnd* aBackGnd,
                 unsigned int visibility = 200);
 
   /** The default destructor */
   ~CannonSprite() override {}
 
   /**
     * Gets the number of armies represented by a cannon: 10
     * @return the number of armies represented by a cannon: 10
     */
   inline unsigned int nbArmies() const override {return m_nbArmies;}
 
   /**
     * Overloads the AnimSprite method. This virtual function chooses the 
     * approach mode of a sprite towards its destination:
     * if the distance between the origin and the destination is higher than half
     * the size of the map and if the origin and destination countries 
     * comunicate, then the sprite should choose an approach by left or right,
     * through the edge of the map.
     * @param src The source country of the journey
     * @param dest The destination country of the journey
     * @param dpi The point where the army should go. 0 if should use the 
     * default (cannon point)
     */
   void setupTravel(GameLogic::Country* src, GameLogic::Country* dest, 
     const QPointF* dpi=nullptr) override;
 
 private:
   static const unsigned int m_nbArmies = 10;
 };
 
 }
 
 #endif