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 selected presentations
62 /// \param theShapeTypeToSkip the shapes with this type will be skipped during the result list build
63 /// \return list of presentations
64 std::list<XGUI_ViewerPrs> GetSelected(const int theShapeTypeToSkip = -1);
66 /// Returns a list of viewer highlited presentations
67 /// \param theShapeTypeToSkip the shapes with this type will be skipped during the result list build
68 /// \return list of presentations
69 std::list<XGUI_ViewerPrs> GetHighlighted(const int theShapeTypeToSkip = -1);
71 /// Display the shape and activate selection of sub-shapes
72 /// \param theFeature a feature instance
73 /// \param theShape a shape
74 /// \param theMode a local selection mode
75 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
76 /// \returns true if the presentation is created
77 bool Redisplay(boost::shared_ptr<ModelAPI_Feature> theFeature,
78 const TopoDS_Shape& theShape, const bool isUpdateViewer = true);
80 /// Display the shape and activate selection of sub-shapes
81 /// \param theFeature a feature instance
82 /// \param theShape a shape
83 /// \param theMode a list of local selection modes
84 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
85 void ActivateInLocalContext(boost::shared_ptr<ModelAPI_Feature> theFeature,
86 const std::list<int>& theModes, const bool isUpdateViewer = true);
88 /// Stop the current selection and color the given features to the selection color
89 /// \param theFeatures a list of features to be disabled
90 /// \param theToStop the boolean state whether it it stopped or non stopped
91 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
92 void StopSelection(const std::list<XGUI_ViewerPrs>& theFeatures, const bool isStop,
93 const bool isUpdateViewer);
95 /// Set the features are selected
96 /// \param theFeatures a list of features to be selected
97 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
98 void SetSelected(const std::list<XGUI_ViewerPrs>& theFeatures, const bool isUpdateViewer);
100 /// Erase the feature and a shape.
101 /// \param theFeature a feature instance
102 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
103 void Erase(boost::shared_ptr<ModelAPI_Feature> theFeature, const bool isUpdateViewer = true);
105 /// Erase all presentations
106 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
107 void EraseAll(const bool isUpdateViewer = true);
109 /// Erase AIS interactive objects, which has an empty feature in the internal map
110 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
111 void EraseDeletedFeatures(const bool isUpdateViewer = true);
113 /// Deactivates selection of sub-shapes
114 /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
115 void CloseLocalContexts(const bool isUpdateViewer = true);
117 /// Updates the viewer
120 /// Searches the interactive object by feature
121 /// \param theFeature the feature or NULL if it not visualized
122 /// \return theIO an interactive object
123 Handle(AIS_InteractiveObject) GetAISObject(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
126 /// Searches the feature by interactive object
127 /// \param theIO an interactive object
128 /// \return feature the feature or NULL if it not visualized
129 boost::shared_ptr<ModelAPI_Feature> GetFeature(Handle(AIS_InteractiveObject) theIO) const;
130 /// Deactivate local selection
131 /// \param isUpdateViewer the state wether the viewer should be updated immediatelly
132 void CloseAllContexts(const bool isUpdateViewer);
134 /// Returns currently installed AIS_InteractiveContext
135 Handle(AIS_InteractiveContext) AISContext() const;
138 XGUI_Workshop* myWorkshop;
140 typedef std::map<boost::shared_ptr<ModelAPI_Feature>, Handle(AIS_InteractiveObject) > FeatureToAISMap;
141 FeatureToAISMap myFeature2AISObjectMap;