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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Bathymetry_HeaderFile
20 #define HYDROData_Bathymetry_HeaderFile
22 #include "HYDROData_IAltitudeObject.h"
28 class HYDROData_PolylineXY;
29 class HYDROData_QuadtreeNode;
34 /**\class HYDROData_Bathymetry
35 * \brief Class that stores/retreives information about the Bathymetry.
37 * The Bathymetry represents measurement of the altitude of points on the terrain.
39 class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
42 struct HYDRODATA_EXPORT AltitudePoint
44 AltitudePoint( double x=0, double y=0, double z=0 );
49 double SquareDistance( const AltitudePoint& ) const;
51 typedef std::vector<AltitudePoint> AltitudePoints;
56 * Enumeration of tags corresponding to the persistent object parameters.
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_FilePaths, ///< bathymetry imported file paths
64 DataTag_AltitudesInverted, ///< flag to invert z values
68 DEFINE_STANDARD_RTTIEXT(HYDROData_Bathymetry, HYDROData_IAltitudeObject);
71 * Returns the kind of this object. Must be redefined in all objects of known type.
73 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
77 * Dump Bathymetry object to Python script representation.
79 HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
80 MapOfTreatedObjects& theTreatedObjects ) const;
83 // Public methods to work with Bathymetry altitudes.
86 * Replace current altitude points by new one.
87 * \param thePoints the altitude points list
89 HYDRODATA_EXPORT virtual void SetAltitudePoints( const AltitudePoints& thePoints );
92 * Returns altitude points list.
95 HYDRODATA_EXPORT virtual AltitudePoints GetAltitudePoints(bool IsConvertToGlobal = false) const;
96 HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* GetQuadtreeNodes() const;
99 HYDRODATA_EXPORT virtual vtkPolyData* GetVtkDelaunay2D() const;
100 //HYDRODATA_EXPORT bool interpolZtriangle(const gp_XY& point, vtkIdList* triangle, double* z);
104 * Remove all altitude points.
106 HYDRODATA_EXPORT virtual void RemoveAltitudePoints();
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
114 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint, int theMethod=0 ) const;
117 // Public methods to work with files.
120 * Stores the bathymetry file path
121 * \param theFilePath image file path
123 HYDRODATA_EXPORT void SetFilePath( const TCollection_AsciiString& theFilePath );
125 HYDRODATA_EXPORT void SetFilePaths( const QStringList& theFilePaths );
128 * Returns uploaded bathymetry file path
130 HYDRODATA_EXPORT TCollection_AsciiString GetFilePath() const;
132 HYDRODATA_EXPORT QStringList GetFilePaths() const;
135 * Set flag indicating needs to invert altitude values
136 * \param theIsInverted new invert value
137 * \param theIsUpdate flag indicating necessity to update points
139 HYDRODATA_EXPORT void SetAltitudesInverted( const bool theIsInverted,
140 const bool theIsUpdate = true );
143 * Returns flag indicating needs to invert altitude values.
145 HYDRODATA_EXPORT bool IsAltitudesInverted() const;
148 * Imports Bathymetry data from file. The supported file types:
150 * \param theFileName the path to file
151 * \return \c true if file has been successfully read
153 HYDRODATA_EXPORT virtual bool ImportFromFiles( const QStringList& theFileNames );
155 HYDRODATA_EXPORT virtual bool ImportFromFile( const QString& theFileName );
157 HYDRODATA_EXPORT Handle(HYDROData_PolylineXY) CreateBoundaryPolyline() const;
159 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
164 * Imports Bathymetry data from 'XYZ' file.
166 bool importFromXYZFile( QFile& theFile,
167 AltitudePoints& thePoints ) const;
168 static std::map<int, HYDROData_QuadtreeNode*> myQuadtrees;
170 static std::map<int, vtkPolyData*> myDelaunay2D;
172 bool importFromASCFile( QFile& theFile,
173 AltitudePoints& thePoints ) const;
177 friend class HYDROData_Iterator;
180 * Creates new object in the internal data structure. Use higher level objects
181 * to create objects with real content.
183 HYDRODATA_EXPORT HYDROData_Bathymetry();
186 * Destructs properties of the object and object itself, removes it from the document.
188 HYDRODATA_EXPORT ~HYDROData_Bathymetry();