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