Shape.h

/*
 *  SPDX-FileCopyrightText: 2017 Wolthera van Hövell tot Westerflier <[email protected]>
 *
 *  SPDX-License-Identifier: LGPL-2.0-or-later
 */
#ifndef LIBKIS_SHAPE_H
#define LIBKIS_SHAPE_H
 
#include <QObject>
#include <KoShape.h>
 
#include "kritalibkis_export.h"
#include "libkis.h"
#include <kis_types.h>
 
/**
 * @brief The Shape class
 * The shape class is a wrapper around Krita's vector objects.
 *
 * Some example code to parse through interesting information in a given vector layer with shapes.
 * @code
import sys
from krita import *
 
doc = Application.activeDocument()
 
root = doc.rootNode()
 
for layer in root.childNodes():
    print (str(layer.type())+" "+str(layer.name()))
    if (str(layer.type())=="vectorlayer"):
        for shape in layer.shapes():
            print(shape.name())
            print(shape.toSvg())
 * @endcode
 */
class KRITALIBKIS_EXPORT Shape : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(Shape)
 
public:
    explicit Shape(KoShape *shape, QObject *parent = 0);
    ~Shape();
 
    bool operator==(const Shape &other) const;
    bool operator!=(const Shape &other) const;
 
public Q_SLOTS:
 
    /**
     * @brief name
     * @return the name of the shape
     */
    QString name() const;
 
    /**
     * @brief setName
     * @param name which name the shape should have.
     */
    void setName(const QString &name);
 
    /**
     * @brief type
     * @return the type of shape.
     */
    virtual QString type() const;
 
    /**
     * @brief zIndex
     * @return the zindex of the shape.
     */
    int zIndex() const;
 
    /**
     * @brief setZIndex
     * @param zindex set the shape zindex value.
     */
    void setZIndex(int zindex);
 
    /**
     * @brief selectable
     * @return whether the shape is user selectable.
     */
    bool selectable() const;
 
    /**
     * @brief setSelectable
     * @param selectable whether the shape should be user selectable.
     */
    void setSelectable(bool selectable);
 
    /**
     * @brief geometryProtected
     * @return whether the shape is protected from user changing the shape geometry.
     */
    bool geometryProtected() const;
 
    /**
     * @brief setGeometryProtected
     * @param protect whether the shape should be geometry protected from the user.
     */
    void setGeometryProtected(bool protect);
 
    /**
     * @brief visible
     * @return whether the shape is visible.
     */
    bool visible() const;
 
    /**
     * @brief setVisible
     * @param visible whether the shape should be visible.
     */
    void setVisible(bool visible);
 
    /**
     * @brief boundingBox the bounding box of the shape in points
     * @return RectF containing the bounding box.
     */
    QRectF boundingBox() const;
 
    /**
     * @brief position the position of the shape in points.
     * @return the position of the shape in points.
     */
    QPointF position() const;
 
    /**
     * @brief setPosition set the position of the shape.
     * @param point the new position in points
     */
    void setPosition(QPointF point);
 
    /**
     * @brief transformation the 2D transformation matrix of the shape.
     * @return the 2D transformation matrix.
     */
    QTransform transformation() const;
 
    /**
     * @brief setTransformation set the 2D transformation matrix of the shape.
     * @param matrix the new 2D transformation matrix.
     */
    void setTransformation(QTransform matrix);
 
    /**
     * @brief transformation the 2D transformation matrix of the shape including all grandparent transforms.
     * @return the 2D transformation matrix.
     */
    QTransform absoluteTransformation() const;
 
    /**
     * @brief remove delete the shape.
     */
    bool remove();
 
    /**
     * @brief update queue the shape update.
     */
    void update();
 
    /**
     * @brief updateAbsolute queue the shape update in the specified rectangle.
     * @param box the RectF rectangle to update.
     */
    void updateAbsolute(QRectF box);
 
    /**
     * @brief toSvg
     * convert the shape to svg, will not include style definitions.
     * @param prependStyles prepend the style data. Default: false
     * @param stripTextMode enable strip text mode. Default: true
     * @return the svg in a string.
     */
 
    QString toSvg(bool prependStyles = false, bool stripTextMode = true);
 
    /**
     * @brief select selects the shape.
     */
    void select();
 
    /**
     * @brief deselect deselects the shape.
     */
    void deselect();
 
    /**
     * @brief isSelected
     * @return whether the shape is selected.
     */
    bool isSelected();
 
    /**
     * @brief parentShape
     * @return the parent GroupShape of the current shape.
     */
    Shape* parentShape() const;
 
private:
    friend class GroupShape;
    friend class VectorLayer;
 
    struct Private;
    Private *const d;
 
    KoShape *shape();
};
 
#endif // LIBKIS_SHAPE_H