rainynite-studio/studio/canvas/abstract_canvas.h

/*  abstract_canvas.h - generic canvas which can be edited with tools
 *  Copyright (C) 2017-2018 caryoscelus
 *
 *  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 version 3 of the License, or
 *  (at your option) any later version.
 *
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef STUDIO_CANVAS_ABSTRACT_CANVAS_H_4C76BD67_5064_5848_A03E_71D95507C8B2
#define STUDIO_CANVAS_ABSTRACT_CANVAS_H_4C76BD67_5064_5848_A03E_71D95507C8B2

#include <core/std/memory.h>
#include <core/std/vector.h>
#include <core/std/map.h>
#include <core/std/string.h>

#include <QGraphicsView>

#include <generic/context_listener.h>

class QGraphicsScene;
class QGraphicsItem;

namespace rainynite::studio {

class AbstractCanvasEditor;
class CanvasTool;

/**
 * Base class for canvas editable with tools.
 *
 * Register editors with REGISTER_CANVAS_EDITOR macro
 * Register tools with REGISTER_CANVAS_TOOL macro
 *
 * You can subclass this to have a specific canvas with specific
 * tools and/or editors.
 */
class AbstractCanvas : public QGraphicsView, public ContextListener {
    Q_OBJECT

public:
    explicit AbstractCanvas(QWidget* parent = nullptr);
    virtual ~AbstractCanvas();

    /// Set an image to display below all editors and other elements
    void set_background_image(QPixmap const& pixmap);

    /// Set transform of background image
    void set_bg_transform(QTransform const& transform);

    /// Load registered tools for this canvas
    void load_registered_tools();

    /// Add new editor
    virtual void add_editor(shared_ptr<AbstractCanvasEditor> editor);

    /// Remove editor
    void remove_editor(shared_ptr<AbstractCanvasEditor> editor);

    /// Remove all editors
    void clear_editors();

    /// Get latest editor, if any
    shared_ptr<AbstractCanvasEditor> latest_editor() const;

    /// Get available tool names list
    vector<observer_ptr<CanvasTool>> list_tools() const;

    /// Switch to tool
    void use_tool(string const& name);

    /// Zoom at `point`
    void zoom_at(QPoint point, double factor);

    /// Set zoom level
    void set_zoom(double level);

    /// Zoom to show rect area
    void zoom_to_rect(QRectF rect);

    /// Mirror canvas horizontally (i.e. left-right, along Y axis)
    void mirror_horizontally(bool value);

    /// Return horizontal mirrored status
    bool is_mirrored_horizontally() const;

    /// Scroll by `delta` (in view coordinates)
    void scroll_by(QPointF delta);

    void set_context(shared_ptr<EditorContext> context) override;

Q_SIGNALS:
    void zoomed();

    void tool_changed(string const& tool);

protected:
    void mouseDoubleClickEvent(QMouseEvent* event) override;
    void mouseMoveEvent(QMouseEvent* event) override;
    void mousePressEvent(QMouseEvent* event) override;
    void mouseReleaseEvent(QMouseEvent* event) override;

    void wheelEvent(QWheelEvent* event) override;

    double zoom_level();

    vector<shared_ptr<AbstractCanvasEditor>> const& list_editors() const {
        return editors;
    }

    core::NodeTreeIndex active_node_index;

private:
    void add_tool(unique_ptr<CanvasTool> tool);
    bool use_tool(observer_ptr<CanvasTool> tool);

private:
    unique_ptr<QGraphicsScene> const the_scene;
    unique_ptr<QGraphicsPixmapItem> const image;
    vector<shared_ptr<AbstractCanvasEditor>> editors;
    vector<unique_ptr<CanvasTool>> tools;
    map<string, observer_ptr<CanvasTool>> named_tools;
    observer_ptr<CanvasTool> current_tool;
};

} // namespace rainynite::studio

#endif