src/HYDROGUI/HYDROGUI_Tool.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_TOOL_H
  24 #define HYDROGUI_TOOL_H
  25
  26 #include <HYDROData_Object.h>
  27
  28 #include <GraphicsView_Defs.h>
  29
  30 class SUIT_ViewManager;
  31
  32 class HYDROGUI_DataModel;
  33 class HYDROGUI_Module;
  34 class HYDROGUI_Prs;
  35
  36 /**
  37  * \class HYDROGUI_Tool
  38  * \brief This class contains several useful methods.
  39  */
  40 class HYDROGUI_Tool
  41 {
  42 public:
  43   /**
  44    * \brief Set the specified view manager to be active on the desktop.
  45    * \param theModule module
  46    * \param theViewManager view manager
  47    */
  48   static void                     SetActiveViewManager( HYDROGUI_Module* theModule,
  49                                                         SUIT_ViewManager* theViewManager );
  50
  51   /**
  52    * \brief Get sub-objects to build presentations.
  53    * \param theGUIModel data model
  54    * \param theViewerId viewer id
  55    * \param theSeq sequence of sub-objects
  56    */
  57   static void                     GetPrsSubObjects( const HYDROGUI_DataModel* theGUIModel,
  58                                                     const int theViewerId,
  59                                                     HYDROData_SequenceOfObjects& theSeq );
  60
  61   /**
  62    * \brief Get presentation built for specified data object.
  63    * \param theObj data object
  64    * \param theObjects list of existing presentations
  65    * \return presentation
  66    */
  67   static HYDROGUI_Prs*            GetPresentation( const Handle(HYDROData_Object)& theObj,
  68                                                    const GraphicsView_ObjectList& theObjects );
  69 };
  70
  71 #endif