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 <TopoDS_Shape.hxx>
  14 #include <AIS_InteractiveObject.hxx>
  15 #include <AIS_InteractiveContext.hxx>
  16 #include <NCollection_List.hxx>
  17
  18 #include <XGUI_ViewerPrs.h>
  19
  20 #include <map>
  21 #include <vector>
  22 #include <list>
  23
  24 class XGUI_Viewer;
  25 class ModelAPI_Feature;
  26 class XGUI_Workshop;
  27
  28 /**\class XGUI_Displayer
  29  * \ingroup GUI
  30  * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer
  31  */
  32 class XGUI_EXPORT XGUI_Displayer
  33 {
  34 public:
  35   /// Constructor
  36   /// \param theViewer the viewer
  37   XGUI_Displayer(XGUI_Workshop* theWorkshop);
  38   /// Destructor
  39   virtual ~XGUI_Displayer();
  40
  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);
  44
  45   /// Returns the feature visibility state.
  46   /// \param theFeature a feature instance
  47   bool IsVisible(boost::shared_ptr<ModelAPI_Feature> theFeature);
  48
  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);
  53
  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);
  60
  61   /// Returns a list of viewer selected presentations
  62   /// \return list of presentations
  63   std::list<XGUI_ViewerPrs> GetSelected();
  64
  65   /// Returns a list of viewer highlited presentations
  66   /// \return list of presentations
  67   std::list<XGUI_ViewerPrs> GetHighlighted();
  68
  69   /// Display the shape and activate selection of sub-shapes
  70   /// \param theFeature a feature instance
  71   /// \param theShape a shape
  72   /// \param theMode a local selection mode
  73   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  74   void Redisplay(boost::shared_ptr<ModelAPI_Feature> theFeature,
  75                              const TopoDS_Shape& theShape, const bool isUpdateViewer = true);
  76
  77   /// Display the shape and activate selection of sub-shapes
  78   /// \param theFeature a feature instance
  79   /// \param theShape a shape
  80   /// \param theMode a list of local selection modes
  81   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  82   void ActivateInLocalContext(boost::shared_ptr<ModelAPI_Feature> theFeature,
  83                               const std::list<int>& theModes, const bool isUpdateViewer = true);
  84
  85   /// Stop the current selection and color the given features to the selection color
  86   /// \param theFeatures a list of features to be disabled
  87   /// \param theToStop the boolean state whether it it stopped or non stopped
  88   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  89   void StopSelection(const std::list<XGUI_ViewerPrs>& theFeatures, const bool isStop,
  90                      const bool isUpdateViewer);
  91
  92   /// Set the features are selected
  93   /// \param theFeatures a list of features to be selected
  94   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  95   void SetSelected(const std::list<XGUI_ViewerPrs>& theFeatures, const bool isUpdateViewer);
  96
  97   /// Erase the feature and a shape.
  98   /// \param theFeature a feature instance
  99   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 100   void Erase(boost::shared_ptr<ModelAPI_Feature> theFeature, const bool isUpdateViewer = true);
 101
 102   /// Erase all presentations
 103   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 104   void EraseAll(const bool isUpdateViewer = true);
 105
 106   /// Erase AIS interactive objects, which has an empty feature in the internal map
 107   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 108   void EraseDeletedFeatures(const bool isUpdateViewer = true);
 109
 110   /// Deactivates selection of sub-shapes
 111   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 112   void CloseLocalContexts(const bool isUpdateViewer = true);
 113
 114   /// Updates the viewer
 115   void UpdateViewer();
 116
 117 protected:
 118   /// Searches the feature by interactive object
 119   /// \param theIO an interactive object
 120   /// \return feature the feature or NULL if it not visualized
 121   boost::shared_ptr<ModelAPI_Feature> GetFeature(Handle(AIS_InteractiveObject) theIO);
 122   /// Deactivate local selection
 123   /// \param isUpdateViewer the state wether the viewer should be updated immediatelly
 124   void CloseAllContexts(const bool isUpdateViewer);
 125
 126   /// Returns currently installed AIS_InteractiveContext
 127   Handle(AIS_InteractiveContext) AISContext() const;
 128
 129 protected:
 130   XGUI_Workshop* myWorkshop;
 131
 132   typedef std::map<boost::shared_ptr<ModelAPI_Feature>, Handle(AIS_InteractiveObject) > FeatureToAISMap;
 133   FeatureToAISMap myFeature2AISObjectMap;
 134 };
 135
 136
 137 #endif