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