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