src/XGUI/XGUI_Displayer.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        XGUI_Displayer.h
   4 // Created:     20 Apr 2014
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef XGUI_Displayer_H
   8 #define XGUI_Displayer_H
   9
  10 #include "XGUI.h"
  11
  12 #include <GeomAPI_AISObject.h>
  13 #include <TopoDS_Shape.hxx>
  14 #include <AIS_InteractiveObject.hxx>
  15 #include <AIS_InteractiveContext.hxx>
  16 #include <NCollection_List.hxx>
  17
  18 #include <ModelAPI_Result.h>
  19
  20 #include <ModuleBase_Definitions.h>
  21 #include <ModuleBase_ViewerPrs.h>
  22
  23 #include <GeomAPI_ICustomPrs.h>
  24
  25 #include <SelectMgr_AndFilter.hxx>
  26
  27 #include <QString>
  28 #include <QMap>
  29 #include <QObject>
  30 #include <QColor>
  31
  32 class ModelAPI_Feature;
  33 class XGUI_Workshop;
  34
  35 /**\class XGUI_Displayer
  36  * \ingroup GUI
  37  * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer
  38  */
  39 class XGUI_EXPORT XGUI_Displayer: public QObject
  40 {
  41   Q_OBJECT
  42  public:
  43    /// \enum DisplayMode display mode
  44    enum DisplayMode {
  45      /// Mode is not defined
  46      NoMode = -1,
  47      /// Wireframe display mode
  48      Wireframe,
  49      /// Shading display mode
  50      Shading
  51    };
  52
  53   /// Constructor
  54   /// \param theWorkshop a workshop instance
  55   XGUI_Displayer(XGUI_Workshop* theWorkshop);
  56
  57   /// Destructor
  58   virtual ~XGUI_Displayer();
  59
  60   /// Returns the feature visibility state.
  61   /// \param theObject an object instance
  62   bool isVisible(ObjectPtr theObject) const;
  63
  64   /// Display the feature. Obtain the visualized object from the feature.
  65   /// \param theObject an object to display
  66   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  67   /// Returns true if the Feature succesfully displayed
  68   void display(ObjectPtr theObject, bool isUpdateViewer = true);
  69
  70   /// Display the given AIS object. To hide this object use corresponde erase method
  71   /// \param theAIS AIOS object to display
  72   /// \param isUpdate the parameter whether the viewer should be update immediatelly
  73   void displayAIS(AISObjectPtr theAIS, bool isUpdate = true);
  74
  75   /** Redisplay the shape if it was displayed
  76    * \param theObject an object instance
  77    * \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  78    */
  79   void redisplay(ObjectPtr theObject, bool isUpdateViewer = true);
  80
  81   /**
  82    * Add presentations to current selection. It unhighlight and deselect the current selection.
  83    * The shape and result components are processed in the values. If the presentation shape is not
  84    * empty, select it, otherwise select the result.
  85    * \param theValues a list of presentation to be selected
  86    * \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  87    */
  88   void setSelected(const  QList<ModuleBase_ViewerPrs>& theValues, bool isUpdateViewer = true);
  89
  90
  91   /// Unselect all objects
  92   void clearSelected();
  93
  94   /// Erase the feature and a shape.
  95   /// \param theObject an object instance
  96   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
  97   void erase(ObjectPtr theObject, const bool isUpdateViewer = true);
  98
  99   /// Erase the given AIS object displayed by corresponded display method
 100   /// \param theAIS instance of AIS object
 101   /// \param isUpdate the parameter whether the viewer should be update immediatelly
 102   void eraseAIS(AISObjectPtr theAIS, const bool isUpdate = true);
 103
 104   /// Erase all presentations
 105   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 106   void eraseAll(const bool isUpdateViewer = true);
 107
 108   /// Deactivates selection of sub-shapes
 109   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 110   void closeLocalContexts(const bool isUpdateViewer = true);
 111
 112   /// \brief Add selection filter
 113   /// \param theFilter a filter instance
 114   void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
 115
 116   /// \brief Remove selection filter
 117   /// \param theFilter a filter instance
 118   void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter);
 119
 120   /// Remove all selection filters
 121   void removeFilters();
 122
 123   /**
 124    * Sets a flag to the displayer whether the internal viewer can be updated by
 125    * the updateViewer method call. If it is not enabled, this method do nothing
 126    * \param isEnabled a boolean value
 127    */
 128   bool enableUpdateViewer(const bool isEnabled);
 129
 130   /// Updates the viewer
 131   void updateViewer() const;
 132
 133   /// Searches the interactive object by feature
 134   /// \param theObject the object or presentable feature
 135   /// \return theIO an interactive object
 136   AISObjectPtr getAISObject(ObjectPtr theObject) const;
 137
 138   /// Searches the feature by interactive object
 139   /// \param theIO an interactive object
 140   /// \return feature the feature or NULL if it not visualized
 141   ObjectPtr getObject(const AISObjectPtr& theIO) const;
 142
 143   /// Searches the feature by interactive object
 144   /// \param theIO an interactive object
 145   /// \return corresponded object or NULL if it not found
 146   ObjectPtr getObject(const Handle(AIS_InteractiveObject)& theIO) const;
 147
 148   /// Deactivates the given object (not allow selection)
 149   /// \param theObject object to deactivate
 150   void deactivate(ObjectPtr theObject);
 151
 152   /// Activates the given object (it can be selected)
 153   /// \param theObject object to activate
 154   /// \param theModes - modes on which it has to be activated (can be empty)
 155   //void activate(ObjectPtr theObject, const QIntList& theModes);
 156
 157   /// Returns the modes of activation
 158   /// \param theObject the feature or NULL if it not visualized
 159   /// \param theModes - modes on which it is activated (can be empty)
 160   void getModesOfActivation(ObjectPtr theObject, QIntList& theModes);
 161
 162   /// Activates the given object with default modes
 163   /// \param theObject object to activate
 164   //void activate(ObjectPtr theObject);
 165
 166   /// Returns true if the given object can be selected
 167   /// \param theObject object to check
 168   bool isActive(ObjectPtr theObject) const;
 169
 170   /// Activates in local context displayed outside of the context.
 171   /// \param theModes - modes on which it has to be activated (can be empty)
 172   /// \param theObjList - list of objects which has to be activated. Can be empty. In this case all displayed objects will be used.
 173   void activateObjects(const QIntList& theModes, const QObjectPtrList& theObjList = QObjectPtrList());
 174
 175   /// Activates in local context displayed outside of the context.
 176   void deactivateObjects();
 177
 178   /// Sets display mode for the given object if this object is displayed
 179   void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool toUpdate = true);
 180
 181   /// Returns current display mode for the given object.
 182   /// If object is not dis played then returns NoMode.
 183   /// \param theObject object to check
 184   DisplayMode displayMode(ObjectPtr theObject) const;
 185
 186   /// Displays only objects listed in the list
 187   /// \param theList list of objects
 188   void showOnly(const QObjectPtrList& theList);
 189
 190   /// Returns number of displayed objects
 191   int objectsCount() const { return myResult2AISObjectMap.size(); }
 192
 193   /// Returns list of displayed objects
 194   QObjectPtrList displayedObjects() const { return myResult2AISObjectMap.keys(); }
 195
 196   /// Returns list of displayed objects
 197   QList<AISObjectPtr> displayedPresentations() const { return myResult2AISObjectMap.values(); }
 198
 199   /// Returns true if the given object can be shown in shaded mode
 200   /// \param theObject object to check
 201   bool canBeShaded(ObjectPtr theObject) const;
 202
 203   /// Set color on presentation of an object if it is displayed
 204   /// \param theObject an object
 205   /// \param theColor a color which has to be set
 206   /// \param toUpdate update viewer flag
 207   /// \return previously defined color on the object
 208   QColor setObjectColor(ObjectPtr theObject, const QColor& theColor, bool toUpdate = true);
 209
 210 signals:
 211   /// Signal on object display
 212   /// \param theObject a data object
 213   /// \param theAIS a presentation object
 214   void objectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
 215
 216   /// Signal on before object erase
 217   /// \param theObject a data object
 218   /// \param theAIS a presentation object
 219   void beforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
 220
 221  protected:
 222   /// Returns currently installed AIS_InteractiveContext
 223   Handle(AIS_InteractiveContext) AISContext() const;
 224
 225   /// Returns the viewer context top filter. If there is no a filter, it is created and set into
 226   /// The context should have only this filter inside. Other filters should be add to the filter
 227   Handle(SelectMgr_AndFilter) GetFilter();
 228
 229   /// Display the feature and a shape. This shape would be associated to the given feature
 230   /// \param theObject an object instance
 231   /// \param theAIS AIS presentation
 232   /// \param isShading flag to show in shading mode
 233   /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
 234   /// \return true if the object is succesfully displayed
 235   void display(ObjectPtr theObject, AISObjectPtr theAIS, bool isShading,
 236                bool isUpdateViewer = true);
 237
 238 private:
 239   /// Activates the interactive object in the local context.
 240   /// \param theIO an interactive object
 241   /// \param theModes - modes on which it has to be activated (can be empty)
 242   void activate(const Handle(AIS_InteractiveObject)& theIO, const QIntList& theModes) const;
 243
 244   /// Opens local context. Does nothing if it is already opened.
 245   void openLocalContext();
 246
 247   /** Update the object presentable properties such as color, lines width and other
 248    * If the object is result with the color attribute value set, it is used,
 249    * otherwise the customize is applyed to the object's feature if it is a custom prs
 250    * \param theObject an object instance
 251    * \return the true state if there is changes and the presentation is customized
 252    */
 253   bool customizeObject(ObjectPtr theObject);
 254
 255   /// Append the objects in the internal map. Checks whether the map already contains the object
 256   /// \param theObject an object to display
 257   /// \param theAIS AIOS object to display
 258   void appendResultObject(ObjectPtr theObject, AISObjectPtr theAIS);
 259
 260   /// Returns an information about alredy displayed objects
 261   /// \return a string representation
 262   std::string getResult2AISObjectMapInfo() const;
 263
 264  protected:
 265    /// Reference to workshop
 266   XGUI_Workshop* myWorkshop;
 267
 268   /// A container for selection filters
 269   Handle(SelectMgr_AndFilter) myAndFilter;
 270
 271   /// A default custom presentation, which is used if the displayed feature is not a custom presentation
 272   GeomCustomPrsPtr myCustomPrs;
 273
 274   /// Definition of a type of map which defines correspondance between objects and presentations
 275   typedef QMap<ObjectPtr, AISObjectPtr> ResultToAISMap;
 276
 277   /// A map of displayed objects
 278   ResultToAISMap myResult2AISObjectMap;
 279
 280   /// Selection modes installed for external objects in local context
 281   QIntList myActiveSelectionModes;
 282
 283   /// the enable update viewer flag
 284   bool myEnableUpdateViewer;
 285 };
 286
 287 #endif