src/HYDROGUI/HYDROGUI_OCCDisplayer.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROGUI_OCCDISPLAYER_H
  20 #define HYDROGUI_OCCDISPLAYER_H
  21
  22 #include "HYDROGUI_AbstractDisplayer.h"
  23
  24 class HYDROGUI_Shape;
  25 class AIS_InteractiveContext;
  26 class AIS_ColorScale;
  27 class OCCViewer_ViewManager;
  28 class OCCViewer_Viewer;
  29
  30 /**
  31  * \class HYDROGUI_OCCDisplayer
  32  * \brief Class intended to create, display and update the presentations on OCC viewer.
  33  */
  34 class HYDROGUI_OCCDisplayer : public HYDROGUI_AbstractDisplayer
  35 {
  36 public:
  37   /**
  38    * \brief Constructor.
  39    * \param theModule module object
  40    */
  41   HYDROGUI_OCCDisplayer( HYDROGUI_Module* theModule );
  42
  43   /**
  44    * \brief Destructor.
  45    */
  46   virtual ~HYDROGUI_OCCDisplayer();
  47
  48 public:
  49   /**
  50    * \brief Force the specified objects to be updated.
  51    * \param theObjs sequence of objects to update
  52    * \param theViewerId viewer identifier
  53    */
  54   void                            SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
  55                                                const int theViewerId );
  56
  57   /**
  58    * \brief Get the applicable viewer type.
  59    */
  60   virtual QString  GetType() const;
  61
  62   /**
  63    * \brief Add the z layer for preview and returns its index.
  64    * \param theMgr OCC view manager
  65    */
  66   int                             AddPreviewZLayer( OCCViewer_ViewManager* theMgr );
  67
  68   /**
  69    * \brief Removes the z layer.
  70    * \param theMgr OCC view manager
  71    * \param theLayer a layer index
  72    */
  73   void                            RemoveZLayer( OCCViewer_ViewManager* theMgr,
  74                                                 const int theLayer );
  75
  76   void SetToUpdateColorScale();
  77
  78   /**
  79    * \brief Get color scale for the viewer.
  80    * \param theViewerId viewer identifier
  81    * \return the color scale
  82    */
  83   Handle(AIS_ColorScale)          GetColorScale( const int theViewerId );
  84
  85 protected:
  86   /**
  87    * \brief Erase all viewer objects.
  88    * \param theViewerId viewer identifier
  89    */
  90   void                            EraseAll( const int theViewerId );
  91
  92   /**
  93    * \brief Erase the specified viewer objects.
  94    * \param theObjs sequence of objects to erase
  95    * \param theViewerId viewer identifier
  96    */
  97   void                            Erase( const HYDROData_SequenceOfObjects& theObjs,
  98                                          const int theViewerId );
  99
 100   /**
 101    * \brief Display the specified viewer objects.
 102    * \param theObjs sequence of objects to display
 103    * \param theViewerId viewer identifier
 104    * \param theIsForced flag used to update all objects, including the unchanged ones
 105    * \param theDoFitAll flag used to fit the view to all visible objects; do not fit by default
 106    */
 107   void                            Display( const HYDROData_SequenceOfObjects& theObjs,
 108                                            const int theViewerId,
 109                                            const bool theIsForced,
 110                                            const bool theDoFitAll );
 111
 112 protected:
 113   /**
 114    * \brief Purge all invalid objects in the viewer.
 115    * \param theViewerId viewer identifier
 116    */
 117   void                            purgeObjects( const int theViewerId );
 118
 119   void UpdateColorScale( const OCCViewer_Viewer* );
 120
 121 private:
 122   /**
 123    * \brief Creates new OCC shape.
 124    * \param theViewerId viewer identifier
 125    * \param theContext context of OCC viewer
 126    * \param theObject data model object
 127    * \return pointer to new created shape
 128    */
 129   HYDROGUI_Shape*                 createShape( const int                             theViewerId,
 130                                                const Handle(AIS_InteractiveContext)& theContext,
 131                                                const Handle(HYDROData_Entity)&       theObject );
 132
 133    /**
 134    * \brief Display the specified object.
 135    * \param theObject the object to display
 136    * \param theViewer the viewer for displaying
 137    * \param theIsForced the flag used to update the object shape
 138    * \return true in case of success
 139    */
 140   bool                            Display( const Handle(HYDROData_Entity)& theObject,
 141                                            const OCCViewer_Viewer* theViewer,
 142                                            const bool theIsForced );
 143
 144    /**
 145    * \brief Set Z layer to the shape corresponding to the HYDRO data object.
 146    * \param theViewer the viewer for Z layer setting
 147    * \param theObject the HYDRO object
 148    * \param theZLayerId the Z layer ID
 149    */
 150   void                            SetZLayer( const OCCViewer_Viewer* theViewer,
 151                                              const Handle(HYDROData_Entity)& theObject,
 152                                              const int theZLayerId );
 153
 154 private:
 155   bool myToUpdateColorScale;
 156
 157   QMap<int, Handle(AIS_ColorScale)> myColorScales;
 158 };
 159
 160 #endif
 161