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 <vector>
  24
  25 class QFile;
  26 class gp_XYZ;
  27 class gp_XY;
  28 class HYDROData_PolylineXY;
  29 class HYDROData_QuadtreeNode;
  30 class vtkPolyData;
  31 class vtkIdList;
  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   struct HYDRODATA_EXPORT AltitudePoint
  43   {
  44     AltitudePoint( double x=0, double y=0, double z=0 );
  45     double X;
  46     double Y;
  47     double Z;
  48
  49     double SquareDistance( const AltitudePoint& ) const;
  50   };
  51   typedef std::vector<AltitudePoint> AltitudePoints;
  52
  53 protected:
  54
  55   /**
  56    * Enumeration of tags corresponding to the persistent object parameters.
  57    */
  58   enum DataTag
  59   {
  60     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  61     DataTag_AltitudePoints,    ///< altitude points, array of reals
  62     DataTag_FilePath,          ///< bathymetry imported file path
  63     DataTag_FilePaths,         ///< bathymetry imported file paths
  64     DataTag_AltitudesInverted, ///< flag to invert z values
  65     DataTag_Quadtree,          ///< quadtree associated to the zone
  66     DataTag_Delaunay,          ///< Delaunay 2D associated to the zone
  67   };
  68
  69 public:
  70   DEFINE_STANDARD_RTTIEXT(HYDROData_Bathymetry, HYDROData_IAltitudeObject);
  71
  72   /**
  73    * Returns the kind of this object. Must be redefined in all objects of known type.
  74    */
  75   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
  76
  77
  78   /**
  79    * Dump Bathymetry object to Python script representation.
  80    */
  81   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
  82                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  83
  84 public:
  85   // Public methods to work with Bathymetry altitudes.
  86
  87   /**
  88    * Replace current altitude points by new one.
  89    * \param thePoints the altitude points list
  90    */
  91   HYDRODATA_EXPORT virtual void             SetAltitudePoints( const AltitudePoints& thePoints );
  92
  93   /**
  94    * Returns altitude points list.
  95    * \return points list
  96    */
  97   HYDRODATA_EXPORT virtual AltitudePoints   GetAltitudePoints(bool IsConvertToGlobal = false) const;
  98   HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* GetQuadtreeNodes() const;
  99   HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* ComputeQuadtreeNodes( int key) const;
 100
 101   HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints( const NCollection_Sequence<gp_XY>& thePoints, int theMethod = 0) const;
 102
 103 #ifndef LIGHT_MODE
 104   HYDRODATA_EXPORT virtual vtkPolyData* GetVtkDelaunay2D() const;
 105   HYDRODATA_EXPORT virtual vtkPolyData* ComputeVtkDelaunay2D(int key) const;
 106 #endif
 107
 108   /**
 109    * Remove all altitude points.
 110    */
 111   HYDRODATA_EXPORT virtual void             RemoveAltitudePoints();
 112
 113   /**
 114    * Returns altitude for given point.
 115    * \param thePoint the point to examine
 116    * \param theMethod interpolation model, default 0 = nearest point
 117    * \return altitude value
 118    */
 119   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint, int theMethod=0 ) const;
 120
 121 public:
 122   // Public methods to work with files.
 123
 124   /**
 125    * Stores the bathymetry file path
 126    * \param theFilePath image file path
 127    */
 128   HYDRODATA_EXPORT void                     SetFilePath( const TCollection_AsciiString& theFilePath );
 129
 130   HYDRODATA_EXPORT void                     SetFilePaths( const QStringList& theFilePaths );
 131
 132   /**
 133    * Returns uploaded bathymetry file path
 134    */
 135   HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
 136
 137   HYDRODATA_EXPORT QStringList GetFilePaths() const;
 138
 139   /**
 140    * Set flag indicating needs to invert altitude values
 141    * \param theIsInverted new invert value
 142    * \param theIsUpdate flag indicating necessity to update points
 143    */
 144   HYDRODATA_EXPORT void                     SetAltitudesInverted( const bool theIsInverted,
 145                                                                   const bool theIsUpdate = true );
 146
 147   /**
 148    * Returns flag indicating needs to invert altitude values.
 149    */
 150   HYDRODATA_EXPORT bool                     IsAltitudesInverted() const;
 151
 152   /**
 153    * Imports Bathymetry data from file. The supported file types:
 154    *  - xyz
 155    * \param theFileName the path to file
 156    * \return \c true if file has been successfully read
 157    */
 158   HYDRODATA_EXPORT virtual bool             ImportFromFiles( const QStringList& theFileNames );
 159
 160   HYDRODATA_EXPORT virtual bool             ImportFromFile( const QString& theFileName );
 161
 162   HYDRODATA_EXPORT Handle(HYDROData_PolylineXY) CreateBoundaryPolyline() const;
 163
 164   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 165
 166 private:
 167
 168   /**
 169    * Imports Bathymetry data from 'XYZ' file.
 170    */
 171   bool                                      importFromXYZFile( QFile&          theFile,
 172                                                                AltitudePoints& thePoints ) const;
 173   //static int myQuadTreeNumber;
 174   static std::map<int, HYDROData_QuadtreeNode*> myQuadtrees;
 175 #ifndef LIGHT_MODE
 176   //static int myDelaunayNumber;
 177   static std::map<int, vtkPolyData*> myDelaunay2D;
 178 #endif
 179   bool                                      importFromASCFile( QFile&          theFile,
 180                                                                AltitudePoints& thePoints ) const;
 181
 182 protected:
 183
 184   friend class HYDROData_Iterator;
 185
 186   /**
 187    * Creates new object in the internal data structure. Use higher level objects
 188    * to create objects with real content.
 189    */
 190   HYDRODATA_EXPORT HYDROData_Bathymetry();
 191
 192   /**
 193    * Destructs properties of the object and object itself, removes it from the document.
 194    */
 195   HYDRODATA_EXPORT ~HYDROData_Bathymetry();
 196 };
 197
 198 #endif