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
  30 /**
  31 * \ingroup GUI
  32 * Implementation of widget for shapes selection.
  33 * This type of widget can be defined in XML file with 'shape_selector' keyword.
  34 * For example:
  35 * \code
  36 *   <shape_selector id="main_object"
  37 *    label="Main object"
  38 *    icon=":icons/cut_shape.png"
  39 *    tooltip="Select an object solid"
  40 *    shape_types="solid shell"
  41 *    concealment="true"
  42 *  />
  43 * \endcode
  44 * It can use following parameters:
  45 * - id - name of object attribute
  46 * - label - content of widget's label
  47 * - icon - icon which can be used instead label
  48 * - tooltip - the witget's tooltip text
  49 * - shape_types - list of shape types for selection.
  50 *       Possible values: face, vertex, wire, edge, shell, solid
  51 * - object_types - types of selectable objects.
  52 *       For today it supports only one type "construction"
  53 *        which corresponds to ModelAPI_ResultConstruction object type
  54 * - concealment - hide or not hide selected object after operation
  55 */
  56 class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetValidated
  57 {
  58 Q_OBJECT
  59  public:
  60
  61    /// Converts string value (name of shape type) to shape enum value
  62    /// \param theType - string with shape type name
  63    /// \return TopAbs_ShapeEnum value
  64   static TopAbs_ShapeEnum shapeType(const QString& theType);
  65
  66   /// Constructor
  67   /// \param theParent the parent object
  68   /// \param theWorkshop instance of workshop interface
  69   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  70   /// \param theParentId is Id of a parent of the current attribute
  71   ModuleBase_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
  72                             const Config_WidgetAPI* theData, const std::string& theParentId);
  73
  74   virtual ~ModuleBase_WidgetShapeSelector();
  75
  76   virtual bool restoreValue();
  77
  78   /// Defines if it is supposed that the widget should interact with the viewer.
  79   virtual bool isViewerSelector() { return true; }
  80
  81   /// Returns list of widget controls
  82   /// \return a control list
  83   virtual QList<QWidget*> getControls() const;
  84
  85   /// Fills the attribute with the value of the selected owner
  86   /// \param theOwner a selected owner
  87   virtual bool setSelection(const Handle_SelectMgr_EntityOwner& theOwner);
  88
  89   /// The methiod called when widget is deactivated
  90   virtual void deactivate();
  91
  92  public slots:
  93
  94   /// Activate or deactivate selection
  95   void activateSelection(bool toActivate);
  96
  97  private slots:
  98    /// Slot which is called on selection event
  99   void onSelectionChanged();
 100
 101  protected:
 102   /// Saves the internal parameters to the given feature
 103   /// \return True in success
 104   virtual bool storeValueCustom() const;
 105
 106   /// The methiod called when widget is activated
 107   virtual void activateCustom();
 108
 109   /// Creates a backup of the current values of the attribute
 110   /// It should be realized in the specific widget because of different
 111   /// parameters of the current attribute
 112   /// \param isBackup a boolean flag, if true, store values from the attribute
 113   /// to backup, otherwise set the backed up values to the attribute
 114   virtual void backupAttributeValue(const bool isBackup);
 115
 116   /// Computes and updates name of selected object in the widget
 117   void updateSelectionName();
 118
 119   /// Raise panel which contains this widget
 120   void raisePanel() const;
 121
 122   /// Returns true if selected shape corresponds to requested shape types
 123   /// \param theShape a shape
 124   virtual bool acceptSubShape(std::shared_ptr<GeomAPI_Shape> theShape) const;
 125
 126   // Get the shape from the attribute it the attribute contain a shape, e.g. selection attribute
 127   /// \return a shape
 128   GeomShapePtr getShape() const;
 129
 130   /// Clear attribute
 131   void clearAttribute();
 132
 133   /// Store the values to the model attribute of the widget. It casts this attribute to
 134   /// the specific type and set the given values
 135   /// \param theSelectedObject an object
 136   /// \param theShape a selected shape, which is used in the selection attribute
 137   virtual bool storeAttributeValues(ObjectPtr theSelectedObject, GeomShapePtr theShape) const;
 138
 139   //----------- Class members -------------
 140   protected:
 141   /// Label of the widget
 142   QLabel* myLabel;
 143
 144   /// Input control of the widget
 145   QLineEdit* myTextLine;
 146
 147   /// Reference to workshop
 148   ModuleBase_IWorkshop* myWorkshop;
 149
 150   /// List of accepting shapes types
 151   QStringList myShapeTypes;
 152
 153   /// Active/inactive flag
 154   bool myIsActive;
 155
 156   /// backup parameters of the model attribute. The class processes three types of attribute:
 157   /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
 158   /// values are reserved in the backup
 159   /// An attribute object
 160   ObjectPtr myObject;
 161   /// An attribute shape
 162   GeomShapePtr myShape;
 163   /// A reference of the attribute
 164   AttributePtr myRefAttribute;
 165   /// A boolean value whether refAttr uses reference of object
 166   bool myIsObject;
 167 };
 168
 169 #endif