diff options
Diffstat (limited to 'source/blender/freestyle/intern/stroke/Curve.h')
| -rw-r--r-- | source/blender/freestyle/intern/stroke/Curve.h | 98 |
1 files changed, 49 insertions, 49 deletions
diff --git a/source/blender/freestyle/intern/stroke/Curve.h b/source/blender/freestyle/intern/stroke/Curve.h index f0db45150a9..cce5353a5c7 100644 --- a/source/blender/freestyle/intern/stroke/Curve.h +++ b/source/blender/freestyle/intern/stroke/Curve.h @@ -52,7 +52,7 @@ using namespace Geometry; /* */ /**********************************/ -/*! Class to represent a point of a curve. +/** Class to represent a point of a curve. * A CurvePoint can be any point of a 1D curve (it doesn't have to be a vertex of the curve). * Any Interface1D is built upon ViewEdges, themselves built upon FEdges. Therefore, a curve is * basically a polyline made of a list SVertex. Thus, a CurvePoint is built by linearly @@ -61,56 +61,56 @@ using namespace Geometry; */ class CurvePoint : public Interface0D { public: // Implementation of Interface0D - /*! Returns the string "CurvePoint"*/ + /** Returns the string "CurvePoint"*/ virtual string getExactTypeName() const { return "CurvePoint"; } // Data access methods - /*! Returns the 3D X coordinate of the point */ + /** Returns the 3D X coordinate of the point */ virtual real getX() const { return _Point3d.x(); } - /*! Returns the 3D Y coordinate of the point */ + /** Returns the 3D Y coordinate of the point */ virtual real getY() const { return _Point3d.y(); } - /*! Returns the 3D Z coordinate of the point */ + /** Returns the 3D Z coordinate of the point */ virtual real getZ() const { return _Point3d.z(); } - /*! Returns the 3D point. */ + /** Returns the 3D point. */ virtual Vec3r getPoint3D() const { return _Point3d; } - /*! Returns the projected 3D X coordinate of the point */ + /** Returns the projected 3D X coordinate of the point */ virtual real getProjectedX() const { return _Point2d.x(); } - /*! Returns the projected 3D Y coordinate of the point */ + /** Returns the projected 3D Y coordinate of the point */ virtual real getProjectedY() const { return _Point2d.y(); } - /*! Returns the projected 3D Z coordinate of the point */ + /** Returns the projected 3D Z coordinate of the point */ virtual real getProjectedZ() const { return _Point2d.z(); } - /*! Returns the 2D point. */ + /** Returns the 2D point. */ virtual Vec2r getPoint2D() const { return Vec2r(_Point2d.x(), _Point2d.y()); @@ -118,7 +118,7 @@ class CurvePoint : public Interface0D { virtual FEdge *getFEdge(Interface0D &inter); - /*! Returns the CurvePoint's Id */ + /** Returns the CurvePoint's Id */ virtual Id getId() const { Id id; @@ -131,7 +131,7 @@ class CurvePoint : public Interface0D { return id; } - /*! Returns the CurvePoint's Nature */ + /** Returns the CurvePoint's Nature */ virtual Nature::VertexNature getNature() const { Nature::VertexNature nature = Nature::POINT; @@ -144,7 +144,7 @@ class CurvePoint : public Interface0D { return nature; } - /*! Cast the Interface0D in SVertex if it can be. */ + /** Cast the Interface0D in SVertex if it can be. */ virtual SVertex *castToSVertex() { if (_t2d == 0) { @@ -156,7 +156,7 @@ class CurvePoint : public Interface0D { return Interface0D::castToSVertex(); } - /*! Cast the Interface0D in ViewVertex if it can be. */ + /** Cast the Interface0D in ViewVertex if it can be. */ virtual ViewVertex *castToViewVertex() { if (_t2d == 0) { @@ -168,7 +168,7 @@ class CurvePoint : public Interface0D { return Interface0D::castToViewVertex(); } - /*! Cast the Interface0D in NonTVertex if it can be. */ + /** Cast the Interface0D in NonTVertex if it can be. */ virtual NonTVertex *castToNonTVertex() { if (_t2d == 0) { @@ -180,7 +180,7 @@ class CurvePoint : public Interface0D { return Interface0D::castToNonTVertex(); } - /*! Cast the Interface0D in TVertex if it can be. */ + /** Cast the Interface0D in TVertex if it can be. */ virtual TVertex *castToTVertex() { if (_t2d == 0) { @@ -204,10 +204,10 @@ class CurvePoint : public Interface0D { Vec3r _Point3d; public: - /*! Default Constructor. */ + /** Default Constructor. */ CurvePoint(); - /*! Builds a CurvePoint from two SVertex and an interpolation parameter. + /** Builds a CurvePoint from two SVertex and an interpolation parameter. * \param iA: * The first SVertex * \param iB: @@ -217,7 +217,7 @@ class CurvePoint : public Interface0D { */ CurvePoint(SVertex *iA, SVertex *iB, float t); - /*! Builds a CurvePoint from two CurvePoint and an interpolation parameter. + /** Builds a CurvePoint from two CurvePoint and an interpolation parameter. * \param iA: * The first CurvePoint * \param iB: @@ -229,35 +229,35 @@ class CurvePoint : public Interface0D { // CurvePoint(SVertex *iA, SVertex *iB, float t2d, float t3d); - /*! Copy Constructor. */ + /** Copy Constructor. */ CurvePoint(const CurvePoint &iBrother); - /*! Operator = */ + /** Operator = */ CurvePoint &operator=(const CurvePoint &iBrother); - /*! Destructor */ + /** Destructor */ virtual ~CurvePoint() = default; - /*! Operator == */ + /** Operator == */ bool operator==(const CurvePoint &b) { return ((__A == b.__A) && (__B == b.__B) && (_t2d == b._t2d)); } /* accessors */ - /*! Returns the first SVertex upon which the CurvePoint is built. */ + /** Returns the first SVertex upon which the CurvePoint is built. */ inline SVertex *A() { return __A; } - /*! Returns the second SVertex upon which the CurvePoint is built. */ + /** Returns the second SVertex upon which the CurvePoint is built. */ inline SVertex *B() { return __B; } - /*! Returns the interpolation parameter. */ + /** Returns the interpolation parameter. */ inline float t2d() const { return _t2d; @@ -271,19 +271,19 @@ class CurvePoint : public Interface0D { #endif /* modifiers */ - /*! Sets the first SVertex upon which to build the CurvePoint. */ + /** Sets the first SVertex upon which to build the CurvePoint. */ inline void setA(SVertex *iA) { __A = iA; } - /*! Sets the second SVertex upon which to build the CurvePoint. */ + /** Sets the second SVertex upon which to build the CurvePoint. */ inline void setB(SVertex *iB) { __B = iB; } - /*! Sets the 2D interpolation parameter to use. */ + /** Sets the 2D interpolation parameter to use. */ inline void setT2d(float t) { _t2d = t; @@ -339,7 +339,7 @@ class CurvePoint : public Interface0D { } Vec3r curvature2d_as_vector() const; - /*! angle in radians */ + /** angle in radians */ real curvature2d_as_angle() const; real curvatureFredo() const; @@ -368,7 +368,7 @@ class CurvePointIterator; } // end of namespace CurveInternal -/*! Base class for curves made of CurvePoints. +/** Base class for curves made of CurvePoints. * SVertex is the type of the initial curve vertices. * A Chain is a specialization of a Curve. */ @@ -396,7 +396,7 @@ class Curve : public Interface1D { unsigned _nSegments; // number of segments public: - /*! Default Constructor. */ + /** Default Constructor. */ Curve() { _Length = 0; @@ -404,7 +404,7 @@ class Curve : public Interface1D { _nSegments = 0; } - /*! Builds a Curve from its id */ + /** Builds a Curve from its id */ Curve(const Id &id) { _Length = 0; @@ -412,7 +412,7 @@ class Curve : public Interface1D { _nSegments = 0; } - /*! Copy Constructor. */ + /** Copy Constructor. */ Curve(const Curve &iBrother) { _Length = iBrother._Length; @@ -421,10 +421,10 @@ class Curve : public Interface1D { _nSegments = 0; } - /*! Destructor. */ + /** Destructor. */ virtual ~Curve(); - /*! Returns the string "Curve" */ + /** Returns the string "Curve" */ virtual string getExactTypeName() const { return "Curve"; @@ -435,7 +435,7 @@ class Curve : public Interface1D { void computeCurvatureAndOrientation(); #endif - /*! Adds a single vertex (CurvePoint) at the end of the Curve */ + /** Adds a single vertex (CurvePoint) at the end of the Curve */ inline void push_vertex_back(Vertex *iVertex) { if (!_Vertices.empty()) { @@ -447,7 +447,7 @@ class Curve : public Interface1D { _Vertices.push_back(new_vertex); } - /*! Adds a single vertex (SVertex) at the end of the Curve */ + /** Adds a single vertex (SVertex) at the end of the Curve */ inline void push_vertex_back(SVertex *iVertex) { if (!_Vertices.empty()) { @@ -459,7 +459,7 @@ class Curve : public Interface1D { _Vertices.push_back(new_vertex); } - /*! Adds a single vertex (CurvePoint) at the front of the Curve */ + /** Adds a single vertex (CurvePoint) at the front of the Curve */ inline void push_vertex_front(Vertex *iVertex) { if (!_Vertices.empty()) { @@ -471,7 +471,7 @@ class Curve : public Interface1D { _Vertices.push_front(new_vertex); } - /*! Adds a single vertex (SVertex) at the front of the Curve */ + /** Adds a single vertex (SVertex) at the front of the Curve */ inline void push_vertex_front(SVertex *iVertex) { if (!_Vertices.empty()) { @@ -483,25 +483,25 @@ class Curve : public Interface1D { _Vertices.push_front(new_vertex); } - /*! Returns true is the Curve doesn't have any Vertex yet. */ + /** Returns true is the Curve doesn't have any Vertex yet. */ inline bool empty() const { return _Vertices.empty(); } - /*! Returns the 2D length of the Curve. */ + /** Returns the 2D length of the Curve. */ inline real getLength2D() const { return _Length; } - /*! Returns the Id of the 1D element. */ + /** Returns the Id of the 1D element. */ virtual Id getId() const { return _Id; } - /*! Returns the number of segments in the polyline constituting the Curve. */ + /** Returns the number of segments in the polyline constituting the Curve. */ inline unsigned int nSegments() const { return _nSegments; @@ -549,7 +549,7 @@ class Curve : public Interface1D { float local_depth_variance(int iCombination = 0) const; real local_average_density(float sigma = 2.3f, int iCombination = 0) const; Vec3r curvature2d_as_vector(int iCombination = 0) const; - /*! angle in radians */ + /** angle in radians */ real curvature2d_as_angle(int iCombination = 0) const; #endif @@ -573,23 +573,23 @@ class Curve : public Interface1D { CurveInternal::CurvePointIterator curveVerticesEnd(); // Iterators access - /*! Returns an Interface0DIterator pointing onto the first vertex of the Curve and that can + /** Returns an Interface0DIterator pointing onto the first vertex of the Curve and that can * iterate over the \a vertices of the Curve. */ virtual Interface0DIterator verticesBegin(); - /*! Returns an Interface0DIterator pointing after the last vertex of the Curve and that can + /** Returns an Interface0DIterator pointing after the last vertex of the Curve and that can * iterate over the \a vertices of the Curve. */ virtual Interface0DIterator verticesEnd(); - /*! Returns an Interface0DIterator pointing onto the first point of the Curve and that can + /** Returns an Interface0DIterator pointing onto the first point of the Curve and that can * iterate over the \a points of the Curve at any resolution. At each iteration a virtual * temporary CurvePoint is created. */ virtual Interface0DIterator pointsBegin(float t = 0.0f); - /*! Returns an Interface0DIterator pointing after the last point of the Curve and that can + /** Returns an Interface0DIterator pointing after the last point of the Curve and that can * iterate over the \a points of the Curve at any resolution. At each iteration a virtual * temporary CurvePoint is created. */ |