diff options
Diffstat (limited to 'source/blender/freestyle/intern/view_map/Interface0D.h')
| -rw-r--r-- | source/blender/freestyle/intern/view_map/Interface0D.h | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/source/blender/freestyle/intern/view_map/Interface0D.h b/source/blender/freestyle/intern/view_map/Interface0D.h index 6b4682cc862..065319578e5 100644 --- a/source/blender/freestyle/intern/view_map/Interface0D.h +++ b/source/blender/freestyle/intern/view_map/Interface0D.h @@ -51,18 +51,18 @@ class ViewVertex; class NonTVertex; class TVertex; -/*! Base class for any 0D element. */ +/** Base class for any 0D element. */ class Interface0D { public: - /*! Default constructor */ + /** Default constructor */ Interface0D() { } - /*! Destructor */ + /** Destructor */ virtual ~Interface0D(){}; - /*! Returns the string "Interface0D". */ + /** Returns the string "Interface0D". */ virtual string getExactTypeName() const { return "Interface0D"; @@ -70,50 +70,50 @@ class Interface0D { // Data access methods - /*! Returns the 3D x coordinate of the point. */ + /** Returns the 3D x coordinate of the point. */ virtual real getX() const; - /*! Returns the 3D y coordinate of the point. */ + /** Returns the 3D y coordinate of the point. */ virtual real getY() const; - /*! Returns the 3D z coordinate of the point. */ + /** Returns the 3D z coordinate of the point. */ virtual real getZ() const; - /*! Returns the 3D point. */ + /** Returns the 3D point. */ virtual Geometry::Vec3r getPoint3D() const; - /*! Returns the 2D x coordinate of the point. */ + /** Returns the 2D x coordinate of the point. */ virtual real getProjectedX() const; - /*! Returns the 2D y coordinate of the point. */ + /** Returns the 2D y coordinate of the point. */ virtual real getProjectedY() const; - /*! Returns the 2D z coordinate of the point. */ + /** Returns the 2D z coordinate of the point. */ virtual real getProjectedZ() const; - /*! Returns the 2D point. */ + /** Returns the 2D point. */ virtual Geometry::Vec2r getPoint2D() const; - /*! Returns the FEdge that lies between this Interface0D and the Interface0D given as argument. + /** Returns the FEdge that lies between this Interface0D and the Interface0D given as argument. */ virtual FEdge *getFEdge(Interface0D &); - /*! Returns the Id of the point. */ + /** Returns the Id of the point. */ virtual Id getId() const; - /*! Returns the nature of the point. */ + /** Returns the nature of the point. */ virtual Nature::VertexNature getNature() const; - /*! Cast the Interface0D in SVertex if it can be. */ + /** Cast the Interface0D in SVertex if it can be. */ virtual SVertex *castToSVertex(); - /*! Cast the Interface0D in ViewVertex if it can be. */ + /** Cast the Interface0D in ViewVertex if it can be. */ virtual ViewVertex *castToViewVertex(); - /*! Cast the Interface0D in NonTVertex if it can be. */ + /** Cast the Interface0D in NonTVertex if it can be. */ virtual NonTVertex *castToNonTVertex(); - /*! Cast the Interface0D in TVertex if it can be. */ + /** Cast the Interface0D in TVertex if it can be. */ virtual TVertex *castToTVertex(); #ifdef WITH_CXX_GUARDEDALLOC @@ -159,10 +159,10 @@ class Interface0DIteratorNested : public Iterator { return !(*this == it); } - /*! Returns the curvilinear abscissa */ + /** Returns the curvilinear abscissa */ virtual float t() const = 0; - /*! Returns the point parameter 0<u<1 */ + /** Returns the point parameter 0<u<1 */ virtual float u() const = 0; virtual Interface0DIteratorNested *copy() const = 0; @@ -173,7 +173,7 @@ class Interface0DIteratorNested : public Iterator { // ////////////////////////////////////////////////// -/*! Class defining an iterator over Interface0D elements. +/** Class defining an iterator over Interface0D elements. * An instance of this iterator is always obtained from a 1D element. * \attention In the scripting language, you must call \code it2 = Interface0DIterator(it1) * \endcode instead of \code it2 = it1 \endcode where \a it1 and \a it2 are 2 Interface0DIterator. @@ -186,13 +186,13 @@ class Interface0DIterator : public Iterator { _iterator = it; } - /*! Copy constructor */ + /** Copy constructor */ Interface0DIterator(const Interface0DIterator &it) { _iterator = it._iterator->copy(); } - /*! Destructor */ + /** Destructor */ virtual ~Interface0DIterator() { if (_iterator) { @@ -200,7 +200,7 @@ class Interface0DIterator : public Iterator { } } - /*! Operator = + /** Operator = * \attention In the scripting language, you must call \code it2 = Interface0DIterator(it1) * \endcode instead of \code it2 = it1 \endcode where \a it1 and \a it2 are 2 * Interface0DIterator. Otherwise, incrementing \a it1 will also increment \a it2. @@ -214,7 +214,7 @@ class Interface0DIterator : public Iterator { return *this; } - /*! Returns the string "Interface0DIterator". */ + /** Returns the string "Interface0DIterator". */ virtual string getExactTypeName() const { if (!_iterator) { @@ -225,7 +225,7 @@ class Interface0DIterator : public Iterator { // FIXME test it != 0 (exceptions ?) - /*! Returns a reference to the pointed Interface0D. + /** Returns a reference to the pointed Interface0D. * In the scripting language, you must call "getObject()" instead using this operator. */ Interface0D &operator*() @@ -233,7 +233,7 @@ class Interface0DIterator : public Iterator { return _iterator->operator*(); } - /*! Returns a pointer to the pointed Interface0D. + /** Returns a pointer to the pointed Interface0D. * Can't be called in the scripting language. */ Interface0D *operator->() @@ -241,14 +241,14 @@ class Interface0DIterator : public Iterator { return &(operator*()); } - /*! Increments. In the scripting language, call "increment()". */ + /** Increments. In the scripting language, call "increment()". */ Interface0DIterator &operator++() { _iterator->increment(); return *this; } - /*! Increments. In the scripting language, call "increment()". */ + /** Increments. In the scripting language, call "increment()". */ Interface0DIterator operator++(int) { Interface0DIterator ret(*this); @@ -256,14 +256,14 @@ class Interface0DIterator : public Iterator { return ret; } - /*! Decrements. In the scripting language, call "decrement()". */ + /** Decrements. In the scripting language, call "decrement()". */ Interface0DIterator &operator--() { _iterator->decrement(); return *this; } - /*! Decrements. In the scripting language, call "decrement()". */ + /** Decrements. In the scripting language, call "decrement()". */ Interface0DIterator operator--(int) { Interface0DIterator ret(*this); @@ -271,19 +271,19 @@ class Interface0DIterator : public Iterator { return ret; } - /*! Increments. */ + /** Increments. */ virtual int increment() { return _iterator->increment(); } - /*! Decrements. */ + /** Decrements. */ virtual int decrement() { return _iterator->decrement(); } - /*! Returns true if the pointed Interface0D is the first of the 1D element containing the points + /** Returns true if the pointed Interface0D is the first of the 1D element containing the points * over which we're iterating. */ virtual bool isBegin() const @@ -291,14 +291,14 @@ class Interface0DIterator : public Iterator { return _iterator->isBegin(); } - /*! Returns true if the pointed Interface0D is after the after the last point of the 1D element + /** Returns true if the pointed Interface0D is after the after the last point of the 1D element * we're iterating from. */ virtual bool isEnd() const { return _iterator->isEnd(); } - /*! Returns true when the iterator is pointing to the final valid element. */ + /** Returns true when the iterator is pointing to the final valid element. */ virtual bool atLast() const { if (_iterator->isEnd()) { @@ -311,25 +311,25 @@ class Interface0DIterator : public Iterator { return result; } - /*! operator == . */ + /** operator == . */ bool operator==(const Interface0DIterator &it) const { return _iterator->operator==(*(it._iterator)); } - /*! operator != . */ + /** operator != . */ bool operator!=(const Interface0DIterator &it) const { return !(*this == it); } - /*! Returns the curvilinear abscissa. */ + /** Returns the curvilinear abscissa. */ inline float t() const { return _iterator->t(); } - /*! Returns the point parameter in the curve 0<=u<=1. */ + /** Returns the point parameter in the curve 0<=u<=1. */ inline float u() const { return _iterator->u(); |