1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: XGUI_Displayer.h
4 // Created: 20 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #ifndef XGUI_Displayer_H
8 #define XGUI_Displayer_H
12 #include <GeomAPI_AISObject.h>
13 #include <TopoDS_Shape.hxx>
14 #include <AIS_InteractiveObject.hxx>
15 #include <AIS_InteractiveContext.hxx>
16 #include <NCollection_List.hxx>
18 #include <ModelAPI_Result.h>
20 #include <ModuleBase_Definitions.h>
21 #include <ModuleBase_ViewerPrs.h>
23 #include <GeomAPI_ICustomPrs.h>
25 #include <SelectMgr_AndFilter.hxx>
32 class ModelAPI_Feature;
35 /**\class XGUI_Displayer
37 * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer
39 class XGUI_EXPORT XGUI_Displayer: public QObject
43 /// \enum DisplayMode display mode
45 /// Mode is not defined
47 /// Wireframe display mode
49 /// Shading display mode
54 /// \param theWorkshop a workshop instance
55 XGUI_Displayer(XGUI_Workshop* theWorkshop);
58 virtual ~XGUI_Displayer();
60 /// Returns the feature visibility state.
61 /// \param theObject an object instance
62 bool isVisible(ObjectPtr theObject) const;
64 /// Display the feature. Obtain the visualized object from the feature.
65 /// \param theObject an object to display
66 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
67 /// \return true if the object visibility state is changed
68 bool display(ObjectPtr theObject, bool theUpdateViewer = true);
70 /// Display the given AIS object. This object is not added to the displayer internal map of objects
71 /// So, it can not be obtained from displayer. This is just a wrap method of OCC display in order
72 /// to perform the display with correct flags.
73 /// \param theAIS AIOS object to display
74 /// \param toActivateInSelectionModes boolean value whether the presentation should be
75 /// activated in the current selection modes
76 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
77 /// \return true if the object visibility state is changed
78 bool displayAIS(AISObjectPtr theAIS, const bool toActivateInSelectionModes,
79 bool theUpdateViewer = true);
81 /// Redisplay the shape if it was displayed
82 /// \param theObject an object instance
83 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
84 /// \return true if the object visibility state is changed
85 bool redisplay(ObjectPtr theObject, bool theUpdateViewer = true);
87 /// Sends and flushes a signal to redisplay all visualized objects.
88 void redisplayObjects();
90 /// Add presentations to current selection. It unhighlight and deselect the current selection.
91 /// The shape and result components are processed in the values. If the presentation shape is not
92 /// empty, select it, otherwise select the result.
93 /// \param theValues a list of presentation to be selected
94 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
95 void setSelected(const QList<ModuleBase_ViewerPrs>& theValues, bool theUpdateViewer = true);
97 /// Unselect all objects
100 /// Erase the feature and a shape.
101 /// \param theObject an object instance
102 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
103 /// \return true if the object visibility state is changed
104 bool erase(ObjectPtr theObject, const bool theUpdateViewer = true);
106 /// Erase the given AIS object displayed by corresponded display method
107 /// \param theAIS instance of AIS object
108 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
109 /// \return true if the object visibility state is changed
110 bool eraseAIS(AISObjectPtr theAIS, const bool theUpdateViewer = true);
112 /// Erase all presentations
113 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
114 /// \return true if the object visibility state is changed
115 bool eraseAll(const bool theUpdateViewer = true);
117 /// Deactivates selection of sub-shapes
118 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
119 void closeLocalContexts(const bool theUpdateViewer = true);
121 /// Remove default selection filters of the module from the current viewer
122 void deactivateSelectionFilters();
124 /// \brief Add selection filter
125 /// \param theFilter a filter instance
126 void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
128 /// \brief Remove selection filter
129 /// \param theFilter a filter instance
130 void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
132 /// Returns true if the selection filter is set to the viewer
133 /// \param theFilter a selection filter
134 virtual bool hasSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
136 /// Remove all selection filters
137 void removeFilters();
139 /// Sets a flag to the displayer whether the internal viewer can be updated by
140 /// the updateViewer method call. If it is not enabled, this method do nothing.
141 /// This state maintain recurse, if the update is blocked twice or three times, the
142 /// viewer will not be updated until it is unblocked necessary times(twice or three in the example).
143 /// \param isEnabled a boolean value
144 bool enableUpdateViewer(const bool isEnabled);
146 /// Returns true if the viewer update is not blocked
147 bool isUpdateEnabled() const;
149 /// Updates the viewer
150 void updateViewer() const;
152 /// Activate interactive context
153 /// \param theIO an interactive object
154 /// \param theMode activation mode
155 /// \param theUpdateViewer update viewer flag
156 void activateAIS(const Handle(AIS_InteractiveObject)& theIO, const int theMode,
157 const bool theUpdateViewer) const;
159 /// Activate interactive context. It is necessary to call ClearOutdatedSelection after deactivation
160 /// \param theIO an interactive object
161 /// \param theMode a mode to deactivate. When theMode=-1 then all modes will be deactivated
162 void deactivateAIS(const Handle(AIS_InteractiveObject)& theIO, const int theMode = -1) const;
164 /// Searches the interactive object by feature
165 /// \param theObject the object or presentable feature
166 /// \return theIO an interactive object
167 AISObjectPtr getAISObject(ObjectPtr theObject) const;
169 /// Searches the feature by interactive object
170 /// \param theIO an interactive object
171 /// \return feature the feature or NULL if it not visualized
172 ObjectPtr getObject(const AISObjectPtr& theIO) const;
174 /// Searches the feature by interactive object
175 /// \param theIO an interactive object
176 /// \return corresponded object or NULL if it not found
177 ObjectPtr getObject(const Handle(AIS_InteractiveObject)& theIO) const;
179 /// Deactivates the given objects (not allow selection)
180 /// \param theObjList - list of objects which has to be deactivated.
181 /// \param theUpdateViewer update viewer flag
182 void deactivateObjects(const QObjectPtrList& theObjList,
183 const bool theUpdateViewer = true);
185 /// Returns the modes of activation
186 /// \param theObject the feature or NULL if it not visualized
187 /// \param theModes - modes on which it is activated (can be empty)
188 void getModesOfActivation(ObjectPtr theObject, QIntList& theModes);
190 /// Returns true if the given object can be selected
191 /// \param theObject object to check
192 bool isActive(ObjectPtr theObject) const;
194 /// Activates in local context displayed outside of the context.
195 /// \param theModes - modes on which it has to be activated (can be empty)
196 /// \param theObjList - list of objects which has to be activated.
197 /// \param theUpdateViewer an update viewer flag
198 void activateObjects(const QIntList& theModes, const QObjectPtrList& theObjList,
199 const bool theUpdateViewer = true);
201 /// Sets display mode for the given object if this object is displayed
202 void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool theUpdateViewer = true);
204 /// Returns current display mode for the given object.
205 /// If object is not dis played then returns NoMode.
206 /// \param theObject object to check
207 DisplayMode displayMode(ObjectPtr theObject) const;
209 /// Displays only objects listed in the list
210 /// \param theList list of objects
211 void showOnly(const QObjectPtrList& theList);
213 /// Returns number of displayed objects
214 int objectsCount() const { return myResult2AISObjectMap.size(); }
216 /// Returns list of displayed objects
217 QObjectPtrList displayedObjects() const { return myResult2AISObjectMap.keys(); }
219 /// Returns list of displayed objects
220 QList<AISObjectPtr> displayedPresentations() const { return myResult2AISObjectMap.values(); }
222 /// Returns true if the given object can be shown in shaded mode
223 /// \param theObject object to check
224 bool canBeShaded(ObjectPtr theObject) const;
226 /// Set color on presentation of an object if it is displayed
227 /// \param theObject an object
228 /// \param theColor a color which has to be set
229 /// \param theUpdateViewer update viewer flag
230 /// \return previously defined color on the object
231 QColor setObjectColor(ObjectPtr theObject, const QColor& theColor, bool theUpdateViewer = true);
233 /// Returns Trihedron object if it is displayed
234 Handle(AIS_InteractiveObject) getTrihedron() const;
236 /// Set trihedron active (used in selection) or non active
237 void activateTrihedron(bool theIsActive);
239 /// Displays/erases thrihedron in current modes. It will be activated or deactivated
240 /// depending on the trihedron visible state and displayer active trihedron state
241 void displayTrihedron(bool theToDisplay) const;
243 /// Returns true if the trihedron should be activated in current selection modes
244 bool isTrihedronActive() const { return myIsTrihedronActive; }
246 /// Converts shape type (TopAbs_ShapeEnum) to selection mode
247 /// \param theShapeType a shape type from TopAbs_ShapeEnum
248 static int getSelectionMode(int theShapeType);
251 /// Signal on object display
252 /// \param theObject a data object
253 /// \param theAIS a presentation object
254 void objectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
256 /// Signal on before object erase
257 /// \param theObject a data object
258 /// \param theAIS a presentation object
259 void beforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
262 /// Returns currently installed AIS_InteractiveContext
263 Handle(AIS_InteractiveContext) AISContext() const;
265 /// Returns the viewer context top filter. If there is no a filter, it is created and set into
266 /// The context should have only this filter inside. Other filters should be add to the filter
267 Handle(SelectMgr_AndFilter) GetFilter();
269 /// Display the feature and a shape. This shape would be associated to the given feature
270 /// \param theObject an object instance
271 /// \param theAIS AIS presentation
272 /// \param isShading flag to show in shading mode
273 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
274 /// \return true if the object visibility state is changed
275 bool display(ObjectPtr theObject, AISObjectPtr theAIS, bool isShading,
276 bool theUpdateViewer = true);
279 /// Activates the interactive object in the local context.
280 /// \param theIO an interactive object
281 /// \param theModes - modes on which it has to be activated (can be empty)
282 /// \return a flag is object activated or not
283 bool activate(const Handle(AIS_InteractiveObject)& theIO, const QIntList& theModes,
284 const bool theUpdateViewer) const;
286 /// Deactivates the given object (not allow selection)
287 /// \param theObject object to deactivate
288 void deactivate(ObjectPtr theObject, const bool theUpdateViewer);
290 /// Find a trihedron in a list of displayed presentations and deactivate it.
291 /// \param theUpdateViewer an update viewer flag
292 void deactivateTrihedron(const bool theUpdateViewer) const;
294 /// Opens local context. Does nothing if it is already opened.
295 void openLocalContext();
297 /// Update the object presentable properties such as color, lines width and other
298 /// If the object is result with the color attribute value set, it is used,
299 /// otherwise the customize is applyed to the object's feature if it is a custom prs
300 /// \param theObject an object instance
301 /// \return the true state if there is changes and the presentation is customized
302 bool customizeObject(ObjectPtr theObject);
304 /// Append the objects in the internal map. Checks whether the map already contains the object
305 /// \param theObject an object to display
306 /// \param theAIS AIOS object to display
307 void appendResultObject(ObjectPtr theObject, AISObjectPtr theAIS);
309 /// Returns an information about alredy displayed objects
310 /// \return a string representation
311 std::string getResult2AISObjectMapInfo() const;
314 /// Reference to workshop
315 XGUI_Workshop* myWorkshop;
317 /// A container for selection filters
318 Handle(SelectMgr_AndFilter) myAndFilter;
320 /// A default custom presentation, which is used if the displayed feature is not a custom presentation
321 GeomCustomPrsPtr myCustomPrs;
323 /// Definition of a type of map which defines correspondance between objects and presentations
324 typedef QMap<ObjectPtr, AISObjectPtr> ResultToAISMap;
326 /// A map of displayed objects
327 ResultToAISMap myResult2AISObjectMap;
329 /// Selection modes installed for external objects in local context
330 QIntList myActiveSelectionModes;
332 /// Number of blocking of the viewer update. The viewer is updated only if it equals zero
333 int myViewerBlockedRecursiveCount;
335 // Flag: use trihedgon for selection or not
336 bool myIsTrihedronActive;
338 /// A flag that update was requested but not done
339 mutable bool myNeedUpdate;