src/HYDROData/HYDROData_GeomTool.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 HYDROData_GeomTool_HeaderFile
  20 #define HYDROData_GeomTool_HeaderFile
  21
  22 #include "HYDROData.h"
  23 #include <NCollection_IndexedDataMap.hxx>
  24 #include <TopTools_ShapeMapHasher.hxx>
  25
  26 #ifdef WIN32
  27   #pragma warning ( disable: 4251 )
  28 #endif
  29
  30 #ifndef LIGHT_MODE
  31 #include <GEOM_Client.hxx>
  32
  33 #ifdef WIN32
  34   #pragma warning ( default: 4251 )
  35 #endif
  36
  37 class TopoDS_Shape;
  38 class QString;
  39
  40 class HYDRODATA_EXPORT HYDROData_GeomTool {
  41
  42 public:
  43
  44   /**
  45    * \brief Get shape by the specified IOR.
  46    * \param theIOR the GEOM object IOR
  47    * \return the shape
  48    */
  49   static TopoDS_Shape GetShapeFromIOR( const QString& theIOR );
  50
  51   /**
  52    * \brief Get GEOM engine.
  53    * \return the GEOM engine
  54    */
  55   static GEOM::GEOM_Gen_var GetGeomGen();
  56
  57   /**
  58    * \brief Get Study.
  59    * \return the study
  60    */
  61   static SALOMEDS::Study_var GetStudy();
  62
  63   /**
  64    * \brief Get free name for GEOM object.
  65    * \param theBaseName the base name
  66    * \return the default name
  67    */
  68   static QString GetFreeName( const QString& theBaseName );
  69
  70   /**
  71    * Publish the given shape in GEOM as a GEOM object.
  72    * \param theGeomEngine GEOM module engine
  73    * \param theShape the shape to publish as a GEOM object
  74    * \param theName the name of the published object
  75    * \param theGeomObjEntry the entry of the published object
  76    * \return the published GEOM object
  77    */
  78   static GEOM::GEOM_Object_ptr publishShapeInGEOM( GEOM::GEOM_Gen_var  theGeomEngine,
  79                                                    const TopoDS_Shape& theShape,
  80                                                    const QString&      theName,
  81                                                    QString& theGeomObjEntry );
  82
  83   /**
  84    * Create and publish face in GEOM as a GEOM object.
  85    * \param theGeomEngine GEOM module engine
  86    * \param theWidth the face width
  87    * \param theHeight the face height
  88    * \param theName the name of the published face
  89    * \param theFaceEntry the entry of the published face
  90    * \return the published GEOM object
  91    */
  92   static GEOM::GEOM_Object_ptr createFaceInGEOM( GEOM::GEOM_Gen_var theGeomEngine,
  93                                                  const int theWidth,
  94                                                  const int theHeight,
  95                                                  const QString& theName,
  96                                                  QString& theFaceEntry );
  97
  98   /**
  99    * Publish the given GEOM object in the study.
 100    * \param theGeomEngine GEOM module engine
 101    * \param theGeomObj the GEOM object
 102    * \param theName the object name
 103    * \return the entry of the published object (empty string in case of fail)
 104    */
 105   static QString publishGEOMObject( GEOM::GEOM_Gen_var theGeomEngine,
 106                                     GEOM::GEOM_Object_ptr theGeomObj,
 107                                     const QString& theName );
 108
 109   static GEOM::GEOM_Object_ptr ExplodeShapeInGEOMandPublish( GEOM::GEOM_Gen_var theGeomEngine,
 110                                                       const TopoDS_Shape& theShape,
 111                                                       const NCollection_IndexedDataMap<TopoDS_Shape, QString, TopTools_ShapeMapHasher>& aShToNameModif,
 112                                                       const QString& theName,
 113                                                       QString& theGeomObjEntry);
 114
 115 };
 116
 117 #endif
 118
 119 #endif
 120
 121