src/ModuleBase/ModuleBase_WidgetShapeSelector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_WidgetShapeSelector.h
   4 // Created:     2 June 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #ifndef ModuleBase_WidgetShapeSelector_H
   8 #define ModuleBase_WidgetShapeSelector_H
   9
  10 #include "ModuleBase.h"
  11 #include "ModuleBase_WidgetValidated.h"
  12 #include "ModuleBase_ViewerFilters.h"
  13 #include <ModuleBase_ViewerPrs.h>
  14
  15 #include <ModelAPI_Object.h>
  16 #include <ModelAPI_Attribute.h>
  17 #include <GeomAPI_Shape.h>
  18
  19 #include <TopAbs_ShapeEnum.hxx>
  20
  21 #include <QStringList>
  22
  23 class Config_WidgetAPI;
  24 class QWidget;
  25 class QLabel;
  26 class QLineEdit;
  27 class QToolButton;
  28 class ModuleBase_IWorkshop;
  29 class ModelAPI_Validator;
  30 class GeomValidators_ShapeType;
  31
  32 /**
  33 * \ingroup GUI
  34 * Implementation of widget for shapes selection.
  35 * This type of widget can be defined in XML file with 'shape_selector' keyword.
  36 * For example:
  37 * \code
  38 *   <shape_selector id="main_object"
  39 *    label="Main object"
  40 *    icon=":icons/cut_shape.png"
  41 *    tooltip="Select an object solid"
  42 *    shape_types="solid shell"
  43 *    concealment="true"
  44 *  />
  45 * \endcode
  46 * It can use following parameters:
  47 * - id - name of object attribute
  48 * - label - content of widget's label
  49 * - icon - icon which can be used instead label
  50 * - tooltip - the witget's tooltip text
  51 * - shape_types - list of shape types for selection.
  52 *       Possible values: face, vertex, wire, edge, shell, solid
  53 * - object_types - types of selectable objects.
  54 *       For today it supports only one type "construction"
  55 *        which corresponds to ModelAPI_ResultConstruction object type
  56 * - concealment - hide or not hide selected object after operation
  57 */
  58 class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetValidated
  59 {
  60 Q_OBJECT
  61  public:
  62
  63   /// Constructor
  64   /// \param theParent the parent object
  65   /// \param theWorkshop instance of workshop interface
  66   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  67   /// \param theParentId is Id of a parent of the current attribute
  68   ModuleBase_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
  69                             const Config_WidgetAPI* theData, const std::string& theParentId);
  70
  71   virtual ~ModuleBase_WidgetShapeSelector();
  72
  73   virtual bool restoreValue();
  74
  75   /// Defines if it is supposed that the widget should interact with the viewer.
  76   virtual bool isViewerSelector() { return true; }
  77
  78   /// Returns list of widget controls
  79   /// \return a control list
  80   virtual QList<QWidget*> getControls() const;
  81
  82   /// Checks the widget validity. By default, it returns true.
  83   /// \param theValue a selected presentation in the view
  84   /// \return a boolean value
  85   virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  86
  87   /// Fills the attribute with the value of the selected owner
  88   /// \param theOwner a selected owner
  89   virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  90
  91   /// The methiod called when widget is deactivated
  92   virtual void deactivate();
  93
  94 protected:
  95   /// Activate or deactivate selection
  96   void activateSelection(bool toActivate);
  97
  98  private slots:
  99    /// Slot which is called on selection event
 100   void onSelectionChanged();
 101
 102  protected:
 103   /// Saves the internal parameters to the given feature
 104   /// \return True in success
 105   virtual bool storeValueCustom() const;
 106
 107   /// The methiod called when widget is activated
 108   virtual void activateCustom();
 109
 110   /// Creates a backup of the current values of the attribute
 111   /// It should be realized in the specific widget because of different
 112   /// parameters of the current attribute
 113   virtual void storeAttributeValue();
 114
 115   /// Creates a backup of the current values of the attribute
 116   /// It should be realized in the specific widget because of different
 117   /// parameters of the current attribute
 118   /// \param theValid a boolean flag, if restore happens for valid parameters
 119   virtual void restoreAttributeValue(const bool theValid);
 120
 121   /// Computes and updates name of selected object in the widget
 122   void updateSelectionName();
 123
 124   /// Raise panel which contains this widget
 125   void raisePanel() const;
 126
 127   /// Returns true if selected shape corresponds to requested shape types
 128   /// \param theShape a shape
 129   bool acceptSubShape(const TopoDS_Shape& theShape) const;
 130
 131   /// Clear attribute
 132   void clearAttribute();
 133
 134   /// Store the values to the model attribute of the widget. It casts this attribute to
 135   /// the specific type and set the given values
 136   /// \param theSelectedObject an object
 137   /// \param theShape a selected shape, which is used in the selection attribute
 138   /// \return true if it is succeed
 139   virtual bool setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
 140
 141   /// Get the shape from the attribute if the attribute contains a shape, e.g. selection attribute
 142   /// \return a shape
 143   virtual GeomShapePtr getShape() const;
 144
 145   /// Return the attribute values wrapped in a list of viewer presentations
 146   /// \return a list of viewer presentations, which contains an attribute result and
 147   /// a shape. If the attribute do not uses the shape, it is empty
 148   QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
 149
 150   //----------- Class members -------------
 151   protected:
 152   /// Label of the widget
 153   QLabel* myLabel;
 154
 155   /// Input control of the widget
 156   QLineEdit* myTextLine;
 157
 158   /// Reference to workshop
 159   ModuleBase_IWorkshop* myWorkshop;
 160
 161   /// List of accepting shapes types
 162   QStringList myShapeTypes;
 163
 164   /// backup parameters of the model attribute. The class processes three types of attribute:
 165   /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
 166   /// values are reserved in the backup
 167   /// An attribute object
 168   ObjectPtr myObject;
 169   /// An attribute shape
 170   GeomShapePtr myShape;
 171   /// A reference of the attribute
 172   AttributePtr myRefAttribute;
 173   /// A boolean value whether refAttr uses reference of object
 174   bool myIsObject;
 175
 176   /// An instance of the "shape_type" validator. It is returns on validating in customValidator()
 177   GeomValidators_ShapeType* myShapeValidator;
 178 };
 179
 180 #endif