valentina/src/app/tools/drawTools/vtoolsplinepath.h

/************************************************************************
 **
 **  @file   vtoolsplinepath.h
 **  @author Roman Telezhynskyi <dismine(at)gmail.com>
 **  @date   November 15, 2013
 **
 **  @brief
 **  @copyright
 **  This source code is part of the Valentine project, a pattern making
 **  program, whose allow create and modeling patterns of clothing.
 **  Copyright (C) 2013 Valentina project
 **  <https://bitbucket.org/dismine/valentina> All Rights Reserved.
 **
 **  Valentina 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.
 **
 **  Valentina 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 Valentina.  If not, see <http://www.gnu.org/licenses/>.
 **
 *************************************************************************/

#ifndef VTOOLSPLINEPATH_H
#define VTOOLSPLINEPATH_H

#include "vabstractspline.h"

/**
 * @brief The VToolSplinePath class tool for creation spline path.
 */
class VToolSplinePath:public VAbstractSpline
{
    Q_OBJECT
public:
                  /**
                   * @brief VToolSplinePath constructor.
                   * @param doc dom document container.
                   * @param data container with variables.
                   * @param id object id in container.
                   * @param typeCreation way we create this tool.
                   * @param parent parent object.
                   */
                  VToolSplinePath(VPattern *doc, VContainer *data, quint32 id, const Source &typeCreation,
                                  QGraphicsItem * parent = nullptr);
     /**
      * @brief setDialog set dialog when user want change tool option.
      */
     virtual void    setDialog();
     /**
      * @brief Create help create tool from GUI.
      * @param dialog dialog.
      * @param scene pointer to scene.
      * @param doc dom document container.
      * @param data container with variables.
      */
     static void  Create(DialogTool *dialog, VMainGraphicsScene  *scene, VPattern *doc, VContainer *data);
     /**
      * @brief Create help create tool.
      * @param _id tool id, 0 if tool doesn't exist yet.
      * @param path spline path.
      * @param scene pointer to scene.
      * @param doc dom document container.
      * @param data container with variables.
      * @param parse parser file mode.
      * @param typeCreation way we create this tool.
      */
     static void  Create(const quint32 _id, VSplinePath *path, VMainGraphicsScene  *scene,
                         VPattern *doc, VContainer *data, const Document &parse,
                         const Source &typeCreation);
     static const QString ToolType;
     /**
      * @brief UpdatePathPoint update spline path in pattern file.
      * @brief doc dom document container.
      * @param node tag in file.
      * @param path spline path.
      */
     static void  UpdatePathPoint(VPattern *doc, QDomNode& node, const VSplinePath &path);
signals:
    /**
     * @brief RefreshLine refresh control line.
     * @param indexSpline position spline in spline list.
     * @param pos position point in spline.
     * @param controlPoint new position control point.
     * @param splinePoint new position spline point.
     */
    void             RefreshLine(const qint32 &indexSpline, SplinePointPosition pos,
                                 const QPointF &controlPoint, const QPointF &splinePoint);
    /**
     * @brief setEnabledPoint disable control points.
     * @param enable enable or diasable points.
     */
    void             setEnabledPoint(bool enable);
public slots:
    /**
     * @brief ControlPointChangePosition handle change position control point.
     * @param indexSpline position spline in spline list.
     * @param position position point in spline.
     * @param pos new position.
     */
    void             ControlPointChangePosition(const qint32 &indexSpline, const SplinePointPosition &position,
                                                const QPointF &pos);
protected:
    /**
     * @brief contextMenuEvent handle context menu events.
     * @param event context menu event.
     */
    virtual void     contextMenuEvent ( QGraphicsSceneContextMenuEvent * event );
    /**
     * @brief AddToFile add tag with informations about tool into file.
     */
    virtual void     AddToFile();
    /**
     * @brief RefreshDataInFile refresh attributes in file. If attributes don't exist create them.
     */
    virtual void     RefreshDataInFile();
    /**
     * @brief mouseReleaseEvent  handle mouse release events.
     * @param event mouse release event.
     */
    virtual void     mouseReleaseEvent ( QGraphicsSceneMouseEvent * event );
    /**
     * @brief RemoveReferens decrement value of reference.
     */
    virtual void     RemoveReferens();
    /**
     * @brief SaveDialog save options into file after change in dialog.
     */
    virtual void     SaveDialog(QDomElement &domElement);
private:
    /**
     * @brief RefreshGeometry  refresh item on scene.
     */
    void             RefreshGeometry();
    /**
     * @brief AddPathPoint write path point to pattern file.
     * @param domElement dom element.
     * @param splPoint spline path point.
     */
    void             AddPathPoint(QDomElement &domElement, const VSplinePoint &splPoint);
    /**
     * @brief UpdateControlPoints update position points control points in file.
     * @param spl spline what was changed.
     * @param splPath spline path.
     * @param indexSpline index spline in spline path.
     */
    void             UpdateControlPoints(const VSpline &spl, VSplinePath &splPath, const qint32 &indexSpline) const;
    void             RefreshSplinePath(VSplinePath &splPath);
};

#endif // VTOOLSPLINEPATH_H