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 /// Returns true if the Feature succesfully displayed
68 void display(ObjectPtr theObject, bool theUpdateViewer = true);
70 /// Display the given AIS object. To hide this object use corresponde erase method
71 /// \param theAIS AIOS object to display
72 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
73 void displayAIS(AISObjectPtr theAIS, bool theUpdateViewer = true);
75 /** Redisplay the shape if it was displayed
76 * \param theObject an object instance
77 * \param theUpdateViewer the parameter whether the viewer should be update immediatelly
79 void redisplay(ObjectPtr theObject, bool theUpdateViewer = true);
82 * Add presentations to current selection. It unhighlight and deselect the current selection.
83 * The shape and result components are processed in the values. If the presentation shape is not
84 * empty, select it, otherwise select the result.
85 * \param theValues a list of presentation to be selected
86 * \param theUpdateViewer the parameter whether the viewer should be update immediatelly
88 void setSelected(const QList<ModuleBase_ViewerPrs>& theValues, bool theUpdateViewer = true);
91 /// Unselect all objects
94 /// Erase the feature and a shape.
95 /// \param theObject an object instance
96 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
97 void erase(ObjectPtr theObject, const bool theUpdateViewer = true);
99 /// Erase the given AIS object displayed by corresponded display method
100 /// \param theAIS instance of AIS object
101 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
102 void eraseAIS(AISObjectPtr theAIS, const bool theUpdateViewer = true);
104 /// Erase all presentations
105 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
106 void eraseAll(const bool theUpdateViewer = true);
108 /// Deactivates selection of sub-shapes
109 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
110 void closeLocalContexts(const bool theUpdateViewer = true);
112 /// \brief Add selection filter
113 /// \param theFilter a filter instance
114 void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
116 /// \brief Remove selection filter
117 /// \param theFilter a filter instance
118 void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
120 /// Remove all selection filters
121 void removeFilters();
124 * Sets a flag to the displayer whether the internal viewer can be updated by
125 * the updateViewer method call. If it is not enabled, this method do nothing
126 * \param isEnabled a boolean value
128 bool enableUpdateViewer(const bool isEnabled);
130 /// Updates the viewer
131 void updateViewer() const;
133 /// Activate interactive context
136 void activateAIS(const Handle(AIS_InteractiveObject)& theIO, const int theMode,
137 const bool theUpdateViewer) const;
139 /// Activate interactive context. It is necessary to call ClearOutdatedSelection after deactivation
140 void deactivateAIS(const Handle(AIS_InteractiveObject)& theIO, const int theMode = -1) const;
142 /// Searches the interactive object by feature
143 /// \param theObject the object or presentable feature
144 /// \return theIO an interactive object
145 AISObjectPtr getAISObject(ObjectPtr theObject) const;
147 /// Searches the feature by interactive object
148 /// \param theIO an interactive object
149 /// \return feature the feature or NULL if it not visualized
150 ObjectPtr getObject(const AISObjectPtr& theIO) const;
152 /// Searches the feature by interactive object
153 /// \param theIO an interactive object
154 /// \return corresponded object or NULL if it not found
155 ObjectPtr getObject(const Handle(AIS_InteractiveObject)& theIO) const;
157 /// Deactivates the given object (not allow selection)
158 /// \param theObject object to deactivate
159 void deactivate(ObjectPtr theObject, const bool theUpdateViewer);
161 /// Activates the given object (it can be selected)
162 /// \param theObject object to activate
163 /// \param theModes - modes on which it has to be activated (can be empty)
164 //void activate(ObjectPtr theObject, const QIntList& theModes);
166 /// Returns the modes of activation
167 /// \param theObject the feature or NULL if it not visualized
168 /// \param theModes - modes on which it is activated (can be empty)
169 void getModesOfActivation(ObjectPtr theObject, QIntList& theModes);
171 /// Activates the given object with default modes
172 /// \param theObject object to activate
173 //void activate(ObjectPtr theObject);
175 /// Returns true if the given object can be selected
176 /// \param theObject object to check
177 bool isActive(ObjectPtr theObject) const;
179 /// Activates in local context displayed outside of the context.
180 /// \param theModes - modes on which it has to be activated (can be empty)
181 /// \param theObjList - list of objects which has to be activated.
182 void activateObjects(const QIntList& theModes, const QObjectPtrList& theObjList,
183 const bool theUpdateViewer = true);
185 /// Sets display mode for the given object if this object is displayed
186 void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool theUpdateViewer = true);
188 /// Returns current display mode for the given object.
189 /// If object is not dis played then returns NoMode.
190 /// \param theObject object to check
191 DisplayMode displayMode(ObjectPtr theObject) const;
193 /// Displays only objects listed in the list
194 /// \param theList list of objects
195 void showOnly(const QObjectPtrList& theList);
197 /// Returns number of displayed objects
198 int objectsCount() const { return myResult2AISObjectMap.size(); }
200 /// Returns list of displayed objects
201 QObjectPtrList displayedObjects() const { return myResult2AISObjectMap.keys(); }
203 /// Returns list of displayed objects
204 QList<AISObjectPtr> displayedPresentations() const { return myResult2AISObjectMap.values(); }
206 /// Returns true if the given object can be shown in shaded mode
207 /// \param theObject object to check
208 bool canBeShaded(ObjectPtr theObject) const;
210 /// Set color on presentation of an object if it is displayed
211 /// \param theObject an object
212 /// \param theColor a color which has to be set
213 /// \param theUpdateViewer update viewer flag
214 /// \return previously defined color on the object
215 QColor setObjectColor(ObjectPtr theObject, const QColor& theColor, bool theUpdateViewer = true);
218 /// Signal on object display
219 /// \param theObject a data object
220 /// \param theAIS a presentation object
221 void objectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
223 /// Signal on before object erase
224 /// \param theObject a data object
225 /// \param theAIS a presentation object
226 void beforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
229 /// Returns currently installed AIS_InteractiveContext
230 Handle(AIS_InteractiveContext) AISContext() const;
232 /// Returns the viewer context top filter. If there is no a filter, it is created and set into
233 /// The context should have only this filter inside. Other filters should be add to the filter
234 Handle(SelectMgr_AndFilter) GetFilter();
236 /// Display the feature and a shape. This shape would be associated to the given feature
237 /// \param theObject an object instance
238 /// \param theAIS AIS presentation
239 /// \param isShading flag to show in shading mode
240 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
241 /// \return true if the object is succesfully displayed
242 void display(ObjectPtr theObject, AISObjectPtr theAIS, bool isShading,
243 bool theUpdateViewer = true);
246 /// Activates the interactive object in the local context.
247 /// \param theIO an interactive object
248 /// \param theModes - modes on which it has to be activated (can be empty)
249 void activate(const Handle(AIS_InteractiveObject)& theIO, const QIntList& theModes,
250 const bool theUpdateViewer) const;
252 /// Find a trihedron in a list of displayed presentations and deactivate it.
253 void deactivateTrihedron() const;
255 /// Opens local context. Does nothing if it is already opened.
256 void openLocalContext();
258 /** Update the object presentable properties such as color, lines width and other
259 * If the object is result with the color attribute value set, it is used,
260 * otherwise the customize is applyed to the object's feature if it is a custom prs
261 * \param theObject an object instance
262 * \return the true state if there is changes and the presentation is customized
264 bool customizeObject(ObjectPtr theObject);
266 /// Append the objects in the internal map. Checks whether the map already contains the object
267 /// \param theObject an object to display
268 /// \param theAIS AIOS object to display
269 void appendResultObject(ObjectPtr theObject, AISObjectPtr theAIS);
271 /// Returns an information about alredy displayed objects
272 /// \return a string representation
273 std::string getResult2AISObjectMapInfo() const;
276 /// Reference to workshop
277 XGUI_Workshop* myWorkshop;
279 /// A container for selection filters
280 Handle(SelectMgr_AndFilter) myAndFilter;
282 /// A default custom presentation, which is used if the displayed feature is not a custom presentation
283 GeomCustomPrsPtr myCustomPrs;
285 /// Definition of a type of map which defines correspondance between objects and presentations
286 typedef QMap<ObjectPtr, AISObjectPtr> ResultToAISMap;
288 /// A map of displayed objects
289 ResultToAISMap myResult2AISObjectMap;
291 /// Selection modes installed for external objects in local context
292 QIntList myActiveSelectionModes;
294 /// the enable update viewer flag
295 bool myEnableUpdateViewer;