Salome HOME
Update the doxygen documentation for plugins
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ResultValidators.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
2
3 // File:        Model_ResultValidators.h
4 // Created:     23 July 2014
5 // Author:      Vitaly SMETANNIKOV
6
7 #ifndef Model_ResultValidators_H
8 #define Model_ResultValidators_H
9
10 #include <SketchPlugin.h>
11 #include <ModelAPI_ResultValidator.h>
12 #include <ModelAPI_Object.h>
13
14 /**\class SketchPlugin_ResultPointValidator
15  * \ingroup Validators
16  * \brief Validator for the points selection
17  *
18  * Allows to select points only.
19  */
20 class SketchPlugin_ResultPointValidator : public ModelAPI_ResultValidator
21 {
22 public:
23   /// Returns true if theObject is a point
24   SKETCHPLUGIN_EXPORT virtual bool isValid(const ObjectPtr theObject) const;
25 };
26
27 /**\class SketchPlugin_ResultLineValidator
28  * \ingroup Validators
29  * \brief Validator for the linear segments selection
30  *
31  * Allows to select linear segments only.
32  */
33 class SketchPlugin_ResultLineValidator : public ModelAPI_ResultValidator
34 {
35 public:
36   /// Returns true if theObject is a line
37   SKETCHPLUGIN_EXPORT virtual bool isValid(const ObjectPtr theObject) const;
38 };
39
40 /**\class SketchPlugin_ResultArcValidator
41  * \ingroup Validators
42  * \brief Validator for the circular segments selection
43  *
44  * Allows to select circular segments only.
45  */
46 class SketchPlugin_ResultArcValidator : public ModelAPI_ResultValidator
47 {
48  public:
49   /// Returns true if theObject is an arc
50   SKETCHPLUGIN_EXPORT virtual bool isValid(const ObjectPtr theObject) const;
51 };
52
53 #endif