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 the top shape of the object.
  36    */
  37 //  virtual TopoDS_Shape GetTopShape() const;
  38
  39   /**
  40    * Returns the 3d shape of the object.
  41    */
  42 //  virtual TopoDS_Shape GetShape3D() const;
  43
  44   /**
  45    * Returns default filling color for new obstacle.
  46    */
  47   static QColor DefaultFillingColor();
  48
  49   /**
  50    * Returns default border color for new obstacle.
  51    */
  52   static QColor DefaultBorderColor();
  53
  54
  55   /**
  56    * Sets the 3d shape of the object.
  57    */
  58 //  virtual void SetShape3D( const TopoDS_Shape& theShape );
  59
  60 public:
  61
  62   /**
  63    * Imports shape from file containing geometrical object and sets this
  64    * shape as the obstacle shape.
  65    * The supported file types:
  66    *  - BREP
  67    *  - IGES
  68    *  - STEP
  69    *  - ACIS
  70    * \param theFilePath the path to file
  71    * \return \c true if file has been successfully read
  72    */
  73   bool ImportFromFile( const QString& theFilePath );
  74
  75   /**
  76    * Stores the file path of the imported file.
  77    * \param theFilePath file path
  78    */
  79   void SetFilePath(const QString& theFilePath);
  80
  81   /**
  82    * Returns the imported file path.
  83    */
  84   QString GetFilePath() const;
  85
  86    /**
  87    * Stores the study entry of the imported GEOM object.
  88    * \param theEntry GEOM object entry
  89    */
  90   void SetGeomObjectEntry(const QString& theEntry);
  91
  92   /**
  93    * Returns the imported GEOM object entry.
  94    */
  95   QString GetGeomObjectEntry() const;
  96
  97 protected:
  98
  99   /**
 100    * Creates new object in the internal data structure. Use higher level objects
 101    * to create objects with real content.
 102    */
 103   HYDROData_Obstacle();
 104
 105   /**
 106    * Destructs properties of the object and object itself, removes it from the document.
 107    */
 108   virtual ~HYDROData_Obstacle();
 109 };