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