valentina/src/geometry/vsplinepath.h

/************************************************************************
 **
 **  @file   vsplinepath.h
 **  @author Roman Telezhinsky <dismine@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 VSPLINEPATH_H
#define VSPLINEPATH_H

#include "vsplinepoint.h"
#include "vpointf.h"
#include "vspline.h"
#include "vgobject.h"
#include <QApplication>
#include "../container/vcontainer.h"

namespace SplinePoint
{
    /**
     * @brief The Position enum position in spline.
     */
    enum Position { FirstPoint, LastPoint };
    Q_DECLARE_FLAGS(Positions, Position)
}
Q_DECLARE_OPERATORS_FOR_FLAGS( SplinePoint::Positions )

/**
 * @brief The VSplinePath class keep information about splinePath.
 */
class VSplinePath :public VGObject
{
    Q_DECLARE_TR_FUNCTIONS(VSplinePath)
public:
    /**
     * @brief VSplinePath constructor.
     * @param kCurve coefficient of curvature spline path.
     * @param idObject parent id.
     * @param mode mode creation spline path.
     */
    VSplinePath(qreal kCurve = 1, quint32 idObject = 0, Draw::Draws mode = Draw::Calculation);
    /**
     * @brief VSplinePath copy constructor.
     * @param splPath spline path.
     */
    VSplinePath(const VSplinePath& splPath);
    /**
     * @brief append add point in the end of list points.
     * @param point new point.
     */
    void          append(const VSplinePoint &point);
    /**
     * @brief Count return count point.
     * @return count.
     */
    qint32        Count() const;
    /**
     * @brief CountPoint return count point.
     * @return count.
     */
    qint32        CountPoint() const;
    /**
     * @brief GetSpline return spline by index.
     * @param index index spline in spline path.
     * @return spline
     */
    VSpline       GetSpline(qint32 index) const;
    /**
     * @brief GetPath return QPainterPath which reprezent spline path.
     * @return path.
     */
    QPainterPath     GetPath() const;
    /**
     * @brief GetPathPoints return list of points what located on path.
     * @return list.
     */
    QVector<QPointF> GetPathPoints() const;
    /**
     * @brief GetSplinePath return list with spline points.
     * @return list.
     */
    QVector<VSplinePoint> GetSplinePath() const;
    /**
     * @brief GetLength return length of spline path.
     * @return length.
     */
    qreal         GetLength() const;
    /**
     * @brief UpdatePoint update spline point in list.
     * @param indexSpline spline index in list.
     * @param pos position point in spline.
     * @param point point.
     */
    void          UpdatePoint(qint32 indexSpline, const SplinePoint::Position &pos, const VSplinePoint &point);
    /**
     * @brief GetSplinePoint return spline point from list.
     * @param indexSpline spline index in list.
     * @param pos position point in spline.
     * @return spline point.
     */
    VSplinePoint  GetSplinePoint(qint32 indexSpline, SplinePoint::Position pos) const;
    /**
     * @brief Clear clear list of points.
     */
    void          Clear();
    /**
     * @brief getKCurve return coefficient of curvature spline path.
     * @return coefficient of curvature spline.
     */
    qreal         getKCurve() const;
    /**
     * @brief setKCurve set coefficient of curvature spline path.
     * @param value coefficient of curvature spline path.
     */
    void          setKCurve(const qreal &value);
    /**
     * @brief GetPoint pointer to list spline point.
     * @return list.
     */
    const  QVector<VSplinePoint> *GetPoint() const;
    /**
     * @brief operator = assignment operator.
     * @param path spline path.
     * @return spline path.
     */
    VSplinePath   &operator=(const VSplinePath &path);
    /**
     * @brief operator [] return spline point by index.
     * @param indx index in list.
     * @return spline point.
     */
    VSplinePoint  &operator[](ptrdiff_t indx);
    /**
     * @brief at return spline point by index.
     * @param indx index in list.
     * @return spline point.
     */
    const VSplinePoint &at(ptrdiff_t indx) const;
    /**
     * @brief CutSplinePath cut spline path into two. This method don't return two spline path. You must create spline
     * paths by yourself.
     * Example:
     * QPointF spl1p2, spl1p3, spl2p2, spl2p3;
     * qint32 p1 = 0, p2 = 0;
     * QPointF point = splPath->CutSplinePath(length, p1, p2, spl1p2, spl1p3, spl2p2, spl2p3);
     *
     * VSplinePoint splP1 = splPath->at(p1);
     * VSplinePoint splP2 = splPath->at(p2);
     * VSpline spl1 = VSpline(splP1.P(), spl1p2, spl1p3, *p, splPath->getKCurve());
     * VSpline spl2 = VSpline(*p, spl2p2, spl2p3, splP2.P(), splPath->getKCurve());
     * @param length length first spline path.
     * @param p1 index first spline point in list.
     * @param p2 index second spline point in list.
     * @param spl1p2 first control point first spline.
     * @param spl1p3 second control point first spline.
     * @param spl2p2 first control point second spline.
     * @param spl2p3 second control point second spline.
     * @return cutting point.
     */
    QPointF       CutSplinePath(qreal length, qint32 &p1, qint32 &p2, QPointF &spl1p2, QPointF &spl1p3, QPointF &spl2p2,
                                QPointF &spl2p3) const;
    /**
     * @brief name return spline path name.
     * @return name.
     */
    virtual QString name() const{return _name;}
    /**
     * @brief getMaxCountPoints return max count of points what can have spline path. This method use tool union detail.
     * Because cutting point can change position spline can have diffirent count of points. Need know max value. This
     * value stored from cuted spline path.
     * @return count.
     */
    qint32 getMaxCountPoints() const;
    /**
     * @brief setMaxCountPoints set max count points from cuted spline path.
     * @param value max count.
     */
    void setMaxCountPoints(const qint32 &value);
protected:
    /**
     * @brief path list spline point.
     */
    QVector<VSplinePoint> path;
    /**
     * @brief kCurve coefficient of curvature spline.
     */
    qreal         kCurve;
    /**
     * @brief maxCountPoints max count of points what can have spline path.
     */
    qint32        maxCountPoints;
};

inline qint32 VSplinePath::CountPoint() const
{
    return path.size();
}

inline QVector<VSplinePoint> VSplinePath::GetSplinePath() const
{
    return path;
}

inline void VSplinePath::Clear()
{
    path.clear();
}

inline qreal VSplinePath::getKCurve() const
{
    return kCurve;
}

inline void VSplinePath::setKCurve(const qreal &value)
{
    kCurve = value;
}

inline const QVector<VSplinePoint> *VSplinePath::GetPoint() const
{
    return &path;
}

#endif // VSPLINEPATH_H