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