diff options
Diffstat (limited to 'source/blender/freestyle/intern/stroke/Predicates1D.h')
| -rw-r--r-- | source/blender/freestyle/intern/stroke/Predicates1D.h | 114 |
1 files changed, 57 insertions, 57 deletions
diff --git a/source/blender/freestyle/intern/stroke/Predicates1D.h b/source/blender/freestyle/intern/stroke/Predicates1D.h index c174162b214..ceb2e7fcc17 100644 --- a/source/blender/freestyle/intern/stroke/Predicates1D.h +++ b/source/blender/freestyle/intern/stroke/Predicates1D.h @@ -41,7 +41,7 @@ namespace Freestyle { // /////////////////////////////////////////////////////////// -/*! Base class for Unary Predicates that work on Interface1D. +/** Base class for Unary Predicates that work on Interface1D. * A UnaryPredicate1D is a functor that evaluates a condition on a Interface1D and returns * true or false depending on whether this condition is satisfied or not. * The UnaryPredicate1D is used by calling its () operator. @@ -52,24 +52,24 @@ class UnaryPredicate1D { bool result; void *py_up1D; - /*! Default constructor. */ + /** Default constructor. */ UnaryPredicate1D() { py_up1D = NULL; } - /*! Destructor. */ + /** Destructor. */ virtual ~UnaryPredicate1D() { } - /*! Returns the string of the name of the UnaryPredicate1D. */ + /** Returns the string of the name of the UnaryPredicate1D. */ virtual string getName() const { return "UnaryPredicate1D"; } - /*! The () operator. Must be overload by inherited classes. + /** The () operator. Must be overload by inherited classes. * \param inter: * The Interface1D on which we wish to evaluate the predicate. * \return true if the condition is satisfied, false otherwise. @@ -86,7 +86,7 @@ class UnaryPredicate1D { // /////////////////////////////////////////////////////////// -/*! Base class for Binary Predicates working on Interface1D. +/** Base class for Binary Predicates working on Interface1D. * A BinaryPredicate1D is typically an ordering relation between two Interface1D. * It evaluates a relation between 2 Interface1D and returns true or false. * It is used by calling the () operator. @@ -96,24 +96,24 @@ class BinaryPredicate1D { bool result; void *py_bp1D; - /*! Default constructor. */ + /** Default constructor. */ BinaryPredicate1D() { py_bp1D = NULL; } - /*! Destructor. */ + /** Destructor. */ virtual ~BinaryPredicate1D() { } - /*! Returns the string of the name of the binary predicate. */ + /** Returns the string of the name of the binary predicate. */ virtual string getName() const { return "BinaryPredicate1D"; } - /*! The () operator. Must be overload by inherited classes. + /** The () operator. Must be overload by inherited classes. * It evaluates a relation between 2 Interface1D. * \param inter1: * The first Interface1D. @@ -136,21 +136,21 @@ class BinaryPredicate1D { namespace Predicates1D { // TrueUP1D -/*! Returns true */ +/** Returns true */ class TrueUP1D : public UnaryPredicate1D { public: - /*! Constructor */ + /** Constructor */ TrueUP1D() { } - /*! Returns the string "TrueUP1D"*/ + /** Returns the string "TrueUP1D"*/ string getName() const { return "TrueUP1D"; } - /*! the () operator */ + /** the () operator */ int operator()(Interface1D &) { result = true; @@ -159,21 +159,21 @@ class TrueUP1D : public UnaryPredicate1D { }; // FalseUP1D -/*! Returns false */ +/** Returns false */ class FalseUP1D : public UnaryPredicate1D { public: - /*! Constructor */ + /** Constructor */ FalseUP1D() { } - /*! Returns the string "FalseUP1D"*/ + /** Returns the string "FalseUP1D"*/ string getName() const { return "FalseUP1D"; } - /*! the () operator */ + /** the () operator */ int operator()(Interface1D &) { result = false; @@ -182,12 +182,12 @@ class FalseUP1D : public UnaryPredicate1D { }; // QuantitativeInvisibilityUP1D -/*! Returns true if the Quantitative Invisibility evaluated at an Interface1D, using the +/** Returns true if the Quantitative Invisibility evaluated at an Interface1D, using the * QuantitativeInvisibilityF1D functor, equals a certain user-defined value. */ class QuantitativeInvisibilityUP1D : public UnaryPredicate1D { public: - /*! Builds the Predicate. + /** Builds the Predicate. * \param qi: * The Quantitative Invisibility you want the Interface1D to have */ @@ -195,13 +195,13 @@ class QuantitativeInvisibilityUP1D : public UnaryPredicate1D { { } - /*! Returns the string "QuantitativeInvisibilityUP1D" */ + /** Returns the string "QuantitativeInvisibilityUP1D" */ string getName() const { return "QuantitativeInvisibilityUP1D"; } - /*! the () operator */ + /** the () operator */ int operator()(Interface1D &inter) { Functions1D::QuantitativeInvisibilityF1D func; @@ -217,7 +217,7 @@ class QuantitativeInvisibilityUP1D : public UnaryPredicate1D { }; // ContourUP1D -/*! Returns true if the Interface1D is a contour. +/** Returns true if the Interface1D is a contour. * An Interface1D is a contour if it is bordered by a different shape on each of its sides. */ class ContourUP1D : public UnaryPredicate1D { @@ -225,13 +225,13 @@ class ContourUP1D : public UnaryPredicate1D { Functions1D::CurveNatureF1D _getNature; public: - /*! Returns the string "ContourUP1D"*/ + /** Returns the string "ContourUP1D"*/ string getName() const { return "ContourUP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &inter) { if (_getNature(inter) < 0) { @@ -252,7 +252,7 @@ class ContourUP1D : public UnaryPredicate1D { }; // ExternalContourUP1D -/*! Returns true if the Interface1D is an external contour. +/** Returns true if the Interface1D is an external contour. * An Interface1D is an external contour if it is bordered by no shape on one of its sides. */ class ExternalContourUP1D : public UnaryPredicate1D { @@ -260,13 +260,13 @@ class ExternalContourUP1D : public UnaryPredicate1D { Functions1D::CurveNatureF1D _getNature; public: - /*! Returns the string "ExternalContourUP1D" */ + /** Returns the string "ExternalContourUP1D" */ string getName() const { return "ExternalContourUP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &inter) { if (_getNature(inter) < 0) { @@ -289,7 +289,7 @@ class ExternalContourUP1D : public UnaryPredicate1D { }; // EqualToTimeStampUP1D -/*! Returns true if the Interface1D's time stamp is equal to a certain user-defined value. */ +/** Returns true if the Interface1D's time stamp is equal to a certain user-defined value. */ class EqualToTimeStampUP1D : public UnaryPredicate1D { protected: unsigned _timeStamp; @@ -300,13 +300,13 @@ class EqualToTimeStampUP1D : public UnaryPredicate1D { _timeStamp = ts; } - /*! Returns the string "EqualToTimeStampUP1D"*/ + /** Returns the string "EqualToTimeStampUP1D"*/ string getName() const { return "EqualToTimeStampUP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &inter) { result = (inter.getTimeStamp() == _timeStamp); @@ -315,7 +315,7 @@ class EqualToTimeStampUP1D : public UnaryPredicate1D { }; // EqualToChainingTimeStampUP1D -/*! Returns true if the Interface1D's time stamp is equal to a certain user-defined value. */ +/** Returns true if the Interface1D's time stamp is equal to a certain user-defined value. */ class EqualToChainingTimeStampUP1D : public UnaryPredicate1D { protected: unsigned _timeStamp; @@ -326,13 +326,13 @@ class EqualToChainingTimeStampUP1D : public UnaryPredicate1D { _timeStamp = ts; } - /*! Returns the string "EqualToChainingTimeStampUP1D"*/ + /** Returns the string "EqualToChainingTimeStampUP1D"*/ string getName() const { return "EqualToChainingTimeStampUP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &inter) { ViewEdge *edge = dynamic_cast<ViewEdge *>(&inter); @@ -346,14 +346,14 @@ class EqualToChainingTimeStampUP1D : public UnaryPredicate1D { }; // ShapeUP1D -/*! Returns true if the shape to which the Interface1D belongs to has the same Id as the one +/** Returns true if the shape to which the Interface1D belongs to has the same Id as the one * specified by the user. */ class ShapeUP1D : public UnaryPredicate1D { private: Id _id; public: - /*! Builds the Predicate. + /** Builds the Predicate. * \param idFirst: * The first Id component. * \param idSecond: @@ -364,13 +364,13 @@ class ShapeUP1D : public UnaryPredicate1D { _id = Id(idFirst, idSecond); } - /*! Returns the string "ShapeUP1D"*/ + /** Returns the string "ShapeUP1D"*/ string getName() const { return "ShapeUP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &inter) { set<ViewShape *> shapes; @@ -387,13 +387,13 @@ class ShapeUP1D : public UnaryPredicate1D { }; // WithinImageBoundaryUP1D -/*! Returns true if the Interface1D is (partly) within the image boundary. */ +/** Returns true if the Interface1D is (partly) within the image boundary. */ class WithinImageBoundaryUP1D : public UnaryPredicate1D { private: real _xmin, _ymin, _xmax, _ymax; public: - /*! Builds the Predicate. + /** Builds the Predicate. * \param xmin: * The X lower bound of the image boundary. * \param ymin: @@ -408,13 +408,13 @@ class WithinImageBoundaryUP1D : public UnaryPredicate1D { { } - /*! Returns the string "WithinImageBoundaryUP1D" */ + /** Returns the string "WithinImageBoundaryUP1D" */ string getName() const { return "WithinImageBoundaryUP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &inter) { // 1st pass: check if a point is within the image boundary. @@ -454,16 +454,16 @@ class WithinImageBoundaryUP1D : public UnaryPredicate1D { /////////////////////////////////////////////////////////// // TrueBP1D -/*! Returns true. */ +/** Returns true. */ class TrueBP1D : public BinaryPredicate1D { public: - /*! Returns the string "TrueBP1D" */ + /** Returns the string "TrueBP1D" */ string getName() const { return "TrueBP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D & /*i1*/, Interface1D & /*i2*/) { result = true; @@ -472,16 +472,16 @@ class TrueBP1D : public BinaryPredicate1D { }; // FalseBP1D -/*! Returns false. */ +/** Returns false. */ class FalseBP1D : public BinaryPredicate1D { public: - /*! Returns the string "FalseBP1D" */ + /** Returns the string "FalseBP1D" */ string getName() const { return "FalseBP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D & /*i1*/, Interface1D & /*i2*/) { result = false; @@ -490,17 +490,17 @@ class FalseBP1D : public BinaryPredicate1D { }; // Length2DBP1D -/*! Returns true if the 2D length of the Interface1D i1 is less than the 2D length of the +/** Returns true if the 2D length of the Interface1D i1 is less than the 2D length of the * Interface1D i2. */ class Length2DBP1D : public BinaryPredicate1D { public: - /*! Returns the string "Length2DBP1D" */ + /** Returns the string "Length2DBP1D" */ string getName() const { return "Length2DBP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &i1, Interface1D &i2) { result = (i1.getLength2D() > i2.getLength2D()); @@ -509,16 +509,16 @@ class Length2DBP1D : public BinaryPredicate1D { }; // SameShapeIdBP1D -/*! Returns true if the Interface1D i1 and i2 belong to the same shape. */ +/** Returns true if the Interface1D i1 and i2 belong to the same shape. */ class SameShapeIdBP1D : public BinaryPredicate1D { public: - /*! Returns the string "SameShapeIdBP1D" */ + /** Returns the string "SameShapeIdBP1D" */ string getName() const { return "SameShapeIdBP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &i1, Interface1D &i2) { set<ViewShape *> shapes1; @@ -542,7 +542,7 @@ class SameShapeIdBP1D : public BinaryPredicate1D { }; // ViewMapGradientNormBP1D -/*! Returns true if the evaluation of the Gradient norm Function is higher for Interface1D i1 than +/** Returns true if the evaluation of the Gradient norm Function is higher for Interface1D i1 than * for i2. */ class ViewMapGradientNormBP1D : public BinaryPredicate1D { private: @@ -554,13 +554,13 @@ class ViewMapGradientNormBP1D : public BinaryPredicate1D { { } - /*! Returns the string "ViewMapGradientNormBP1D" */ + /** Returns the string "ViewMapGradientNormBP1D" */ string getName() const { return "ViewMapGradientNormBP1D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface1D &i1, Interface1D &i2) { if (_func(i1) < 0) { |