1 // File: XGUI_Displayer.h
2 // Created: 20 Apr 2014
3 // Author: Natalia ERMOLAEVA
5 #ifndef XGUI_Displayer_H
6 #define XGUI_Displayer_H
11 #include <boost/shared_ptr.hpp>
13 #include <GeomAPI_AISObject.h>
15 #include <TopoDS_Shape.hxx>
16 #include <AIS_InteractiveObject.hxx>
17 #include <AIS_InteractiveContext.hxx>
18 #include <NCollection_List.hxx>
20 #include <ModelAPI_Result.h>
22 #include <ModuleBase_Definitions.h>
23 #include <ModuleBase_ViewerPrs.h>
30 class ModelAPI_Feature;
33 /**\class XGUI_Displayer
35 * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer
37 class XGUI_EXPORT XGUI_Displayer
40 enum DisplayMode { NoMode = -1, Wireframe, Shading };
43 /// \param theViewer the viewer
44 XGUI_Displayer(XGUI_Workshop* theWorkshop);
46 virtual ~XGUI_Displayer();
48 /// Returns the feature visibility state.
49 /// \param theFeature a feature instance
50 bool isVisible(ObjectPtr theObject) const;
52 /// Display the feature. Obtain the visualized object from the feature.
53 /// \param theFeature a feature instance
54 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
55 /// Returns true if the Feature succesfully displayed
56 void display(ObjectPtr theObject, bool isUpdateViewer = true);
58 /// Display the given AIS object. To hide this object use corresponde erase method
59 void display(boost::shared_ptr<GeomAPI_AISObject> theAIS, bool isUpdate = true);
61 /// Stop the current selection and color the given features to the selection color
62 /// \param theFeatures a list of features to be disabled
63 /// \param theToStop the boolean state whether it it stopped or non stopped
64 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
65 void stopSelection(const QList<ObjectPtr>& theFeatures, const bool isStop,
66 const bool isUpdateViewer);
69 * Add presentations which corresponds to the given features to current selection
70 * \param theFeatures a list of features to be selected
71 * isUpdateViewer the parameter whether the viewer should be update immediatelly
73 void setSelected(const QList<ObjectPtr>& theFeatures, bool isUpdateViewer = true);
76 /// Un select all objects
79 /// Erase the feature and a shape.
80 /// \param theFeature a feature instance
81 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
82 void erase(ObjectPtr theObject, const bool isUpdateViewer = true);
84 /// Erase the given AIS object displayed by corresponded display method
85 void erase(boost::shared_ptr<GeomAPI_AISObject> theAIS, const bool isUpdate = true);
87 /// Erase all presentations
88 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
89 void eraseAll(const bool isUpdateViewer = true);
91 /// Erase AIS interactive objects, which has an empty feature in the internal map
92 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
93 void eraseDeletedResults(const bool isUpdateViewer = true);
95 /// Opens local context. Does nothing if it is already opened.
96 void openLocalContext();
98 /// Deactivates selection of sub-shapes
99 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
100 void closeLocalContexts(const bool isUpdateViewer = true);
103 * Set modes of selections. Selection mode has to be defined by TopAbs_ShapeEnum.
104 * It doesn't manages a local context
105 * \param theModes - list of selection modes. If the list is empty then all selectoin modes will be cleared.
107 void setSelectionModes(const QIntList& theModes);
109 void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
111 void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
113 /// Updates the viewer
116 /// Searches the interactive object by feature
117 /// \param theFeature the feature or NULL if it not visualized
118 /// \return theIO an interactive object
119 boost::shared_ptr<GeomAPI_AISObject> getAISObject(ObjectPtr theFeature) const;
121 /// Searches the feature by interactive object
122 /// \param theIO an interactive object
123 /// \return feature the feature or NULL if it not visualized
124 ObjectPtr getObject(Handle(AIS_InteractiveObject) theIO) const;
126 /// Deactivates the given object (not allow selection)
127 void deactivate(ObjectPtr theFeature);
129 /// Activates the given object (it can be selected)
130 /// \param theModes - modes on which it has to be activated (can be empty)
131 void activate(ObjectPtr theFeature, const QIntList& theModes);
133 /// Returns true if the given object can be selected
134 bool isActive(ObjectPtr theObject) const;
136 /// Activates in local context displayed outside of the context.
137 /// \param theModes - modes on which it has to be activated (can be empty)
138 void activateObjectsOutOfContext(const QIntList& theModes);
140 /// Activates in local context displayed outside of the context.
141 void deactivateObjectsOutOfContext();
143 /// Sets display mode for the given object if this object is displayed
144 void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool toUpdate = true);
146 /// Returns current display mode for the given object.
147 /// If object is not displayed then returns NoMode.
148 DisplayMode displayMode(ObjectPtr theObject) const;
151 int objectsCount() const { return myResult2AISObjectMap.size(); }
154 /// Deactivate local selection
155 /// \param isUpdateViewer the state wether the viewer should be updated immediatelly
156 void closeAllContexts(const bool isUpdateViewer);
158 /// Returns currently installed AIS_InteractiveContext
159 Handle(AIS_InteractiveContext) AISContext() const;
161 /// Display the feature and a shape. This shape would be associated to the given feature
162 /// \param theFeature a feature instance
163 /// \param theAIS AIS presentation
164 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
165 /// Returns true if the Feature succesfully displayed
166 void display(ObjectPtr theObject, boost::shared_ptr<GeomAPI_AISObject> theAIS, bool isShading,
167 bool isUpdateViewer = true);
169 /// Display the shape and activate selection of sub-shapes
170 /// \param theFeature a feature instance
171 /// \param theAIS an AIS object
172 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
173 /// \returns true if the presentation is created
174 //bool redisplay(ObjectPtr theObject,
175 // boost::shared_ptr<GeomAPI_AISObject> theAIS,
176 // const bool isUpdateViewer = true);
178 /** Redisplay the shape if it was displayed
179 * \param theFeature a feature instance
180 * \param isUpdateViewer the parameter whether the viewer should be update immediatelly
182 void redisplay(ObjectPtr theObject, bool isUpdateViewer = true);
185 XGUI_Workshop* myWorkshop;
187 typedef std::map<ObjectPtr, boost::shared_ptr<GeomAPI_AISObject> > ResultToAISMap;
188 ResultToAISMap myResult2AISObjectMap;