]> SALOME platform Git repositories - modules/hydro.git/commitdiff
Salome HOME
HYDROData_Obstacle has been wrapped for Python.
authorrkv <rkv@opencascade.com>
Thu, 26 Dec 2013 08:36:09 +0000 (08:36 +0000)
committerrkv <rkv@opencascade.com>
Thu, 26 Dec 2013 08:36:09 +0000 (08:36 +0000)
src/HYDROPy/HYDROData_Obstacle.sip [new file with mode: 0644]

diff --git a/src/HYDROPy/HYDROData_Obstacle.sip b/src/HYDROPy/HYDROData_Obstacle.sip
new file mode 100644 (file)
index 0000000..d7d4211
--- /dev/null
@@ -0,0 +1,109 @@
+// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+%ExportedHeaderCode
+#include <HYDROData_Obstacle.h>
+%End
+
+class HYDROData_Obstacle : public HYDROData_ArtificialObject
+{
+%TypeHeaderCode
+#include <HYDROData_Obstacle.h>
+%End
+
+public:
+  /**
+   * Returns the top shape of the object.
+   */
+//  virtual TopoDS_Shape GetTopShape() const;
+
+  /**
+   * Returns the 3d shape of the object.
+   */
+//  virtual TopoDS_Shape GetShape3D() const;
+
+  /**
+   * Returns default filling color for new obstacle.
+   */
+  static QColor DefaultFillingColor();
+
+  /**
+   * Returns default border color for new obstacle.
+   */
+  static QColor DefaultBorderColor();
+
+
+  /**
+   * Sets the 3d shape of the object.
+   */
+//  virtual void SetShape3D( const TopoDS_Shape& theShape );
+
+public:
+
+  /**
+   * Imports shape from file containing geometrical object and sets this
+   * shape as the obstacle shape.
+   * The supported file types:
+   *  - BREP
+   *  - IGES
+   *  - STEP
+   *  - ACIS
+   * \param theFilePath the path to file
+   * \return \c true if file has been successfully read
+   */
+  bool ImportFromFile( const QString& theFilePath );
+
+  /**
+   * Stores the file path of the imported file.
+   * \param theFilePath file path
+   */
+  void SetFilePath(const QString& theFilePath);
+
+  /**
+   * Returns the imported file path.
+   */
+  QString GetFilePath() const;
+
+   /**
+   * Stores the study entry of the imported GEOM object.
+   * \param theEntry GEOM object entry
+   */
+  void SetGeomObjectEntry(const QString& theEntry);
+
+  /**
+   * Returns the imported GEOM object entry.
+   */
+  QString GetGeomObjectEntry() const;
+
+protected:
+
+  /**
+   * Creates new object in the internal data structure. Use higher level objects 
+   * to create objects with real content.
+   */
+  HYDROData_Obstacle();
+
+  /**
+   * Destructs properties of the object and object itself, removes it from the document.
+   */
+  virtual ~HYDROData_Obstacle();
+};