src/HYDROPy/HYDROData_Obstacle.sip

   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 %ExportedHeaderCode
  24 #include <HYDROData_Obstacle.h>
  25 %End
  26
  27 class HYDROData_Obstacle : public HYDROData_ArtificialObject
  28 {
  29 %TypeHeaderCode
  30 #include <HYDROData_Obstacle.h>
  31 %End
  32
  33 public:
  34   /**
  35    * Returns default filling color for new obstacle.
  36    */
  37   static QColor DefaultFillingColor();
  38
  39   /**
  40    * Returns default border color for new obstacle.
  41    */
  42   static QColor DefaultBorderColor();
  43
  44 public:
  45
  46   /**
  47    * Imports shape from file containing geometrical object and sets this
  48    * shape as the obstacle shape.
  49    * The supported file types:
  50    *  - BREP
  51    *  - IGES
  52    *  - STEP
  53    *  - ACIS
  54    * \param theFilePath the path to file
  55    * \return \c true if file has been successfully read
  56    */
  57   bool ImportFromFile( const QString& theFilePath );
  58
  59
  60   /**
  61    * Stores the file path of the imported file.
  62    * \param theFilePath file path
  63    */
  64   void SetFilePath(const QString& theFilePath);
  65
  66   /**
  67    * Returns the imported file path.
  68    */
  69   QString GetFilePath() const;
  70
  71
  72 public:
  73
  74   /**
  75    * Imports shape from IOR.
  76    * \param theIOR the IOR of Geom object
  77    * \return \c true if shape has been successfully imported
  78    */
  79   bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
  80
  81   /**
  82    * Stores the study entry of the imported GEOM object.
  83    * \param theEntry GEOM object entry
  84    */
  85   void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
  86
  87   /**
  88    * Returns the imported GEOM object entry.
  89    */
  90   TCollection_AsciiString GetGeomObjectEntry() const;
  91
  92
  93 public:
  94
  95   /**
  96    * Translate the obstacle to the given distance.
  97    */
  98   void Translate( const double theDx, const double theDy, const double theDz );
  99
 100
 101 protected:
 102
 103   /**
 104    * Creates new object in the internal data structure. Use higher level objects
 105    * to create objects with real content.
 106    */
 107   HYDROData_Obstacle();
 108
 109   /**
 110    * Destructs properties of the object and object itself, removes it from the document.
 111    */
 112   virtual ~HYDROData_Obstacle();
 113 };