File indexing completed on 2024-12-22 03:51:25

 /***************************************************************************
  *   Copyright 2010 Stefan Majewsky <majewsky@gmx.net>                     *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU Library General Public License          *
  *   version 2 as published by the Free Software Foundation                *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  *   GNU Library General Public License for more details.                  *
  *                                                                         *
  *   You should have received a copy of the GNU Library 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 TAGARO_SPRITEOBJECTITEM_H
 #define TAGARO_SPRITEOBJECTITEM_H
 
 #include <QGraphicsItem>
 
 #include <KGameRendererClient>
 
 namespace Tagaro {
 
 /**
  * @class Tagaro::SpriteObjectItem spriteobjectitem.h <Tagaro/SpriteObjectItem>
  * @short A QGraphicsObject which displays pixmaps from a Tagaro::Renderer.
  *
  * This item displays a pixmap which is retrieved from a Tagaro::Renderer, and
  * is updated automatically when the Tagaro::Renderer changes the theme.
  *
  * The item has built-in handling for animated sprites (i.e. those with multiple
  * frames). It is a QGraphicsObject and exposes a "frame" property, so you can
  * easily run the animation by plugging in a QPropertyAnimation.
  *
  * The most important difference to Tagaro::SpriteItem, which is a classic
  * QGraphicsPixmapItem, is that the bounding rectangle of this item is fixed
  * to QRectF(offset(), size()). The rendered pixmap is scaled to fit into this
  * bounding rectangle, regardless of its render size.
  *
  * To automatically adjust the render size to the physical coordinate system of
  * a QGraphicsView, insert the Tagaro::SpriteObjectItem into a Tagaro::Board.
  */
 class SpriteObjectItem : public QGraphicsObject, public KGameRendererClient
 {
     Q_OBJECT
     Q_PROPERTY(int frame READ frame WRITE setFrame)
     Q_PROPERTY(QPointF offset READ offset WRITE setOffset)
     Q_PROPERTY(QSize renderSize READ renderSize WRITE setRenderSize)
     Q_PROPERTY(QSizeF size READ size WRITE setSize NOTIFY sizeChanged)
     Q_PROPERTY(QString spriteKey READ spriteKey WRITE setSpriteKey)
     public:
         ///Creates a new Tagaro::SpriteObjectItem which renders the sprite with
         ///the given @a spriteKey as provided by the given @a renderer.
         SpriteObjectItem(KGameRenderer* renderer, const QString& spriteKey, QGraphicsItem* parent = nullptr);
         ~SpriteObjectItem() override;
 
         ///@return the item's offset, which defines the point of the top-left
         ///corner of the bounding rect, in local coordinates.
         QPointF offset() const;
         ///Sets the item's offset, which defines the point of the top-left
         ///corner of the bounding rect, in local coordinates.
         void setOffset(const QPointF& offset);
         ///@overload
         inline void setOffset(qreal x, qreal y);
         ///@return the size of the item's bounding rect
         QSizeF size() const;
         ///Sets the size of the item's bounding rect. The rendered pixmap is
         ///scaled to fit in this size, regardless of the render size.
         void setSize(const QSizeF& size);
         ///@overload
         inline void setSize(qreal width, qreal height);
 
         //QGraphicsItem reimplementations (see comment in source file for why we need all of this)
         QRectF boundingRect() const override;
         bool contains(const QPointF& point) const override;
         bool isObscuredBy(const QGraphicsItem* item) const override;
         QPainterPath opaqueArea() const override;
         void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
         QPainterPath shape() const override;
     Q_SIGNALS:
         ///This signal is emitted when the size of the item's bounding rect
         ///changes.
         void sizeChanged(const QSizeF& size);
     protected:
         void receivePixmap(const QPixmap& pixmap) override;
     private:
         class Private;
         Private* const d;
 };
 
 } //namespace Tagaro
 
 void Tagaro::SpriteObjectItem::setOffset(qreal x, qreal y)
 {
     setOffset(QPointF(x, y));
 }
 
 void Tagaro::SpriteObjectItem::setSize(qreal w, qreal h)
 {
     setSize(QSizeF(w, h));
 }
 
 #endif // TAGARO_SPRITEOBJECTITEM_H