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 #include <QPoint>
  30 #include <vtkNew.h>
  31
  32 class HYDROGUI_PrsDriver;
  33 class SUIT_ViewWindow;
  34 class vtkWorldPointPicker;
  35
  36 /**
  37  * \class HYDROGUI_Displayer
  38  * \brief Class intended to create, display and update the presentations in 2D graphics viewer.
  39  */
  40 class HYDROGUI_Displayer : public HYDROGUI_AbstractDisplayer
  41 {
  42 public:
  43   /**
  44    * \brief Constructor.
  45    * \param theModule module object
  46    */
  47   HYDROGUI_Displayer( HYDROGUI_Module* theModule );
  48
  49   /**
  50    * \brief Destructor.
  51    */
  52   virtual ~HYDROGUI_Displayer();
  53
  54 public:
  55   /**
  56    * \brief Force the specified objects to be updated.
  57    * \param theObjs sequence of objects to update
  58    * \param theViewerId viewer identifier
  59    */
  60   void             SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
  61                                 const int theViewerId );
  62
  63   /**
  64    * \brief Get the applicable viewer type.
  65    */
  66   virtual QString  GetType() const;
  67
  68   /**
  69    * \brief Get the coodinates from the view window, projected on XOY plane
  70    * \param theViewWindow a view window
  71    * \param theCursorPos a cursor position point
  72    * \param theXCoordinate a X coordinate
  73    * \param theXCoordinate an Y coordinate
  74    * \param theXCoordinate a Z coordinate, has a zero value because of the plane
  75    * \return true if the coordinates are got
  76    */
  77   bool             GetCursorViewCoordinates( SUIT_ViewWindow* theViewWindow,
  78                                              const QPoint& theCursorPos,
  79                                              double& theXCoordinate,
  80                                              double& theYCoordinate,
  81                                              double& theZCoordinate );
  82 protected:
  83   /**
  84    * \brief Erase all viewer objects.
  85    * \param theViewerId viewer identifier
  86    */
  87   void             EraseAll( const int theViewerId );
  88
  89   /**
  90    * \brief Erase the specified viewer objects.
  91    * \param theObjs sequence of objects to erase
  92    * \param theViewerId viewer identifier
  93    */
  94   void             Erase( const HYDROData_SequenceOfObjects& theObjs,
  95                           const int theViewerId );
  96
  97   /**
  98    * \brief Display the specified viewer objects.
  99    * \param theObjs sequence of objects to display
 100    * \param theViewerId viewer identifier
 101    * \param theIsForced flag used to update all objects, including the unchanged ones
 102    * \param theDoFitAll flag used to fit the view to all visible objects; do not fit by default
 103    */
 104   void             Display( const HYDROData_SequenceOfObjects& theObjs,
 105                             const int theViewerId,
 106                             const bool theIsForced,
 107                             const bool theDoFitAll );
 108
 109 protected:
 110   /**
 111    * \brief Purge all invalid objects in the viewer.
 112    * \param theViewerId viewer identifier
 113    */
 114   void             purgeObjects( const int theViewerId );
 115
 116 private:
 117   /**
 118    * \brief Get the presentation driver for the specified data object.
 119    * \param theObj data object
 120    */
 121   HYDROGUI_PrsDriver*             getDriver( const Handle(HYDROData_Entity)& theObj );
 122
 123 private:
 124   typedef QMap< ObjectKind, HYDROGUI_PrsDriver* > PrsDriversMap;
 125   PrsDriversMap                   myPrsDriversMap;
 126   vtkNew<vtkWorldPointPicker>     myPicker;
 127 };
 128
 129 #endif