diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-04-30 10:50:57 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-05-01 00:58:27 +0300 |
commit | 1e8697cd8094183a3f356bf8564284a31ffb89fc (patch) | |
tree | 554b1ac7856f3f168c58476ce53d1953beaa760e /source/blender/freestyle/intern/stroke/Stroke.h | |
parent | 5ca8ac51d04c6feb9d29d75fb2525168d30fbe74 (diff) |
Cleanup: comments (long lines) in freestyle
Diffstat (limited to 'source/blender/freestyle/intern/stroke/Stroke.h')
-rw-r--r-- | source/blender/freestyle/intern/stroke/Stroke.h | 37 |
1 files changed, 18 insertions, 19 deletions
diff --git a/source/blender/freestyle/intern/stroke/Stroke.h b/source/blender/freestyle/intern/stroke/Stroke.h index 3eae5e91b6a..ec722516d2a 100644 --- a/source/blender/freestyle/intern/stroke/Stroke.h +++ b/source/blender/freestyle/intern/stroke/Stroke.h @@ -143,8 +143,8 @@ class StrokeAttribute { } /*! Returns the attribute's thickness. - * \return an array of 2 floats. the first value is the thickness on the right of the vertex when following - * the stroke, the second one is the thickness on the left. + * \return an array of 2 floats. the first value is the thickness on the right of the vertex + * when following the stroke, the second one is the thickness on the left. */ inline const float *getThickness() const { @@ -163,7 +163,8 @@ class StrokeAttribute { return _thickness[1]; } - /*! Returns the thickness on the right and on the left of the vertex when following the stroke. */ + /*! Returns the thickness on the right and on the left of the vertex when following the stroke. + */ inline Vec2f getThicknessRL() const { return Vec2f(_thickness[0], _thickness[1]); @@ -462,8 +463,8 @@ class StrokeVertex : public CurvePoint { _CurvilignAbscissa = iAbscissa; } - /*! sets the Stroke's length (it's only a value stored by the Stroke Vertex, it won't change the real - * Stroke's length.) + /*! sets the Stroke's length (it's only a value stored by the Stroke Vertex, it won't change the + * real Stroke's length.) */ inline void setStrokeLength(float iLength) { @@ -498,7 +499,8 @@ class StrokeVertexIterator; /*! Class to define a stroke. * A stroke is made of a set of 2D vertices (StrokeVertex), regularly spaced out. * This set of vertices defines the stroke's backbone geometry. - * Each of these stroke vertices defines the stroke's shape and appearance at this vertex position. + * Each of these stroke vertices defines the stroke's shape and appearance at this vertex + * position. */ class Stroke : public Interface1D { public: // Implementation of Interface1D @@ -532,7 +534,7 @@ class Stroke : public Interface1D { const_vertex_iterator; public: - //typedef StrokeVertex vertex_type; + // typedef StrokeVertex vertex_type; private: vertex_container _Vertices; //! The stroke's backbone vertices @@ -575,8 +577,8 @@ class Stroke : public Interface1D { Stroke &operator=(const Stroke &iBrother); /*! Compute the sampling needed to get iNVertices vertices. - * If the specified number of vertices is less than the actual number of vertices, the actual sampling value - * is returned. (To remove Vertices, use the RemoveVertex() method of this class). + * If the specified number of vertices is less than the actual number of vertices, the actual + * sampling value is returned. (To remove Vertices, use the RemoveVertex() method of this class). * \param iNVertices: * The number of StrokeVertices we eventually want in our Stroke. * \return the sampling that must be used in the Resample(float) method. @@ -586,11 +588,10 @@ class Stroke : public Interface1D { float ComputeSampling(int iNVertices); /*! Resampling method. - * Resamples the curve so that it eventually has iNPoints. That means it is going to add iNPoints-vertices_size, - * if vertices_size is the number of points we already have. - * If vertices_size >= iNPoints, no resampling is done. - * \param iNPoints: - * The number of vertices we eventually want in our stroke. + * Resamples the curve so that it eventually has iNPoints. That means it is going to add + * iNPoints-vertices_size, if vertices_size is the number of points we already have. If + * vertices_size >= iNPoints, no resampling is done. \param iNPoints: The number of vertices we + * eventually want in our stroke. */ int Resample(int iNPoints); @@ -838,11 +839,9 @@ class Stroke : public Interface1D { const_vertex_iterator vertices_end() const; vertex_iterator vertices_end(); - /*! Returns a StrokeVertexIterator pointing on the first StrokeVertex of the Stroke. One can specify a sampling - * value to resample the Stroke on the fly if needed. - * \param t: - * The resampling value with which we want our Stroke to be resampled. - * If 0 is specified, no resampling is done. + /*! Returns a StrokeVertexIterator pointing on the first StrokeVertex of the Stroke. One can + * specify a sampling value to resample the Stroke on the fly if needed. \param t: The resampling + * value with which we want our Stroke to be resampled. If 0 is specified, no resampling is done. */ StrokeInternal::StrokeVertexIterator strokeVerticesBegin(float t = 0.0f); |