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