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   void UpdateColorScale( const OCCViewer_Viewer* );
  86
  87 protected:
  88   /**
  89    * \brief Erase all viewer objects.
  90    * \param theViewerId viewer identifier
  91    */
  92   void                            EraseAll( const int theViewerId );
  93
  94   /**
  95    * \brief Erase the specified viewer objects.
  96    * \param theObjs sequence of objects to erase
  97    * \param theViewerId viewer identifier
  98    */
  99   void                            Erase( const HYDROData_SequenceOfObjects& theObjs,
 100                                          const int theViewerId );
 101
 102   /**
 103    * \brief Display the specified viewer objects.
 104    * \param theObjs sequence of objects to display
 105    * \param theViewerId viewer identifier
 106    * \param theIsForced flag used to update all objects, including the unchanged ones
 107    * \param theDoFitAll flag used to fit the view to all visible objects; do not fit by default
 108    */
 109   void                            Display( const HYDROData_SequenceOfObjects& theObjs,
 110                                            const int theViewerId,
 111                                            const bool theIsForced,
 112                                            const bool theDoFitAll );
 113   /**
 114    * \brief Purge all invalid objects in the viewer.
 115    * \param theViewerId viewer identifier
 116    */
 117   void                            purgeObjects( const int theViewerId );
 118
 119 private:
 120   /**
 121    * \brief Creates new OCC shape.
 122    * \param theViewerId viewer identifier
 123    * \param theContext context of OCC viewer
 124    * \param theObject data model object
 125    * \return pointer to new created shape
 126    */
 127   HYDROGUI_Shape*                 createShape( const int                             theViewerId,
 128                                                const Handle(AIS_InteractiveContext)& theContext,
 129                                                const Handle(HYDROData_Entity)&       theObject );
 130
 131    /**
 132    * \brief Display the specified object.
 133    * \param theObject the object to display
 134    * \param theViewer the viewer for displaying
 135    * \param theIsForced the flag used to update the object shape
 136    * \return true in case of success
 137    */
 138   bool                            Display( const Handle(HYDROData_Entity)& theObject,
 139                                            const OCCViewer_Viewer* theViewer,
 140                                            const bool theIsForced );
 141
 142    /**
 143    * \brief Set Z layer to the shape corresponding to the HYDRO data object.
 144    * \param theViewer the viewer for Z layer setting
 145    * \param theObject the HYDRO object
 146    * \param theZLayerId the Z layer ID
 147    */
 148   void                            SetZLayer( const OCCViewer_Viewer* theViewer,
 149                                              const Handle(HYDROData_Entity)& theObject,
 150                                              const int theZLayerId );
 151
 152 private:
 153   bool myToUpdateColorScale;
 154
 155   QMap<int, Handle(AIS_ColorScale)> myColorScales;
 156 };
 157
 158 #endif
 159