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 <TopoDS_Shape.hxx>
14 #include <AIS_InteractiveObject.hxx>
15 #include <AIS_InteractiveContext.hxx>
16 #include <NCollection_List.hxx>
18 #include <XGUI_ViewerPrs.h>
25 class ModelAPI_Feature;
28 /**\class XGUI_Displayer
30 * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer
32 class XGUI_EXPORT XGUI_Displayer
36 /// \param theViewer the viewer
37 XGUI_Displayer(XGUI_Workshop* theWorkshop);
39 virtual ~XGUI_Displayer();
41 /// Set AIS_InteractiveContext object in case if it was changed
42 /// or can not be initialized in constructor
43 void setAISContext(const Handle(AIS_InteractiveContext)& theAIS);
45 /// Returns the feature visibility state.
46 /// \param theFeature a feature instance
47 bool IsVisible(boost::shared_ptr<ModelAPI_Feature> theFeature);
49 /// Display the feature. Obtain the visualized object from the feature.
50 /// \param theFeature a feature instance
51 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
52 void Display(boost::shared_ptr<ModelAPI_Feature> theFeature, const bool isUpdateViewer = true);
54 /// Display the feature and a shape. This shape would be associated to the given feature
55 /// \param theFeature a feature instance
56 /// \param theShape a shape
57 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
58 //void Display(boost::shared_ptr<ModelAPI_Feature> theFeature, const TopoDS_Shape& theShape,
59 // const bool isUpdateViewer = true);
61 /// Returns a list of viewer presentations
62 /// \return list of presentations
63 std::list<XGUI_ViewerPrs> GetViewerPrs();
65 /// Display the shape and activate selection of sub-shapes
66 /// \param theFeature a feature instance
67 /// \param theShape a shape
68 /// \param theMode a local selection mode
69 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
70 void RedisplayInLocalContext(boost::shared_ptr<ModelAPI_Feature> theFeature,
71 const TopoDS_Shape& theShape,
72 const std::list<int>& theMode, const bool isUpdateViewer = true);
74 /// Erase the feature and a shape.
75 /// \param theFeature a feature instance
76 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
77 void Erase(boost::shared_ptr<ModelAPI_Feature> theFeature, const bool isUpdateViewer = true);
79 /// Erase all presentations
80 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
81 void EraseAll(const bool isUpdateViewer = true);
83 /// Erase AIS interactive objects, which has an empty feature in the internal map
84 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
85 void EraseDeletedFeatures(const bool isUpdateViewer = true);
87 /// Deactivates selection of sub-shapes
88 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
89 void CloseLocalContexts(const bool isUpdateViewer = true);
91 /// Updates the viewer
95 /// Deactivate local selection
96 /// \param isUpdateViewer the state wether the viewer should be updated immediatelly
97 void closeAllContexts(const bool isUpdateViewer);
99 /// Returns currently installed AIS_InteractiveContext
100 Handle(AIS_InteractiveContext) AISContext() const;
103 XGUI_Workshop* myWorkshop;
105 typedef std::map<boost::shared_ptr<ModelAPI_Feature>, Handle(AIS_InteractiveObject) > FeatureToAISMap;
106 FeatureToAISMap myFeature2AISObjectMap;