refs #651: wrapping land cover map by Python

[modules/hydro.git] / src / HYDROData / HYDROData_Obstacle.h

diff --git a/src/HYDROData/HYDROData_Obstacle.h b/src/HYDROData/HYDROData_Obstacle.h
index 2b51e06ec2abdd380722e1cfd5905267d3a0808d..3c792a16b1427440dc70b4929b6ea6a72e16d085 100644 (file)
--- a/src/HYDROData/HYDROData_Obstacle.h
+++ b/src/HYDROData/HYDROData_Obstacle.h
@@ -1,3 +1,20 @@
+// 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, 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
+// 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
+//
 
 #ifndef HYDROData_Obstacle_HeaderFile
 #define HYDROData_Obstacle_HeaderFile
@@ -20,7 +37,8 @@ protected:
   {
     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
     DataTag_GeomObjectEntry, ///< study entry of the imported GEOM object
-    DataTag_FilePath ///< imported file path
+    DataTag_FilePath,        ///< imported file path
+    DataTag_Translation,     ///< translation coefficients
   };
 
 public:
@@ -42,25 +60,22 @@ public:
    */
   HYDRODATA_EXPORT virtual void Update();
 
-  /**
-   * Returns the top shape of the object.
-   */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
+  HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 
   /**
-   * Returns the 3d shape of the object.
+   * Checks that object has 2D presentation. Reimlemented to retun true.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
+  HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 
   /**
    * Returns default filling color for new obstacle.
    */
-  HYDRODATA_EXPORT static QColor DefaultFillingColor();
+  HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
 
   /**
    * Returns default border color for new obstacle.
    */
-  HYDRODATA_EXPORT static QColor DefaultBorderColor();
+  HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
 
 
   /**
@@ -94,56 +109,46 @@ public:
    */
   HYDRODATA_EXPORT QString GetFilePath() const;
 
-   /**
-   * Stores the study entry of the imported GEOM object.
-   * \param theEntry GEOM object entry
-   */
-  HYDRODATA_EXPORT void SetGeomObjectEntry(const QString& theEntry);
-
+  
   /**
-   * Returns the imported GEOM object entry.
+   * Imports shape from IOR.
+   * \param theIOR the IOR of Geom object
+   * \return \c true if shape has been successfully imported
    */
-  HYDRODATA_EXPORT QString GetGeomObjectEntry() const;
-
-protected:
+  HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
 
   /**
-   * Returns default filling color for new object.
+   * Stores the study entry of the imported GEOM object.
+   * \param theEntry GEOM object entry
    */
-  HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
+  HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
 
   /**
-   * Returns default border color for new object.
+   * Returns the imported GEOM object entry.
    */
-  HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
+  HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
 
   /**
-   * Create all necessary child group objects.
+   * Returns the imported GEOM object name.
    */
-  HYDRODATA_EXPORT virtual void createGroupObjects();
+  HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectName() const;
 
   /**
-   * Returns the type of child altitude object.
-   * Reimplemented to create obstacle altitude object.
+   * Translate the obstacle to the given distance.
    */
-  virtual ObjectKind getAltitudeObjectType() const;
+  HYDRODATA_EXPORT void Translate( const double theDx,
+                                   const double theDy,
+                                   const double theDz );
 
 protected:
-
-  friend class HYDROData_Iterator;
-
-  /**
-   * Creates new object in the internal data structure. Use higher level objects 
-   * to create objects with real content.
-   */
-  HYDRODATA_EXPORT HYDROData_Obstacle();
-
   /**
-   * Destructs properties of the object and object itself, removes it from the document.
+   * Returns the type of child altitude object.
+   * Reimplemented to create obstacle altitude object.
    */
-  virtual HYDRODATA_EXPORT ~HYDROData_Obstacle();
+  HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 
 private:
+
   /**
    * Imports shape from the BREP file.
    * \param theFilePath the path to file
@@ -164,6 +169,37 @@ private:
    * \return shape as TopoDS_Shape (null shape if import was failed)
    */
   TopoDS_Shape ImportSTEP( const QString& theFilePath ) const;
+
+  /**
+   * Create all necessary child group objects.
+   */
+  void createGroupObjects();
+
+  /**
+   * Sets the translation coefficients.
+   */
+  void setTranslation( const double theDx, const double theDy, const double theDz );
+
+  /**
+   * Returns the translation coefficients.
+   */
+  bool getTranslation( double& theDx, double& theDy, double& theDz ) const;
+
+protected:
+
+  friend class HYDROData_Iterator;
+
+  /**
+   * Creates new object in the internal data structure. Use higher level objects 
+   * to create objects with real content.
+   */
+  HYDRODATA_EXPORT HYDROData_Obstacle();
+
+  /**
+   * Destructs properties of the object and object itself, removes it from the document.
+   */
+  virtual HYDRODATA_EXPORT ~HYDROData_Obstacle();
+
 };
 
 #endif