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