Salome HOME
Update classes documentation
[modules/shaper.git] / src / PartSet / PartSet_WidgetShapeSelector.h
index 8f187cd8b47b1d1f8074506210f471f690ce91b6..8a0ee84de47fc5e3e690065adf7933064ea87c00 100644 (file)
 
 #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
   PartSet_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
-    const Config_WidgetAPI* theData, const std::string& theParentId)
-    : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
-
-  virtual ~PartSet_WidgetShapeSelector() {}
+                              const Config_WidgetAPI* theData);
 
-  /// 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; }
-
-protected:
-  /// Check the selected with validators if installed
-  virtual bool isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape);
-
-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) {}
+  /// Retrurns installed sketcher
+  CompositeFeaturePtr sketch() const { return mySketch; }
 
-  virtual ~PartSet_WidgetConstraintShapeSelector() {}
+  /// Activate or deactivate selection and selection filters
+  /// \param toActivate boolean state whether it should be activated/deactivated
+  virtual bool activateSelectionAndFilters(bool toActivate);
 
-  /// Saves the internal parameters to the given feature
-  virtual bool storeValue() const;
+protected:
+  /// Checks the widget validity. By default, it returns true.
+  /// \param thePrs a selected presentation in the view
+  /// \return a boolean value
+  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
+  /// Return an object and geom shape by the viewer presentation
+  /// \param thePrs a selection
+  /// \param theObject an output object
+  /// \param theShape a shape of the selection
+  virtual void getGeomSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
+                                ObjectPtr& theObject,
+                                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 theAttribute an attribute
+  /// \param theValid a boolean flag, if restore happens for valid parameters
+  void restoreAttributeValue(const AttributePtr& theAttribute, const bool theValid);
 
-  void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
-  CompositeFeaturePtr sketch() const { return mySketch; }
+protected:
+  /// A reference to external objects manager
+  PartSet_ExternalObjectsMgr* myExternalObjectMgr;
 
-private:
+  /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
+
+  bool myUseSketchPlane; ///< state whether the sketch plane filter should be switched on
 };
 
 #endif
\ No newline at end of file