A possibility to use entity point attribute for the rigid constraint in GUI.

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

diff --git a/src/PartSet/PartSet_WidgetShapeSelector.h b/src/PartSet/PartSet_WidgetShapeSelector.h
index fabbea2aeb7046204d70206687bbde2f52a091e5..f300db7e8d011fe85db6c010bc98c848f1bdadd3 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,44 +14,56 @@
 
 #include <ModelAPI_CompositeFeature.h>
 
+class PartSet_ExternalObjectsMgr;
+
+/**
+* \ingroup Modules
+* Customosation of ModuleBase_WidgetShapeSelector in order to provide 
+* working with sketch specific objects and external 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) {}
+    const Config_WidgetAPI* theData, const std::string& theParentId);
 
-  virtual ~PartSet_WidgetShapeSelector() {}
-
-  /// Saves the internal parameters to the given feature
-  virtual bool storeValue() const;
+  virtual ~PartSet_WidgetShapeSelector();
 
+  /// Set sketcher
+  /// \param theSketch a sketcher object
   void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
-  CompositeFeaturePtr sketch() const { return mySketch; }
-
-private:
-  CompositeFeaturePtr mySketch;
-};
-
 
-class PARTSET_EXPORT PartSet_WidgetConstraintShapeSelector: public ModuleBase_WidgetShapeSelector
-{
-Q_OBJECT
- public:
-  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;
-
-  void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
+  /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
-private:
+protected:
+  /// Store the values to the model attribute of the widget. It casts this attribute to
+  /// the specific type and set the given values
+  /// \param theSelectedObject an object
+  /// \param theShape a selected shape, which is used in the selection attribute
+  virtual bool setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
+
+  /// Creates a backup of the current values of the attribute
+  /// It should be realized in the specific widget because of different
+  /// parameters of the current attribute
+  /// \param theValid a boolean flag, if restore happens for valid parameters
+  void restoreAttributeValue(const bool theValid);
+
+  /// Found the sketch point attribute by the shape and set it in the feature attribute
+  /// otherwise set the selected object
+  /// \param theSelectedObject an object
+  /// \param theShape a selected shape, which is used in the selection attribute
+  void setPointAttribute(ObjectPtr theSelectedObject, GeomShapePtr theShape);
+
+protected:
+  PartSet_ExternalObjectsMgr* myExternalObjectMgr;
+  /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
 };