src/XGUI/XGUI_Displayer.h

   1 // File:        XGUI_Displayer.h
   2 // Created:     20 Apr 2014
   3 // Author:      Natalia ERMOLAEVA
   4
   5 #ifndef XGUI_Displayer_H
   6 #define XGUI_Displayer_H
   7
   8 #include "XGUI.h"
   9
  10 #include <QString>
  11 #include <boost/shared_ptr.hpp>
  12
  13 #include <GeomAPI_AISObject.h>
  14
  15 #include <TopoDS_Shape.hxx>
  16 #include <AIS_InteractiveObject.hxx>
  17 #include <AIS_InteractiveContext.hxx>
  18 #include <NCollection_List.hxx>
  19
  20 #include <ModelAPI_Result.h>
  21
  22 #include <ModuleBase_Definitions.h>
  23 #include <ModuleBase_ViewerPrs.h>
  24
  25 #include <map>
  26 #include <vector>
  27 #include <list>
  28
  29 class XGUI_Viewer;
  30 class ModelAPI_Feature;
  31 class XGUI_Workshop;
  32
  33 /**\class XGUI_Displayer
  34  * \ingroup GUI
  35  * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer
  36  */
  37 class XGUI_EXPORT XGUI_Displayer
  38 {
  39  public:
  40    enum DisplayMode { NoMode = -1, Wireframe, Shading };
  41
  42   /// Constructor
  43   /// \param theViewer the viewer
  44   XGUI_Displayer(XGUI_Workshop* theWorkshop);
  45   /// Destructor
  46   virtual ~XGUI_Displayer();
  47
  48   /// Returns the feature visibility state.
  49   /// \param theFeature a feature instance
  50   bool isVisible(ObjectPtr theObject) const;
  51
  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);
  57
  58   /// Display the given AIS object. To hide this object use corresponde erase method
  59   void display(AISObjectPtr theAIS, bool isUpdate = true);
  60
  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);
  67
  68   /**
  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
  72    */
  73   void setSelected(const QList<ObjectPtr>& theFeatures, bool isUpdateViewer = true);
  74
  75
  76   /// Un select all objects
  77   void clearSelected();
  78
  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);
  83
  84   /// Erase the given AIS object displayed by corresponded display method
  85   void erase(AISObjectPtr theAIS, const bool isUpdate = true);
  86
  87   /// Erase all presentations
  88   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  89   void eraseAll(const bool isUpdateViewer = true);
  90
  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);
  94
  95   /// Opens local context. Does nothing if it is already opened.
  96   void openLocalContext();
  97
  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);
 101
 102   /*
 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.
 106   */
 107   void setSelectionModes(const QIntList& theModes);
 108
 109   void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
 110
 111   void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
 112
 113   /// Updates the viewer
 114   void updateViewer();
 115
 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   AISObjectPtr getAISObject(ObjectPtr theFeature) const;
 120
 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(const AISObjectPtr& theIO) const;
 125   ObjectPtr getObject(const Handle(AIS_InteractiveObject)& theIO) const;
 126
 127   /// Deactivates the given object (not allow selection)
 128   void deactivate(ObjectPtr theFeature);
 129
 130   /// Activates the given object (it can be selected)
 131   /// \param theModes - modes on which it has to be activated (can be empty)
 132   void activate(ObjectPtr theFeature, const QIntList& theModes);
 133
 134   /// Returns true if the given object can be selected
 135   bool isActive(ObjectPtr theObject) const;
 136
 137   /// Activates in local context displayed outside of the context.
 138   /// \param theModes - modes on which it has to be activated (can be empty)
 139   void activateObjectsOutOfContext(const QIntList& theModes);
 140
 141   /// Activates in local context displayed outside of the context.
 142   void deactivateObjectsOutOfContext();
 143
 144   /// Sets display mode for the given object if this object is displayed
 145   void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool toUpdate = true);
 146
 147   /// Returns current display mode for the given object.
 148   /// If object is not displayed then returns NoMode.
 149   DisplayMode displayMode(ObjectPtr theObject) const;
 150
 151
 152   int objectsCount() const { return myResult2AISObjectMap.size(); }
 153
 154  protected:
 155   /// Deactivate local selection
 156   /// \param isUpdateViewer the state wether the viewer should be updated immediatelly
 157   void closeAllContexts(const bool isUpdateViewer);
 158
 159   /// Returns currently installed AIS_InteractiveContext
 160   Handle(AIS_InteractiveContext) AISContext() const;
 161
 162   /// Display the feature and a shape. This shape would be associated to the given feature
 163   /// \param theFeature a feature instance
 164   /// \param theAIS AIS presentation
 165   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 166   /// Returns true if the Feature succesfully displayed
 167   void display(ObjectPtr theObject, AISObjectPtr theAIS, bool isShading,
 168                bool isUpdateViewer = true);
 169
 170   /// Display the shape and activate selection of sub-shapes
 171   /// \param theFeature a feature instance
 172   /// \param theAIS an AIS object
 173   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 174   /// \returns true if the presentation is created
 175   //bool redisplay(ObjectPtr theObject,
 176   //               AISObjectPtr theAIS,
 177   //               const bool isUpdateViewer = true);
 178
 179   /** Redisplay the shape if it was displayed
 180    * \param theFeature a feature instance
 181    * \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 182    */
 183   void redisplay(ObjectPtr theObject, bool isUpdateViewer = true);
 184
 185  protected:
 186   XGUI_Workshop* myWorkshop;
 187
 188   typedef std::map<ObjectPtr, AISObjectPtr> ResultToAISMap;
 189   ResultToAISMap myResult2AISObjectMap;
 190 };
 191
 192 #endif