src/XGUI/XGUI_FacesPanel.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef XGUI_FacesPanel_H_
  21 #define XGUI_FacesPanel_H_
  22
  23 #include "XGUI.h"
  24
  25 #include <ModuleBase_ActionType.h>
  26 #include <ModuleBase_Definitions.h>
  27 #include <ModuleBase_ViewerPrs.h>
  28 #include <ModuleBase_ResultPrs.h>
  29
  30 #include <ModelAPI_Object.h>
  31 #include <ModelAPI_Feature.h>
  32
  33 #include <GeomAPI_AISObject.h>
  34
  35 #include <SelectMgr_ListOfFilter.hxx>
  36 #include <TopoDS_Shape.hxx>
  37
  38 #include <QDockWidget>
  39 #include <QObject>
  40 #include <QMap>
  41
  42 #include <set>
  43
  44 class AIS_InteractiveObject;
  45
  46 class GeomAPI_AISObject;
  47
  48 class XGUI_Workshop;
  49 class ModuleBase_ListView;
  50
  51 class QAction;
  52 class QCheckBox;
  53 class QEvent;
  54
  55 /**
  56 * \ingroup GUI
  57 * A Hide Faces panel for making it possible to hide faces in the 3D view.
  58 * The panel has multi-selector filled by faces elements. When the control is active
  59 * it is possible to select faces in the viewer. The selected faces are hidden/transparent
  60 * after selection and the corresponding item is appeared in the multi selector.
  61 *
  62 * In order to redisplay a face, it is enough to click delete on the name of this face
  63 * in the multiselector.
  64 * When the panel is opened, the multiselector is empty.
  65 * When the panel is closed, the multiselector is emptied and the faces are displayed again.
  66 * The default position by of this dockable window is to the right of the view (in SALOME mode).
  67 * If no feature is processed (in neutral point), this panel can be activated too.
  68 * On feature edition start or finish, movement of the history line, undo/redo and other
  69 * modification of the model, the multiselector is emptied.
  70 */
  71 class XGUI_EXPORT XGUI_FacesPanel : public QDockWidget
  72 {
  73   Q_OBJECT
  74 public:
  75   /// Constructor
  76   /// \param theParent is a parent of the property panel
  77   XGUI_FacesPanel(QWidget* theParent, XGUI_Workshop* theWorkshop);
  78   ~XGUI_FacesPanel() {}
  79
  80   /// Clear content of list widget
  81   /// \param isToFlushRedisplay flag if redisplay should be flushed immediatelly
  82   virtual void reset(const bool isToFlushRedisplay);
  83
  84   /// Returns whether faces panel contains elements
  85   /// \return boolean value
  86   bool isEmpty() const;
  87
  88   /// Fills container with the panel selection mode: FACE
  89   // \param theModes [out] a container of modes
  90   void selectionModes(QIntList& theModes);
  91
  92   /// Appends into container of workshop selection filters
  93   /// \param [out] selection filters
  94   void selectionFilters(SelectMgr_ListOfFilter& theSelectionFilters);
  95
  96   /// Returns whether the panel is active or not
  97   bool isActivePanel() const { return myIsActive; }
  98
  99   /// Stores the state if panel is active and highlight the panel in an active color
 100   /// \param theIsActive state whether the panel should be activated or deactivated
 101   void setActivePanel(const bool theIsActive);
 102
 103   /// Returns true if the object is in internal container of hidden objects by this panel
 104   /// \param theObject a checked object
 105   /// \return boolean value
 106   bool isObjectHiddenByPanel(const ObjectPtr& theObject) const
 107   { return myHiddenObjects.find(theObject) != myHiddenObjects.end(); }
 108
 109   /// Removed faces of the objects from the panel
 110   /// \param container of objects
 111   void restoreObjects(const std::set<ObjectPtr >& theHiddenObjects);
 112
 113   /// Returns true if the event is processed. The default implementation is empty, returns false.
 114   virtual bool processAction(ModuleBase_ActionType theActionType);
 115
 116   /// Append selected item in the list and customize presentations to hide faces
 117   void processSelection();
 118
 119   /// Deletes item in a list of elements
 120   /// \return whether the delete action is processed
 121   bool processDelete();
 122
 123   /// Delete last(s) item(s) added since the recent activation of the faces panel
 124   void processUndo();
 125
 126   /// Processing focus in/out for the faces control
 127   /// \param theObject source object of event
 128   /// \param theEvent an event
 129   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
 130
 131   XGUI_Workshop* workshop() const { return myWorkshop; }
 132
 133 public slots:
 134   /// Slot called on an object erase
 135   void onObjectDisplay(ObjectPtr theObject, AISObjectPtr theAIS);
 136
 137 protected:
 138   /// Reimplementation to emit a signal about the panel close
 139   virtual void closeEvent(QCloseEvent* theEvent);
 140
 141 signals:
 142   /// Signal about activating pane
 143   void activated();
 144   /// Signal about deactivating pane
 145   void deactivated();
 146   /// Signal is emitted by the top widget cross button click
 147   void closed();
 148
 149 private:
 150   /// Redisplay objects.
 151   /// \param theObjects container of objects
 152   /// \return true if some of objects was redisplayed
 153   static bool redisplayObjects(const std::set<ObjectPtr>& theObjects);
 154
 155   /// Container of objects participating in the panel, it is filled by internal container
 156   /// \param theItems container of selected values
 157   /// \param theObjects [out] container of objects
 158   static void updateProcessedObjects(QMap<int, ModuleBase_ViewerPrsPtr> theItems,
 159                                      std::set<ObjectPtr>& theObjects);
 160
 161   /// Returns true if transparency choice is checked
 162   /// \return boolean value
 163   bool useTransparency() const;
 164
 165   double transparency() const;
 166
 167   void removeItems(std::set<int> theIds);
 168
 169 protected slots:
 170   /// Deletes element in list of items
 171   void onDeleteItem();
 172
 173   /// Upates hidden faces to be hidden or transparent
 174   void onTransparencyChanged();
 175
 176   /// Closes faces panel restore all hidden faces by calling reset()
 177   void onClosed();
 178
 179   /// Flushes redisplay event and perform update of object browser icons
 180   /// (objects might be hidden/shown)
 181   void flushRedisplay() const;
 182
 183 private:
 184
 185   QCheckBox* myHiddenOrTransparent; ///< if checked - transparent, else hidden
 186   ModuleBase_ListView* myListView; ///< list control of processed faces
 187   XGUI_Workshop* myWorkshop; ///< workshop
 188
 189   bool myIsActive; ///< current state about the panel is active
 190   int myLastItemIndex; ///< last index to be used in the map of items for the next added item
 191   std::vector<int> myUndoList; ///< indexes of items for undo
 192
 193   QMap<int, ModuleBase_ViewerPrsPtr> myItems; ///< selected face items
 194   std::set<ObjectPtr > myItemObjects; ///< cached objects of myItems
 195   std::set<ObjectPtr > myHiddenObjects; ///< hidden objects
 196 };
 197
 198 #endif