Merge remote-tracking branch 'origin/BR_1321_ECW' into BR_DEMO

[modules/hydro.git] / src / HYDROPy / HYDROData_Obstacle.sip

diff --git a/src/HYDROPy/HYDROData_Obstacle.sip b/src/HYDROPy/HYDROData_Obstacle.sip
index d7d4211f70eb9d7330e6395581b1789116fa4b7a..1a2c505c03b58ff826435c9dd190deda9d5539db 100644 (file)
--- a/src/HYDROPy/HYDROData_Obstacle.sip
+++ b/src/HYDROPy/HYDROData_Obstacle.sip
@@ -1,12 +1,8 @@
-// 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
-//
+// Copyright (C) 2014-2015  EDF-R&D
 // 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.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -31,31 +27,15 @@ class HYDROData_Obstacle : public HYDROData_ArtificialObject
 %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();
+  virtual QColor DefaultFillingColor() const;
 
   /**
    * Returns default border color for new obstacle.
    */
-  static QColor DefaultBorderColor();
-
-
-  /**
-   * Sets the 3d shape of the object.
-   */
-//  virtual void SetShape3D( const TopoDS_Shape& theShape );
+  virtual QColor DefaultBorderColor() const;
 
 public:
 
@@ -72,6 +52,7 @@ public:
    */
   bool ImportFromFile( const QString& theFilePath );
 
+
   /**
    * Stores the file path of the imported file.
    * \param theFilePath file path
@@ -83,16 +64,35 @@ public:
    */
   QString GetFilePath() const;
 
-   /**
+
+public:
+
+  /**
+   * Imports shape from IOR.
+   * \param theIOR the IOR of Geom object
+   * \return \c true if shape has been successfully imported
+   */
+  bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
+
+  /**
    * Stores the study entry of the imported GEOM object.
    * \param theEntry GEOM object entry
    */
-  void SetGeomObjectEntry(const QString& theEntry);
+  void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
 
   /**
    * Returns the imported GEOM object entry.
    */
-  QString GetGeomObjectEntry() const;
+  TCollection_AsciiString GetGeomObjectEntry() const;
+
+
+public:
+
+  /**
+   * Translate the obstacle to the given distance.
+   */
+  void Translate( const double theDx, const double theDy, const double theDz );
+
 
 protected: