src/graphicalapi.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 GRAPHICALAPI_H
  12 #define GRAPHICALAPI_H
  13
  14 #include <boost/shared_ptr.hpp>
  15 #include "kboard.h"
  16 #include "pointconverter.h"
  17 #include "sprite.h"
  18
  19 typedef boost::shared_ptr<class Sprite> SpritePtr;
  20
  21 /**
  22   * This class defines the interface that will be used by the animator to modify
  23   * kboard graphics.
  24   */
  25 class GraphicalAPI {
  26 public:
  27   virtual ~GraphicalAPI(){}
  28
  29   /**
  30     * \return the current abstract position.
  31     */
  32   virtual const PointConverter* converter() const = 0;
  33
  34   /**
  35     * \return the current abstract position.
  36     */
  37   virtual AbstractPosition::Ptr position() const = 0;
  38
  39   /**
  40     * \return a sprite at the position \a index in the graphical pool.
  41     */
  42   virtual SpritePtr getSprite(const Point& p) = 0;
  43
  44   /**
  45     * Removes a sprite at the position \a index in the graphical pool.
  46     * \return the newly created sprite.
  47     */
  48   virtual SpritePtr takeSprite(const Point& p) = 0;
  49
  50   /**
  51     * Sets the sprite at the position \a index in the graphical pool.
  52     * \return the newly created sprite.
  53     */
  54   virtual SpritePtr setSprite(const Point& p, const AbstractPiece* piece, bool use_drop, bool show) = 0;
  55
  56   /**
  57     * \return how many sprites are contained in the pool
  58     */
  59   virtual int poolSize(int pool) = 0;
  60
  61   /**
  62     * \return the sprite at the position \a index in the graphical pool.
  63     */
  64   virtual SpritePtr getPoolSprite(int pool, int index) = 0;
  65
  66   /**
  67     * Removes the sprite at the position \a index in the graphical pool.
  68     * \return the removed sprite.
  69     */
  70   virtual SpritePtr takePoolSprite(int pool, int index) = 0;
  71
  72   /**
  73     * Inserts a sprite at the position \a index in the graphical pool.
  74     * \return the newly created sprite.
  75     */
  76   virtual SpritePtr insertPoolSprite(int pool, int index, const AbstractPiece* piece) = 0;
  77 };
  78
  79 #endif //GRAPHICALAPI_H