src/HYDROGUI/HYDROGUI_Displayer.h

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROGUI_DISPLAYER_H
  24 #define HYDROGUI_DISPLAYER_H
  25
  26 #include "HYDROGUI_AbstractDisplayer.h"
  27
  28 #include <QMap>
  29
  30 class HYDROGUI_PrsDriver;
  31
  32 /**
  33  * \class HYDROGUI_Displayer
  34  * \brief Class intended to create, display and update the presentations in 2D graphics viewer.
  35  */
  36 class HYDROGUI_Displayer : public HYDROGUI_AbstractDisplayer
  37 {
  38 public:
  39   /**
  40    * \brief Constructor.
  41    * \param theModule module object
  42    */
  43   HYDROGUI_Displayer( HYDROGUI_Module* theModule );
  44
  45   /**
  46    * \brief Destructor.
  47    */
  48   virtual ~HYDROGUI_Displayer();
  49
  50 public:
  51   /**
  52    * \brief Force the specified objects to be updated.
  53    * \param theObjs sequence of objects to update
  54    * \param theViewerId viewer identifier
  55    */
  56   void             SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
  57                                 const int theViewerId );
  58
  59   /**
  60    * \brief Get the applicable viewer type.
  61    */
  62   virtual QString  GetType() const;
  63
  64 protected:
  65   /**
  66    * \brief Erase all viewer objects.
  67    * \param theViewerId viewer identifier
  68    */
  69   void             EraseAll( const int theViewerId );
  70
  71   /**
  72    * \brief Erase the specified viewer objects.
  73    * \param theObjs sequence of objects to erase
  74    * \param theViewerId viewer identifier
  75    */
  76   void             Erase( const HYDROData_SequenceOfObjects& theObjs,
  77                           const int theViewerId );
  78
  79   /**
  80    * \brief Display the specified viewer objects.
  81    * \param theObjs sequence of objects to display
  82    * \param theViewerId viewer identifier
  83    * \param theIsForced flag used to update all objects, including the unchanged ones
  84    * \param theDoFitAll flag used to fit the view to all visible objects; do not fit by default
  85    */
  86   void             Display( const HYDROData_SequenceOfObjects& theObjs,
  87                             const int theViewerId,
  88                             const bool theIsForced,
  89                             const bool theDoFitAll );
  90
  91 protected:
  92   /**
  93    * \brief Purge all invalid objects in the viewer.
  94    * \param theViewerId viewer identifier
  95    */
  96   void             purgeObjects( const int theViewerId );
  97
  98 private:
  99   /**
 100    * \brief Get the presentation driver for the specified data object.
 101    * \param theObj data object
 102    */
 103   HYDROGUI_PrsDriver*             getDriver( const Handle(HYDROData_Entity)& theObj );
 104
 105 private:
 106   typedef QMap< ObjectKind, HYDROGUI_PrsDriver* > PrsDriversMap;
 107   PrsDriversMap                   myPrsDriversMap;
 108 };
 109
 110 #endif