X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FPartSet%2FPartSet_WidgetSketchLabel.h;h=9da513f5d2a3bc2527cf0eebc9b3693d5627716b;hb=f7a976b98d8cadadcb54a61e42ddb66e00759689;hp=5d4ad6f52eebe4a30c4e86e45e81459e754b87de;hpb=a7f44a41bdf29e7bd978ff3b8c8bd514d1223be7;p=modules%2Fshaper.git

diff --git a/src/PartSet/PartSet_WidgetSketchLabel.h b/src/PartSet/PartSet_WidgetSketchLabel.h
index 5d4ad6f52..9da513f5d 100644
--- a/src/PartSet/PartSet_WidgetSketchLabel.h
+++ b/src/PartSet/PartSet_WidgetSketchLabel.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        PartSet_WidgetSketchLabel.h
 // Created:     07 July 2014
 // Author:      Vitaly SMETANNIKOV
@@ -18,26 +20,34 @@
 #include <TopoDS_Shape.hxx>
 
 class QLabel;
+class QTimer;
 class XGUI_OperationMgr;
 class XGUI_Workshop;
-//class PartSet_OperationSketch;
 
+/// the plane edge width
+#define SKETCH_WIDTH        "4"
+
+/// face of the square-face displayed for selection of general plane
+#define PLANE_SIZE          "200"
+
+/**
+* \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_ModelWidget
 {
 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 bool restoreValue()
   {
     return true;
@@ -47,37 +57,65 @@ Q_OBJECT
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
-  QWidget* getControl() const;
-
-  /// The methiod called when widget is activated
-  virtual void activate();
-
   /// 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);
 
+protected:
+  /// 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:
+   /// 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();
 
-  void setSketchingMode();
 
   QLabel* myLabel;
   QString myText;
@@ -91,7 +129,8 @@ signals:
   bool myPreviewDisplayed;
 
   Handle(StdSelect_FaceFilter) myFaceFilter;
-  //Handle(ModuleBase_ShapeInPlaneFilter) mySketchFilter;
+
+  QTimer* mySelectionTimer;
 };
 
 #endif