Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0
[modules/shaper.git] / src / PartSet / PartSet_WidgetSketchLabel.h
index 5ad06d65d615ccac1f197b7cba1ded407f22b026..a0a069f785d1248ddd8ae637da275c02dfb82904 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        PartSet_WidgetSketchLabel.h
 // Created:     07 July 2014
 // Author:      Vitaly SMETANNIKOV
@@ -7,29 +9,43 @@
 
 #include "PartSet.h"
 
-#include <ModuleBase_ModelWidget.h>
+#include <ModuleBase_WidgetValidated.h>
+#include <ModuleBase_ViewerFilters.h>
+
+#include <GeomAPI_Pnt.h>
+#include <GeomAPI_Dir.h>
+#include <GeomAPI_AISObject.h>
+
+#include <TopoDS_Shape.hxx>
 
 class QLabel;
+class QTimer;
 class XGUI_OperationMgr;
-class PartSet_OperationSketch;
+class XGUI_Workshop;
+
+/// the plane edge width
+#define SKETCH_WIDTH        "4"
+
+/// face of the square-face displayed for selection of general plane
+#define PLANE_SIZE          "200"
 
-class PARTSET_EXPORT PartSet_WidgetSketchLabel : public ModuleBase_ModelWidget
+/**
+* \ingroup Modules
+* A model widget implementation for a label which provides specific behaviour 
+* for sketcher starting and launching operations
+*/
+class PARTSET_EXPORT PartSet_WidgetSketchLabel : public ModuleBase_WidgetValidated
 {
 Q_OBJECT
  public:
+  /// Constructor
+  /// \param theParent the parent object
+  /// \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_WidgetSketchLabel(QWidget* theParent, const Config_WidgetAPI* theData,
                             const std::string& theParentId);
 
-  virtual ~PartSet_WidgetSketchLabel()
-  {
-  }
-
-  /// Saves the internal parameters to the given feature
-  /// \param theFeature a model feature to be changed
-  virtual bool storeValue() const
-  {
-    return true;
-  }
+  virtual ~PartSet_WidgetSketchLabel();
 
   virtual bool restoreValue()
   {
@@ -40,19 +56,93 @@ Q_OBJECT
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
-  QWidget* getControl() const;
+  /// The methiod called when widget is deactivated
+  virtual void deactivate();
+
+  /// Returns pointer to workshop
+  XGUI_Workshop* workshop() const { return myWorkshop; }
+
+  /// Set pointer to workshop
+  /// \param theWork a pointer to workshop
+  void setWorkshop(XGUI_Workshop* theWork) { myWorkshop = theWork; }
+
+  /// Returns sketcher plane
+  std::shared_ptr<GeomAPI_Pln> plane() const;
+
+  /// This control accepts focus
+  virtual bool focusTo();
+  virtual void setHighlighted(bool) { /*do nothing*/ };
+  virtual void enableFocusProcessing();
+
+signals:
+  /// Signal on plane selection
+  void planeSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 
-  void setOperationsMgr(XGUI_OperationMgr* theMgr);
+protected:
+  /// 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
+  virtual void storeAttributeValue();
+
+  /// 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
+  virtual void restoreAttributeValue(const bool theValid);
+
+  /// Fills the attribute with the value of the selected owner
+  /// \param theOwner a selected owner
+  virtual bool setSelection(const Handle_SelectMgr_EntityOwner& theOwner);
+
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const
+  {
+    return true;
+  }
+
+  /// The methiod called when widget is activated
+  virtual void activateCustom();
 
  private slots:
+   /// Slot on plane selection
   void onPlaneSelected();
 
+  /// Set sketch specific mode of selection
+  void setSketchingMode();
+
  private:
-  void updateLabel(PartSet_OperationSketch* theSketchOpe);
+   /// Create preview of planes for sketch plane selection
+   /// \param theOrigin an origin of the plane
+   /// \param theNorm a normal vector of the plane
+   /// \param theRGB a color of plane presentation [r, g, b] array
+  AISObjectPtr createPreviewPlane(std::shared_ptr<GeomAPI_Pnt> theOrigin, 
+                                  std::shared_ptr<GeomAPI_Dir> theNorm, 
+                                  const int theRGB[3]);
+
+  /// Set sketch plane by shape
+  /// \param theShape a planar face
+  std::shared_ptr<GeomAPI_Dir> setSketchPlane(const TopoDS_Shape& theShape);
+
+  /// Erase preview planes
+  void erasePreviewPlanes();
+
+  /// Show preview planes
+  void showPreviewPlanes();
+
 
   QLabel* myLabel;
   QString myText;
   QString myTooltip;
+
+  XGUI_Workshop* myWorkshop;
+
+  AISObjectPtr myYZPlane;
+  AISObjectPtr myXZPlane;
+  AISObjectPtr myXYPlane;
+  bool myPreviewDisplayed;
+
+  QTimer* mySelectionTimer;
 };
 
 #endif