src/HYDROData/HYDROData_Bathymetry.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROData_Bathymetry_HeaderFile
  20 #define HYDROData_Bathymetry_HeaderFile
  21
  22 #include "HYDROData_IAltitudeObject.h"
  23 #include "HYDROData_QuadtreeNode.hxx"
  24 #include <vtkPolyData.h>
  25 #include <vtkIdList.h>
  26
  27 class QFile;
  28 class gp_XYZ;
  29 class gp_XY;
  30 class HYDROData_PolylineXY;
  31
  32
  33
  34 /**\class HYDROData_Bathymetry
  35  * \brief Class that stores/retreives information about the Bathymetry.
  36  *
  37  * The Bathymetry represents measurement of the altitude of points on the terrain.
  38  */
  39 class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
  40 {
  41 public:
  42
  43   typedef gp_XYZ                              AltitudePoint;
  44   typedef NCollection_Sequence<AltitudePoint> AltitudePoints;
  45
  46 protected:
  47
  48   /**
  49    * Enumeration of tags corresponding to the persistent object parameters.
  50    */
  51   enum DataTag
  52   {
  53     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  54     DataTag_AltitudePoints,    ///< altitude points, array of reals
  55     DataTag_FilePath,          ///< bathymetry imported file path
  56     DataTag_AltitudesInverted, ///< flag to invert z values
  57   };
  58
  59 public:
  60   DEFINE_STANDARD_RTTIEXT(HYDROData_Bathymetry, HYDROData_IAltitudeObject);
  61
  62   /**
  63    * Returns the kind of this object. Must be redefined in all objects of known type.
  64    */
  65   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
  66
  67
  68   /**
  69    * Dump Bathymetry object to Python script representation.
  70    */
  71   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
  72                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  73
  74 public:
  75   // Public methods to work with Bathymetry altitudes.
  76
  77   /**
  78    * Replace current altitude points by new one.
  79    * \param thePoints the altitude points list
  80    */
  81   HYDRODATA_EXPORT virtual void             SetAltitudePoints( const AltitudePoints& thePoints );
  82
  83   /**
  84    * Returns altitude points list.
  85    * \return points list
  86    */
  87   HYDRODATA_EXPORT virtual AltitudePoints   GetAltitudePoints(bool IsConvertToGlobal = false) const;
  88   HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* GetQuadtreeNodes() const;
  89
  90   HYDRODATA_EXPORT virtual vtkPolyData* GetVtkDelaunay2D() const;
  91   //HYDRODATA_EXPORT bool interpolZtriangle(const gp_XY& point, vtkIdList* triangle, double* z);
  92
  93   /**
  94    * Remove all altitude points.
  95    */
  96   HYDRODATA_EXPORT virtual void             RemoveAltitudePoints();
  97
  98   /**
  99    * Returns altitude for given point.
 100    * \param thePoint the point to examine
 101    * \param theMethod interpolation model, default 0 = nearest point
 102    * \return altitude value
 103    */
 104   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint, int theMethod=0 ) const;
 105
 106 public:
 107   // Public methods to work with files.
 108
 109   /**
 110    * Stores the bathymetry file path
 111    * \param theFilePath image file path
 112    */
 113   HYDRODATA_EXPORT void                     SetFilePath( const TCollection_AsciiString& theFilePath );
 114
 115   /**
 116    * Returns uploaded bathymetry file path
 117    */
 118   HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
 119
 120   /**
 121    * Set flag indicating needs to invert altitude values
 122    * \param theIsInverted new invert value
 123    * \param theIsUpdate flag indicating necessity to update points
 124    */
 125   HYDRODATA_EXPORT void                     SetAltitudesInverted( const bool theIsInverted,
 126                                                                   const bool theIsUpdate = true );
 127
 128   /**
 129    * Returns flag indicating needs to invert altitude values.
 130    */
 131   HYDRODATA_EXPORT bool                     IsAltitudesInverted() const;
 132
 133   /**
 134    * Imports Bathymetry data from file. The supported file types:
 135    *  - xyz
 136    * \param theFileName the path to file
 137    * \return \c true if file has been successfully read
 138    */
 139   HYDRODATA_EXPORT virtual bool             ImportFromFile( const TCollection_AsciiString& theFileName );
 140
 141   HYDRODATA_EXPORT Handle(HYDROData_PolylineXY) CreateBoundaryPolyline() const;
 142
 143   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 144
 145 private:
 146
 147   /**
 148    * Imports Bathymetry data from 'XYZ' file.
 149    */
 150   bool                                      importFromXYZFile( QFile&          theFile,
 151                                                                AltitudePoints& thePoints ) const;
 152   static std::map<int, HYDROData_QuadtreeNode*> myQuadtrees;
 153   static std::map<int, vtkPolyData*> myDelaunay2D;
 154
 155   bool                                      importFromASCFile( QFile&          theFile,
 156                                                                AltitudePoints& thePoints ) const;
 157
 158 protected:
 159
 160   friend class HYDROData_Iterator;
 161
 162   /**
 163    * Creates new object in the internal data structure. Use higher level objects
 164    * to create objects with real content.
 165    */
 166   HYDRODATA_EXPORT HYDROData_Bathymetry();
 167
 168   /**
 169    * Destructs properties of the object and object itself, removes it from the document.
 170    */
 171   HYDRODATA_EXPORT ~HYDROData_Bathymetry();
 172 };
 173
 174 #endif