File indexing completed on 2024-05-26 04:08:16

 /***************************************************************************
  *   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_SCENE_H
 #define TAGARO_SCENE_H
 
 #include <QGraphicsScene>
 
 class KGameRenderer;
 class KGameRendererClient;
 
 namespace Tagaro {
 
 /**
  * @class Tagaro::Scene scene.h <Tagaro/Scene>
  * @brief QGraphicsScene with automatic viewport transform adjustments
  *
  * This QGraphicsScene subclass provides integration with Tagaro and 
  * miscellaneous convenience features:
  * @li It acts as a Tagaro::RendererClient to fetch a scene background pixmap.
  * @li It can be used to keep the QGraphicsScene's sceneRect() in sync
  *     with the rect() of a QGraphicsView instance (the "main view").
  */
 class Scene : public QGraphicsScene
 {
     Q_OBJECT
     public:
         ///Creates a new Tagaro::Scene instance.
         explicit Scene(QObject* parent = nullptr);
         ///@overload
         ///Initializes the renderer client for the scene background brush with
         ///the given renderer and sprite key.
         Scene(KGameRenderer* backgroundRenderer, const QString& backgroundSpriteKey, QObject* parent = nullptr);
         ///Destroys this Tagaro::Scene instance.
         ~Scene() override;
 
         ///@return the main view of this scene
         QGraphicsView* mainView() const;
         ///Sets the main view of this scene (null by default). If set, the
         ///scene's sceneRect() will always be set equal to the view's rect().
         ///The scene will then suppress manual changes to the sceneRect() as
         ///much as possible.
         ///
         ///This will also install this scene on the @a mainView. The behavior is
         ///undefined if you set another scene on this view while it is this
         ///scene's main view.
         void setMainView(QGraphicsView* mainView);
 
         ///@return the renderer client for the scene's background brush
         ///Use this to modify the background brush.
         ///@warning Do not call setRenderSize() on this instance! The render
         ///size is managed by the scene. Use setBackgroundBrushRenderSize()
         ///instead.
         KGameRendererClient* backgroundBrushClient() const;
         ///@return the background brush's render size
         ///
         ///If the render size is determined from the size of the sceneRect()
         ///(the default), returns an invalid size. To determine the actual
         ///render size, use backgroundBrushClient()->renderSize().
         QSize backgroundBrushRenderSize() const;
         ///Sets the background brush's render size. If you set this to a valid
         ///size, the background will be painted as a tiled pixmap of that size.
         ///If an invalid size is set (the default), determine the actual render
         ///size from the sceneRect().
         void setBackgroundBrushRenderSize(const QSize& size);
     protected:
         bool eventFilter(QObject* watched, QEvent* event) override;
     private:
         struct Private;
         Private* const d;
         Q_PRIVATE_SLOT(d, void _k_updateSceneRect(const QRectF&))
 };
 
 } //namespace Tagaro
 
 #endif // TAGARO_SCENE_H