File indexing completed on 2024-04-14 04:02:25

 /*
     This file is part of the KDE games lskat program
     SPDX-FileCopyrightText: 2006 Martin Heni <kde@heni-online.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef PIXMAP_SPRITE_H
 #define PIXMAP_SPRITE_H
 
 // Qt includes
 #include <QPointF>
 #include <QGraphicsPixmapItem>
 
 // Local includes
 #include "thememanager.h"
 
 /**
  * This sprite is used to display a pixmap on the canvas.
  * It can be animated and it is themable.
  */
 class PixmapSprite : public QGraphicsPixmapItem, public virtual Themable
 {
 public:
     /**
      * Constructor for the sprite.
      * @param advancePeriod The advance period time [ms]
      * @param no            A user defined ID number
      * @param scene        The graphics scene
      */
     PixmapSprite(int advancePeriod, int no, QGraphicsScene *scene);
 
     /**
      * Constructor for the sprite.
      * @param id            The theme file ID string
      * @param theme         The theme manager
      * @param advancePeriod The advance period time [ms]
      * @param no            A user defined ID number
      * @param scene        The graphics scene
      */
     PixmapSprite(const QString &id, ThemeManager *theme, int advancePeriod, int no, QGraphicsScene *scene);
 
     /**
      * Possible animation states of the sprite
      */
     enum AnimationState {Idle, Animated};
 
     /**
      * Standard QGI advance function.
      * @param phase The advance phase
      */
     void advance(int phase) override;
 
     /**
      * Retrieve the type of QGI. This item is UserType+3
      * @return The type of item.
      */
     int type() const override {return QGraphicsItem::UserType + 3;}
 
     /**
      * Retrieve the user defined sprite number (i.e. which PixmapSprite)
      * @return The sprite numbers.
      */
     int number() {return mNo;}
 
     /**
      * Main theme manager function. Called when any theme change like
      * a new theme or a theme size change occurs. This object needs to
      * resize and redraw then.
      */
     void changeTheme() override;
 
     /**
      * Choose a pixmap frame of this sprite. If the setting is forced a
      * redraw is even performed when the frame number stays the same. This
      * is important for theme changes.
      * @param no    The new frame number (0..)
      * @param force Force redraw
      */
     void setFrame(int no, bool force = false);
 
     /**
      * Initialize and start a frame animation between the start and end frame.
      * The delay between the frames is given in [ms]. After the last frame
      * is displayed the animation starts with the first frame.
      * @param start   The start frame number
      * @param end     The end frame number
      * @param delay   Delay between a frame change [ms]
      */
     void setAnimation(int start, int end, int delay);
 
     /**
      * Start or stop an animation.
      * @param status True to start and false to stop the animation
      */
     void setAnimation(bool status);
 
     /**
      * Set/Move the sprite to the given position. The position is
      * given in relative coordinates [0..1, 0..1] to its parent object.
      * Thus the position is scaled with the scale from the theme manager.
      * @param pos  The position of the sprite [0..1, 0..1]
      */
     void setPosition(const QPointF &pos);
 
     /**
      * Reads a theme configuration item of type double and of the given name.
      * @deprecated This is debug only
      * @param item  The theme configuration item name
      * @return The read double value.
      */
     double getDoubleValue(const QString &item);
 
     /**
      * Set whether the sprite should respect a theme offset (default: true)
      * or not (false), that is, it is handled by its parent item.
      * @param status True: Handle theme offset, False: don't
      */
     void setOffsetStatus(bool status);
 
 protected:
     /** The user defined sprite number.*/
     int mNo;
 
     /** The canvas advance period (e.g. 25) [ms] */
     int mAdvancePeriod;
 
     /** The theme id. */
     QString mId;
 
     /** The state of the animation. */
     AnimationState mAnimationState;
 
     /** The position of the sprite [rel 0..1, rel 0..1] */
     QPointF mStart;
 
     /** The first frame in the frame animation. */
     int mStartFrame;
 
     /** The last frame in the frame animation. */
     int mEndFrame;
 
     /** The delay between two frames in the frame animation. */
     int mDelay;
 
     /** The current running time for the animation. */
     int mTime;
 
     /** The current running frame number for the animation. */
     int mCurrentFrame;
 
     /** Storage of the frame pixmaps. */
     QList<QPixmap> mFrames;
 
     /** Storage of the frame pixmap offset points. */
     QList<QPointF> mHotspots;
 
     /** Offset status. */
     bool mOffsetStatus;
 };
 
 #endif