src/ModuleBase/ModuleBase_WidgetSelector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_WidgetSelector.h
   4 // Created:     19 June 2015
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef ModuleBase_WidgetSelector_H
   8 #define ModuleBase_WidgetSelector_H
   9
  10 #include "ModuleBase.h"
  11 #include "ModuleBase_WidgetValidated.h"
  12 #include <ModuleBase_ViewerPrs.h>
  13 #include "ModuleBase_Definitions.h"
  14
  15 #include <ModelAPI_Object.h>
  16 #include <ModelAPI_Attribute.h>
  17 #include <GeomAPI_Shape.h>
  18
  19 class Config_WidgetAPI;
  20 class QWidget;
  21 class ModuleBase_IWorkshop;
  22
  23 /**
  24 * \ingroup GUI
  25 * Implementation of widget for selection.
  26 * This abstract interface is designed to be used for shape/multi shape selector widgets.
  27 */
  28 class MODULEBASE_EXPORT ModuleBase_WidgetSelector : public ModuleBase_WidgetValidated
  29 {
  30 Q_OBJECT
  31  public:
  32
  33   /// Constructor
  34   /// \param theParent the parent object
  35   /// \param theWorkshop instance of workshop interface
  36   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  37   ModuleBase_WidgetSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
  38                             const Config_WidgetAPI* theData);
  39
  40   virtual ~ModuleBase_WidgetSelector();
  41
  42   /// Defines if it is supposed that the widget should interact with the viewer.
  43   virtual bool isViewerSelector() { return true; }
  44
  45   /// Activate or deactivate selection and selection filters
  46   /// \return true if the selection filter of the widget is activated in viewer context
  47   virtual bool activateSelectionAndFilters(bool toActivate);
  48
  49   /// Checks the widget validity. By default, it returns true.
  50   /// \param thePrs a selected presentation in the view
  51   /// \return a boolean value
  52   virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  53
  54   /// Fills the attribute with the value of the selected owner
  55   /// \param thePrs a selected owner
  56   virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  57
  58   /// The methiod called when widget is deactivated
  59   virtual void deactivate();
  60
  61  private slots:
  62    /// Slot which is called on selection event
  63   void onSelectionChanged();
  64
  65  protected:
  66   /// Update focus after the attribute value change
  67    virtual void updateFocus() {};
  68
  69   /// Return the attribute values wrapped in a list of viewer presentations
  70   /// \return a list of viewer presentations, which contains an attribute result and
  71   /// a shape. If the attribute do not uses the shape, it is empty
  72    virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
  73
  74   /// Retunrs a list of possible shape types
  75   /// \return a list of shapes
  76   virtual QIntList getShapeTypes() const = 0;
  77
  78   /// Computes and updates name of selected object in the widget
  79   virtual void updateSelectionName() {};
  80
  81   /// Store the values to the model attribute of the widget. It casts this attribute to
  82   /// the specific type and set the given values
  83   /// \param theSelectedObject an object
  84   /// \param theShape a selected shape, which is used in the selection attribute
  85   /// \return true if it is succeed
  86   virtual void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape) {};
  87
  88   /// The methiod called when widget is activated
  89   virtual void activateCustom();
  90
  91   /// Returns true if selected shape corresponds to requested shape types.
  92   /// If the widget type of shapes contains the faces item, the result is converted
  93   /// to construction result and the method returns true if there is at least one face
  94   /// in the construction.
  95   /// \param theShape a shape
  96   /// \param theResult a selected result
  97   bool acceptSubShape(const GeomShapePtr& theShape, const ResultPtr& theResult) const;
  98
  99   /// Return an object and geom shape by the viewer presentation
 100   /// \param thePrs a selection
 101   /// \param theObject an output object
 102   /// \param theShape a shape of the selection
 103   virtual void getGeomSelection(const ModuleBase_ViewerPrs& thePrs,
 104                                 ObjectPtr& theObject,
 105                                 GeomShapePtr& theShape);
 106
 107   //----------- Class members -------------
 108   /// Returns a name in the next form: attribute_feature_name/attribute_id
 109   /// \param theAttribute a model attribute
 110   /// \return string value
 111   static std::string generateName(const AttributePtr& theAttribite,
 112                                   ModuleBase_IWorkshop* theWorkshop);
 113 };
 114
 115 #endif