refs #417: showing new objects

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

diff --git a/src/HYDROData/HYDROData_Bathymetry.h b/src/HYDROData/HYDROData_Bathymetry.h
index 6167d3f227c0ec088fadfc5471b0bcbc693f424b..72ef41395ee1faed7c93450fc55c1b2744362754 100644 (file)
--- a/src/HYDROData/HYDROData_Bathymetry.h
+++ b/src/HYDROData/HYDROData_Bathymetry.h
@@ -2,14 +2,13 @@
 #ifndef HYDROData_Bathymetry_HeaderFile
 #define HYDROData_Bathymetry_HeaderFile
 
-#include <HYDROData_Object.h>
+#include "HYDROData_IAltitudeObject.h"
 
-class gp_XY;
-class gp_XYZ;
-class QPointF;
 class QFile;
+class gp_XYZ;
+class Handle_HYDROData_PolylineXY;
 
-DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_Object)
+DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_IAltitudeObject)
 
 
 /**\class HYDROData_Bathymetry
@@ -17,12 +16,12 @@ DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_Object)
  *
  * The Bathymetry represents measurement of the altitude of points on the terrain.
  */
-class HYDROData_Bathymetry : public HYDROData_Object
+class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
 {
 public:
 
-  typedef gp_XYZ               AltitudePoint;
-  typedef QList<AltitudePoint> AltitudePoints;
+  typedef gp_XYZ                              AltitudePoint;
+  typedef NCollection_Sequence<AltitudePoint> AltitudePoints;
 
 protected:
 
@@ -31,8 +30,10 @@ protected:
    */
   enum DataTag
   {
-    DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
-    DataTag_AltitudePoints ///< altitude points, array of reals
+    DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
+    DataTag_AltitudePoints,    ///< altitude points, array of reals
+    DataTag_FilePath,          ///< bathymetry imported file path
+    DataTag_AltitudesInverted, ///< flag to invert z values
   };
 
 public:
@@ -45,6 +46,11 @@ public:
   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
 
 
+  /**
+   * Dump Bathymetry object to Python script representation.
+   */
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+
 public:      
   // Public methods to work with Bathymetry altitudes.
 
@@ -70,18 +76,34 @@ public:
    * \param thePoint the point to examine
    * \return altitude value
    */
-  HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const QPointF& thePoint ) const;
+  HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
+
+public:
+  // Public methods to work with files.
 
   /**
-   * Returns altitude for given point.
-   * \param thePoint the point to examine
-   * \return altitude value
+   * Stores the bathymetry file path
+   * \param theFilePath image file path
    */
-  HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
+  HYDRODATA_EXPORT void                     SetFilePath( const TCollection_AsciiString& theFilePath );
 
+  /**
+   * Returns uploaded bathymetry file path
+   */
+  HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
 
-public:
-  // Public methods to work with files.
+  /**
+   * Set flag indicating needs to invert altitude values
+   * \param theIsInverted new invert value
+   * \param theIsUpdate flag indicating necessity to update points
+   */
+  HYDRODATA_EXPORT void                     SetAltitudesInverted( const bool theIsInverted,
+                                                                  const bool theIsUpdate = true );
+
+  /**
+   * Returns flag indicating needs to invert altitude values.
+   */
+  HYDRODATA_EXPORT bool                     IsAltitudesInverted() const;
 
   /**
    * Imports Bathymetry data from file. The supported file types:
@@ -89,8 +111,9 @@ public:
    * \param theFileName the path to file
    * \return \c true if file has been successfully read
    */
-  HYDRODATA_EXPORT virtual bool             ImportFromFile( const QString& theFileName );
+  HYDRODATA_EXPORT virtual bool             ImportFromFile( const TCollection_AsciiString& theFileName );
 
+  HYDRODATA_EXPORT Handle_HYDROData_PolylineXY CreateBoundaryPolyline() const;
 
 private:
 
@@ -98,7 +121,7 @@ private:
    * Imports Bathymetry data from 'XYZ' file.
    */
   bool                                      importFromXYZFile( QFile&          theFile,
-                                                               AltitudePoints& thePoints );
+                                                               AltitudePoints& thePoints ) const;
 
 protected:
 
@@ -108,12 +131,12 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDROData_Bathymetry();
+  HYDRODATA_EXPORT HYDROData_Bathymetry();
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
    */
-  ~HYDROData_Bathymetry();
+  HYDRODATA_EXPORT ~HYDROData_Bathymetry();
 };
 
 #endif