1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef XGUI_FacesPanel_H_
22 #define XGUI_FacesPanel_H_
26 #include <ModelAPI_Object.h>
28 #include <ModuleBase_ActionType.h>
29 #include <ModuleBase_ViewerPrs.h>
31 #include <QDockWidget>
37 class AIS_InteractiveObject;
39 class GeomAPI_AISObject;
41 class ModuleBase_IWorkshop;
42 class ModuleBase_ListView;
50 * A Hide Faces panel for making it possible to hide faces in the 3D view.
51 * The panel has multi-selector filled by faces elements. When the control is active
52 * it is possible to select faces in the viewer. The selected faces are hidden/transparent
53 * after selection and the corresponding item is appeared in the multi selector.
55 * In order to redisplay a face, it is enough to click delete on the name of this face
56 * in the multiselector.
57 * When the panel is opened, the multiselector is empty.
58 * When the panel is closed, the multiselector is emptied and the faces are displayed again.
59 * The default position by of this dockable window is to the right of the view (in SALOME mode).
60 * If no feature is processed (in neutral point), this panel can be activated too.
61 * On feature edition start or finish, movement of the history line, undo/redo and other
62 * modification of the model, the multiselector is emptied.
64 class XGUI_EXPORT XGUI_FacesPanel : public QDockWidget
69 /// \param theParent is a parent of the property panel
70 XGUI_FacesPanel(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop);
73 /// Clear content of list widget
74 /// \param isToFlushRedisplay flag if redisplay should be flushed immediatelly
75 virtual void reset(const bool isToFlushRedisplay);
77 /// Returns whether the panel is active or not
78 bool isActivePanel() const { return myIsActive; }
80 /// Stores the state if panel is active and highlight the panel in an active color
81 /// \param theIsActive state whether the panel should be activated or deactivated
82 void setActivePanel(const bool theIsActive);
84 /// Returns true if transparency choice is checked
85 /// \return boolean value
86 bool useTransparency() const;
88 /// Returns true if the object is in internal container of hidden objects by this panel
89 /// \param theObject a checked object
90 /// \return boolean value
91 bool isObjectHiddenByPanel(const std::shared_ptr<ModelAPI_Object>& theObject) const
92 { return myHiddenObjects.find(theObject) != myHiddenObjects.end(); }
94 /// Removed faces of the objects from the panel
95 /// \param container of objects
96 void restoreObjects(const std::set<std::shared_ptr<ModelAPI_Object> >& theHiddenObjects);
98 /// Returns true if the event is processed. The default implementation is empty, returns false.
99 virtual bool processAction(ModuleBase_ActionType theActionType);
101 /// Append selected item in the list and customize presentations to hide faces
102 void processSelection();
104 /// Deletes item in a list of elements
105 /// \return whether the delete action is processed
106 bool processDelete();
108 /// Processing focus in/out for the faces control
109 /// \param theObject source object of event
110 /// \param theEvent an event
111 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
113 /// Hide/show faces of the object if:
114 /// - face selector is active
115 /// - object is mentioned in the list of selected elements
116 /// If the object is displayed, all panel faces selected on it will be moved into presentation
117 /// or, if redisplayed, fuction return if the object should be redisplayed or not
118 /// \param theObject a customized object
119 /// \param thePresentation visualized presentation of the object
120 /// \return true if the presentation is customized
121 bool customizeObject(const std::shared_ptr<ModelAPI_Object>& theObject,
122 const std::shared_ptr<GeomAPI_AISObject>& thePresentation);
125 /// Add panel selection filters to the current viewer
126 virtual void activateSelectionFilters() {}
128 /// Remove panel selection filters from the current viewer
129 virtual void deactivateSelectionFilters() {}
132 /// Reimplementation to emit a signal about the panel close
133 virtual void closeEvent(QCloseEvent* theEvent);
136 /// Signal about activating pane
138 /// Signal about deactivating pane
140 /// Signal is emitted by the top widget cross button click
144 /// Activate or deactivate selection and selection filters
145 void activateSelection(bool toActivate);
147 /// Redisplay objects.
148 /// \param theObjects container of objects
149 /// \param isToFlushRedisplay flag if redisplay should be flushed immediatelly
150 /// \return true if some of objects was redisplayed
151 static bool redisplayObjects(const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects,
152 const bool isToFlushRedisplay);
154 /// Display objects if the objects are in a container of hidden by this pane.
155 /// \param theObjects container of objects
156 /// \param theHiddenObjects hidden objects, if object is in the container, it should be removed
157 /// \param isToFlushRedisplay flag if redisplay should be flushed immediatelly
158 /// \return true if some of objects was redisplayed
159 static bool displayHiddenObjects(const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects,
160 std::set<std::shared_ptr<ModelAPI_Object> >& theHiddenObjects,
161 const bool isToFlushRedisplay);
163 /// Iterates by items and hide objects where all sub-shapes are hidden
164 /// \return true if some of objects was redisplayed
165 bool hideEmptyObjects();
167 /// Container of objects participating in the panel, it is filled by internal container
168 /// \param theItems container of selected values
169 /// \param theObjects [out] container of objects
170 static void updateProcessedObjects(QMap<int, std::shared_ptr<ModuleBase_ViewerPrs> > theItems,
171 std::set<std::shared_ptr<ModelAPI_Object> >& theObjects);
173 /// Generates a presentation name in form: <object_name>/<face>_<face_index>
174 /// \param thePrs a presentation
175 /// \return string value
176 static QString generateName(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
179 /// Deletes element in list of items
182 /// Upates hidden faces to be hidden or transparent
183 void onTransparencyChanged();
185 /// Closes faces panel restore all hidden faces by calling reset()
189 QCheckBox* myHiddenOrTransparent; ///< if checked - transparent, else hidden
190 ModuleBase_ListView* myListView; ///< list control of processed faces
191 ModuleBase_IWorkshop* myWorkshop; ///< workshop
193 bool myIsActive; ///< current state about the panel is active
194 int myLastItemIndex; ///< last index to be used in the map of items for the next added item
196 QMap<int, std::shared_ptr<ModuleBase_ViewerPrs> > myItems; ///< selected face items
197 std::set<std::shared_ptr<ModelAPI_Object> > myItemObjects; ///< cached objects of myItems
198 std::set<std::shared_ptr<ModelAPI_Object> > myHiddenObjects; ///< hidden objects