From 311be1cd9ceb8c0ad871f2db2b209d36be489ece Mon Sep 17 00:00:00 2001 From: dismine Date: Tue, 21 Jan 2014 20:00:37 +0200 Subject: [PATCH] Documentation for VSplinePath class. --HG-- branch : develop --- src/geometry/vsplinepath.h | 142 +++++++++++++++++++++++-------------- 1 file changed, 89 insertions(+), 53 deletions(-) diff --git a/src/geometry/vsplinepath.h b/src/geometry/vsplinepath.h index 0a1b32b9e..890689abf 100644 --- a/src/geometry/vsplinepath.h +++ b/src/geometry/vsplinepath.h @@ -39,7 +39,7 @@ namespace SplinePoint { /** - * @brief The Position enum + * @brief The Position enum position in spline. */ enum Position { FirstPoint, LastPoint }; Q_DECLARE_FLAGS(Positions, Position) @@ -47,132 +47,168 @@ namespace SplinePoint Q_DECLARE_OPERATORS_FOR_FLAGS( SplinePoint::Positions ) /** - * @brief The VSplinePath клас, що розраховує шлях сплайнів. + * @brief The VSplinePath class keep information about splinePath. */ class VSplinePath :public VGObject { Q_DECLARE_TR_FUNCTIONS(VSplinePath) public: /** - * @brief VSplinePath конструктор по замовчуванню. + * @brief VSplinePath constructor. + * @param kCurve coefficient of curvature spline path. + * @param idObject parent id. + * @param mode mode creation spline path. */ VSplinePath(qreal kCurve = 1, qint64 idObject = 0, Draw::Draws mode = Draw::Calculation); /** - * @brief VSplinePath - * @param splPath + * @brief VSplinePath copy constructor. + * @param splPath spline path. */ VSplinePath(const VSplinePath& splPath); /** - * @brief append додає точку сплайну до шляху. - * @param point точка. + * @brief append add point in the end of list points. + * @param point new point. */ void append(const VSplinePoint &point); /** - * @brief Count - * @return + * @brief Count return count point. + * @return count. */ qint32 Count() const; /** - * @brief CountPoint - * @return + * @brief CountPoint return count point. + * @return count. */ inline qint32 CountPoint() const {return path.size();} /** - * @brief GetSpline - * @param index - * @return + * @brief GetSpline return spline by index. + * @param index index spline in spline path. + * @return spline */ VSpline GetSpline(qint32 index) const; /** - * @brief GetPath - * @return + * @brief GetPath return QPainterPath which reprezent spline path. + * @return path. */ QPainterPath GetPath() const; /** - * @brief GetPathPoints - * @return + * @brief GetPathPoints return list of points what located on path. + * @return list. */ QVector GetPathPoints() const; /** - * @brief GetSplinePath - * @return + * @brief GetSplinePath return list with spline points. + * @return list. */ inline QVector GetSplinePath() const {return path;} /** - * @brief GetLength - * @return + * @brief GetLength return length of spline path. + * @return length. */ qreal GetLength() const; /** - * @brief UpdatePoint - * @param indexSpline - * @param pos - * @param point + * @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 - * @param indexSpline - * @param pos - * @return + * @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 очищає шлях сплайнів. + * @brief Clear clear list of points. */ inline void Clear() {path.clear();} /** - * @brief getKCurve - * @return + * @brief getKCurve return coefficient of curvature spline path. + * @return coefficient of curvature spline. */ inline qreal getKCurve() const {return kCurve;} /** - * @brief setKCurve - * @param value + * @brief setKCurve set coefficient of curvature spline path. + * @param value coefficient of curvature spline path. */ inline void setKCurve(const qreal &value) {kCurve = value;} /** - * @brief GetPoint - * @return + * @brief GetPoint pointer to list spline point. + * @return list. */ inline const QVector *GetPoint() const {return &path;} /** - * @brief operator = - * @param path - * @return + * @brief operator = assignment operator. + * @param path spline path. + * @return spline path. */ VSplinePath &operator=(const VSplinePath &path); /** - * @brief operator [] - * @param indx - * @return + * @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 - * @param length - * @param p1 - * @param p2 - * @param spl1p3 - * @param spl2p2 - * @return + * @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 вектор з точок сплайна. + * @brief path list spline point. */ QVector path; /** - * @brief kCurve + * @brief kCurve coefficient of curvature spline. */ qreal kCurve; + /** + * @brief maxCountPoints max count of points what can have spline path. + */ qint32 maxCountPoints; };