Merge branch 'master' of newgeom:newgeom

[modules/shaper.git] / src / PartSet / PartSet_WidgetShapeSelector.h

diff --git a/src/PartSet/PartSet_WidgetShapeSelector.h b/src/PartSet/PartSet_WidgetShapeSelector.h
index a216830ae281c46a20c2dc2d7f2797c610b143a7..222bac774861dde14ece55b7fa51f81fe96a6433 100644 (file)
--- a/src/PartSet/PartSet_WidgetShapeSelector.h
+++ b/src/PartSet/PartSet_WidgetShapeSelector.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        PartSet_WidgetShapeSelector.h
 // Created:     27 Nov 2014
 // Author:      Vitaly Smetannikov
@@ -12,23 +14,77 @@
 
 #include <ModelAPI_CompositeFeature.h>
 
+
+/**
+* \ingroup Modules
+* Customosation of ModuleBase_WidgetShapeSelector in order to provide 
+* working with sketch specific objects.
+*/
 class PARTSET_EXPORT PartSet_WidgetShapeSelector: public ModuleBase_WidgetShapeSelector
 {
 Q_OBJECT
  public:
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theWorkshop instance of workshop interface
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  /// \param theParentId is Id of a parent of the current attribute
   PartSet_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
     const Config_WidgetAPI* theData, const std::string& theParentId)
     : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
 
   virtual ~PartSet_WidgetShapeSelector() {}
 
+  virtual bool storeValue() const;
+
+  /// Set sketcher
+  /// \param theSketch a sketcher object
+  void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
+
+  /// Retrurns installed sketcher
+  CompositeFeaturePtr sketch() const { return mySketch; }
+
+protected:
+  /// Check the selected with validators if installed
+  virtual bool isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape);
+
+private:
+  /// Pointer to a sketch 
+  CompositeFeaturePtr mySketch;
+};
+
+/**
+* \ingroup Modules
+* Customosation of ModuleBase_WidgetShapeSelector in order to provide 
+* working with constraints.
+*/
+class PARTSET_EXPORT PartSet_WidgetConstraintShapeSelector: public ModuleBase_WidgetShapeSelector
+{
+Q_OBJECT
+ public:
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theWorkshop instance of workshop interface
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  /// \param theParentId is Id of a parent of the current attribute
+  PartSet_WidgetConstraintShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
+    const Config_WidgetAPI* theData, const std::string& theParentId)
+    : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
+
+  virtual ~PartSet_WidgetConstraintShapeSelector() {}
+
   /// Saves the internal parameters to the given feature
   virtual bool storeValue() const;
 
+  /// Set sketcher
+  /// \param theSketch a sketcher object
   void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
+
+  /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
 private:
+  /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
 };