src/PartSet/PartSet_WidgetPoint2dDistance.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        PartSet_WidgetPoint2dDistance.h
   4 // Created:     23 June 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #ifndef PartSet_WidgetPoint2dDistance_H
   8 #define PartSet_WidgetPoint2dDistance_H
   9
  10 #include "PartSet.h"
  11 #include <ModuleBase_WidgetDoubleValue.h>
  12
  13 #include <ModelAPI_CompositeFeature.h>
  14
  15 class GeomAPI_Pnt2d;
  16 class ModuleBase_IWorkshop;
  17 class ModuleBase_IViewWindow;
  18 class QMouseEvent;
  19
  20 /**
  21 * \ingroup Modules
  22 * Implementation of model widget for widget which provides input of a distance between two points
  23 * In XML file can be defined as following:
  24 * \code
  25 * <point2ddistance id="CircleRadius"
  26 *   first_point="CircleCenter"
  27 *   label="Radius:"
  28 *   min="0"
  29 *   step="1.0"
  30 *   default="0"
  31 *   icon=":icons/radius.png"
  32 *   tooltip="Set radius">
  33 *   <validator id="GeomValidators_Positive"/>
  34 * </point2ddistance>
  35 * \endcode
  36 */
  37 class PARTSET_EXPORT PartSet_WidgetPoint2dDistance : public ModuleBase_WidgetDoubleValue
  38 {
  39 Q_OBJECT
  40  public:
  41   /// Constructor
  42   /// \param theParent the parent object
  43   /// \param theWorkshop a current workshop
  44   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  45   PartSet_WidgetPoint2dDistance(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
  46                                 const Config_WidgetAPI* theData);
  47
  48   virtual ~PartSet_WidgetPoint2dDistance();
  49
  50   /// The methiod called when widget is deactivated
  51   virtual void deactivate();
  52
  53   /// \returns the sketch instance
  54   CompositeFeaturePtr sketch() const { return mySketch; }
  55
  56   /// Set sketch instance
  57   void setSketch(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
  58
  59   /// Returns true if the event is processed.
  60   virtual bool processEnter();
  61
  62 public slots:
  63    /// Process of mouse move
  64    /// \param theWnd a pointer to a window
  65    /// \param theEvent a mouse event
  66   void onMouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
  67
  68   protected slots:
  69    /// Process of mouse release
  70    /// \param theWnd a pointer to a window
  71    /// \param theEvent a mouse event
  72   void onMouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
  73
  74 protected:
  75   /// Store current value in cashed value
  76   void storeCurentValue();
  77
  78   /// Restore cashed value in the model attribute
  79   /// \return boolean state if the restored feature shoud be hidden
  80   bool restoreCurentValue();
  81
  82   /// Fills the widget with default values
  83   /// \return true if the widget current value is reset
  84   virtual bool resetCustom();
  85
  86   /// The methiod called when widget is activated
  87   virtual void activateCustom();
  88
  89   /// Set the second point which defines a value in the widget as a distance with a first point defined by feature
  90   void setPoint(FeaturePtr theFeature, const std::shared_ptr<GeomAPI_Pnt2d>& thePnt);
  91
  92   /// Compute the distance between points
  93   /// \param theFirstPnt a point value of the out point attribute
  94   /// \param theCurrentPnt a point of the current widget
  95   /// \return a double value
  96   virtual double computeValue(const std::shared_ptr<GeomAPI_Pnt2d>& theFirstPnt,
  97                               const std::shared_ptr<GeomAPI_Pnt2d>& theCurrentPnt);
  98
  99 protected:
 100   /// A reference to workshop
 101   ModuleBase_IWorkshop* myWorkshop;
 102
 103   /// A name of the first point
 104   std::string myFirstPntName;
 105
 106   /// Reference to sketch
 107   CompositeFeaturePtr mySketch;
 108
 109   bool myValueIsCashed; /// boolean state if the value is cashed during value state change
 110   bool myIsFeatureVisibleInCash; /// boolean value if the feature was visible when cash if filled
 111   double myValueInCash; /// the cashed X value during value state change
 112 };
 113
 114 #endif