diff options
Diffstat (limited to 'source/blender/freestyle/intern/view_map/Functions1D.h')
| -rw-r--r-- | source/blender/freestyle/intern/view_map/Functions1D.h | 164 |
1 files changed, 82 insertions, 82 deletions
diff --git a/source/blender/freestyle/intern/view_map/Functions1D.h b/source/blender/freestyle/intern/view_map/Functions1D.h index 9cf5527ee19..532e89261ce 100644 --- a/source/blender/freestyle/intern/view_map/Functions1D.h +++ b/source/blender/freestyle/intern/view_map/Functions1D.h @@ -42,7 +42,7 @@ namespace Freestyle { // /////////////////////////////////////////////////////////// -/*! Base class for Unary Functions (functors) working on Interface1D. +/** Base class for Unary Functions (functors) working on Interface1D. * A unary function will be used by calling its operator() on an Interface1D. * \attention In the scripting language, there exists several prototypes depending on the returned * value type. For example, you would inherit from a UnaryFunction1DDouble if you wish to define a @@ -61,16 +61,16 @@ template<class T> class UnaryFunction1D { T result; void *py_uf1D; - /*! The type of the value returned by the functor. */ + /** The type of the value returned by the functor. */ typedef T ReturnedValueType; - /*! Default constructor */ + /** Default constructor */ UnaryFunction1D() { _integration = MEAN; } - /*! Builds a UnaryFunction1D from an integration type. + /** Builds a UnaryFunction1D from an integration type. * \param iType: * In case the result for the Interface1D would be obtained by evaluating a 0D function over * the different Interface0D of the Interface1D, \a iType tells which integration method to use. @@ -81,18 +81,18 @@ template<class T> class UnaryFunction1D { _integration = iType; } - /*! destructor. */ + /** destructor. */ virtual ~UnaryFunction1D() { } - /*! returns the string "UnaryFunction1D". */ + /** returns the string "UnaryFunction1D". */ virtual string getName() const { return "UnaryFunction1D"; } - /*! The operator (). + /** The operator (). * \param inter: * The Interface1D on which we wish to evaluate the function. * \return the result of the function of type T. @@ -103,13 +103,13 @@ template<class T> class UnaryFunction1D { return Director_BPy_UnaryFunction1D___call__(this, py_uf1D, inter); } - /*! Sets the integration method */ + /** Sets the integration method */ void setIntegrationType(IntegrationType integration) { _integration = integration; } - /*! Returns the integration method. */ + /** Returns the integration method. */ IntegrationType getIntegrationType() const { return _integration; @@ -178,13 +178,13 @@ class UnaryFunction1D_void { namespace Functions1D { // GetXF1D -/*! Returns the X 3D coordinate of an Interface1D. */ +/** Returns the X 3D coordinate of an Interface1D. */ class GetXF1D : public UnaryFunction1D<double> { private: Functions0D::GetXF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -192,24 +192,24 @@ class GetXF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "GetXF1D" */ + /** Returns the string "GetXF1D" */ string getName() const { return "GetXF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetYF1D -/*! Returns the Y 3D coordinate of an Interface1D. */ +/** Returns the Y 3D coordinate of an Interface1D. */ class GetYF1D : public UnaryFunction1D<double> { private: Functions0D::GetYF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -217,24 +217,24 @@ class GetYF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "GetYF1D" */ + /** Returns the string "GetYF1D" */ string getName() const { return "GetYF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetZF1D -/*! Returns the Z 3D coordinate of an Interface1D. */ +/** Returns the Z 3D coordinate of an Interface1D. */ class GetZF1D : public UnaryFunction1D<double> { private: Functions0D::GetZF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -242,24 +242,24 @@ class GetZF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "GetZF1D" */ + /** Returns the string "GetZF1D" */ string getName() const { return "GetZF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetProjectedXF1D -/*! Returns the projected X 3D coordinate of an Interface1D. */ +/** Returns the projected X 3D coordinate of an Interface1D. */ class GetProjectedXF1D : public UnaryFunction1D<double> { private: Functions0D::GetProjectedXF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -267,24 +267,24 @@ class GetProjectedXF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "GetProjectedXF1D" */ + /** Returns the string "GetProjectedXF1D" */ string getName() const { return "GetProjectedXF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetProjectedYF1D -/*! Returns the projected Y 3D coordinate of an Interface1D. */ +/** Returns the projected Y 3D coordinate of an Interface1D. */ class GetProjectedYF1D : public UnaryFunction1D<double> { private: Functions0D::GetProjectedYF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -292,24 +292,24 @@ class GetProjectedYF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "GetProjectedYF1D" */ + /** Returns the string "GetProjectedYF1D" */ string getName() const { return "GetProjectedYF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetProjectedZF1D -/*! Returns the projected Z 3D coordinate of an Interface1D. */ +/** Returns the projected Z 3D coordinate of an Interface1D. */ class GetProjectedZF1D : public UnaryFunction1D<double> { private: Functions0D::GetProjectedZF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -317,24 +317,24 @@ class GetProjectedZF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "GetProjectedZF1D" */ + /** Returns the string "GetProjectedZF1D" */ string getName() const { return "GetProjectedZF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // Orientation2DF1D -/*! Returns the 2D orientation as a Vec2f*/ +/** Returns the 2D orientation as a Vec2f*/ class Orientation2DF1D : public UnaryFunction1D<Vec2f> { private: Functions0D::VertexOrientation2DF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -342,24 +342,24 @@ class Orientation2DF1D : public UnaryFunction1D<Vec2f> { { } - /*! Returns the string "Orientation2DF1D" */ + /** Returns the string "Orientation2DF1D" */ string getName() const { return "Orientation2DF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // Orientation3DF1D -/*! Returns the 3D orientation as a Vec3f. */ +/** Returns the 3D orientation as a Vec3f. */ class Orientation3DF1D : public UnaryFunction1D<Vec3f> { private: Functions0D::VertexOrientation3DF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -367,18 +367,18 @@ class Orientation3DF1D : public UnaryFunction1D<Vec3f> { { } - /*! Returns the string "Orientation3DF1D" */ + /** Returns the string "Orientation3DF1D" */ string getName() const { return "Orientation3DF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // ZDiscontinuityF1D -/*! Returns a real giving the distance between and Interface1D and the shape that lies behind +/** Returns a real giving the distance between and Interface1D and the shape that lies behind * (occludee). This distance is evaluated in the camera space and normalized between 0 and 1. * Therefore, if no object is occluded by the shape to which the Interface1D belongs to, 1 is * returned. @@ -388,7 +388,7 @@ class ZDiscontinuityF1D : public UnaryFunction1D<double> { Functions0D::ZDiscontinuityF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -396,18 +396,18 @@ class ZDiscontinuityF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "ZDiscontinuityF1D" */ + /** Returns the string "ZDiscontinuityF1D" */ string getName() const { return "ZDiscontinuityF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // QuantitativeInvisibilityF1D -/*! Returns the Quantitative Invisibility of an Interface1D element. +/** Returns the Quantitative Invisibility of an Interface1D element. * If the Interface1D is a ViewEdge, then there is no ambiguity concerning the result. But, if the * Interface1D results of a chaining (chain, stroke), then it might be made of several 1D elements * of different Quantitative Invisibilities. @@ -417,7 +417,7 @@ class QuantitativeInvisibilityF1D : public UnaryFunction1D<unsigned> { Functions0D::QuantitativeInvisibilityF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -425,18 +425,18 @@ class QuantitativeInvisibilityF1D : public UnaryFunction1D<unsigned> { { } - /*! Returns the string "QuantitativeInvisibilityF1D" */ + /** Returns the string "QuantitativeInvisibilityF1D" */ string getName() const { return "QuantitativeInvisibilityF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // CurveNatureF1D -/*! Returns the nature of the Interface1D (silhouette, ridge, crease...). +/** Returns the nature of the Interface1D (silhouette, ridge, crease...). * Except if the Interface1D is a ViewEdge, this result might be ambiguous. * Indeed, the Interface1D might result from the gathering of several 1D elements, each one being * of a different nature. An integration method, such as the MEAN, might give, in this case, @@ -447,7 +447,7 @@ class CurveNatureF1D : public UnaryFunction1D<Nature::EdgeNature> { Functions0D::CurveNatureF0D _func; public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -455,63 +455,63 @@ class CurveNatureF1D : public UnaryFunction1D<Nature::EdgeNature> { { } - /*! Returns the string "CurveNatureF1D" */ + /** Returns the string "CurveNatureF1D" */ string getName() const { return "CurveNatureF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // TimeStampF1D -/*! Returns the time stamp of the Interface1D. */ +/** Returns the time stamp of the Interface1D. */ class TimeStampF1D : public UnaryFunction1D_void { public: - /*! Returns the string "TimeStampF1D" */ + /** Returns the string "TimeStampF1D" */ string getName() const { return "TimeStampF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // IncrementChainingTimeStampF1D -/*! Increments the chaining time stamp of the Interface1D. */ +/** Increments the chaining time stamp of the Interface1D. */ class IncrementChainingTimeStampF1D : public UnaryFunction1D_void { public: - /*! Returns the string "IncrementChainingTimeStampF1D" */ + /** Returns the string "IncrementChainingTimeStampF1D" */ string getName() const { return "IncrementChainingTimeStampF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // ChainingTimeStampF1D -/*! Sets the chaining time stamp of the Interface1D. */ +/** Sets the chaining time stamp of the Interface1D. */ class ChainingTimeStampF1D : public UnaryFunction1D_void { public: - /*! Returns the string "ChainingTimeStampF1D" */ + /** Returns the string "ChainingTimeStampF1D" */ string getName() const { return "ChainingTimeStampF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // Curvature2DAngleF1D -/*! Returns the 2D curvature as an angle for an Interface1D. */ +/** Returns the 2D curvature as an angle for an Interface1D. */ class Curvature2DAngleF1D : public UnaryFunction1D<double> { public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -519,13 +519,13 @@ class Curvature2DAngleF1D : public UnaryFunction1D<double> { { } - /*! Returns the string "Curvature2DAngleF1D" */ + /** Returns the string "Curvature2DAngleF1D" */ string getName() const { return "Curvature2DAngleF1D"; } - /*! the () operator.*/ + /** the () operator.*/ int operator()(Interface1D &inter) { result = integrate(_fun, inter.verticesBegin(), inter.verticesEnd(), _integration); @@ -537,10 +537,10 @@ class Curvature2DAngleF1D : public UnaryFunction1D<double> { }; // Normal2DF1D -/*! Returns the 2D normal for an interface 1D. */ +/** Returns the 2D normal for an interface 1D. */ class Normal2DF1D : public UnaryFunction1D<Vec2f> { public: - /*! Builds the functor. + /** Builds the functor. * \param iType: * The integration method used to compute a single value from a set of values. */ @@ -548,13 +548,13 @@ class Normal2DF1D : public UnaryFunction1D<Vec2f> { { } - /*! Returns the string "Normal2DF1D" */ + /** Returns the string "Normal2DF1D" */ string getName() const { return "Normal2DF1D"; } - /*! the () operator.*/ + /** the () operator.*/ int operator()(Interface1D &inter) { result = integrate(_fun, inter.verticesBegin(), inter.verticesEnd(), _integration); @@ -566,59 +566,59 @@ class Normal2DF1D : public UnaryFunction1D<Vec2f> { }; // GetShapeF1D -/*! Returns list of shapes covered by this Interface1D. */ +/** Returns list of shapes covered by this Interface1D. */ class GetShapeF1D : public UnaryFunction1D<std::vector<ViewShape *>> { public: - /*! Builds the functor. */ + /** Builds the functor. */ GetShapeF1D() : UnaryFunction1D<std::vector<ViewShape *>>() { } - /*! Returns the string "GetShapeF1D" */ + /** Returns the string "GetShapeF1D" */ string getName() const { return "GetShapeF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetOccludersF1D -/*! Returns list of occluding shapes covered by this Interface1D. */ +/** Returns list of occluding shapes covered by this Interface1D. */ class GetOccludersF1D : public UnaryFunction1D<std::vector<ViewShape *>> { public: - /*! Builds the functor. */ + /** Builds the functor. */ GetOccludersF1D() : UnaryFunction1D<std::vector<ViewShape *>>() { } - /*! Returns the string "GetOccludersF1D" */ + /** Returns the string "GetOccludersF1D" */ string getName() const { return "GetOccludersF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; // GetOccludeeF1D -/*! Returns list of occluded shapes covered by this Interface1D. */ +/** Returns list of occluded shapes covered by this Interface1D. */ class GetOccludeeF1D : public UnaryFunction1D<std::vector<ViewShape *>> { public: - /*! Builds the functor. */ + /** Builds the functor. */ GetOccludeeF1D() : UnaryFunction1D<std::vector<ViewShape *>>() { } - /*! Returns the string "GetOccludeeF1D" */ + /** Returns the string "GetOccludeeF1D" */ string getName() const { return "GetOccludeeF1D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface1D &inter); }; |