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
65 DataTag_Quadtree, ///< quadtree associated to the zone
66 DataTag_Delaunay, ///< Delaunay 2D associated to the zone
70 DEFINE_STANDARD_RTTIEXT(HYDROData_Bathymetry, HYDROData_IAltitudeObject);
73 * Returns the kind of this object. Must be redefined in all objects of known type.
75 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
79 * Dump Bathymetry object to Python script representation.
81 HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
82 MapOfTreatedObjects& theTreatedObjects ) const;
85 // Public methods to work with Bathymetry altitudes.
88 * Replace current altitude points by new one.
89 * \param thePoints the altitude points list
91 HYDRODATA_EXPORT virtual void SetAltitudePoints( const AltitudePoints& thePoints );
94 * Returns altitude points list.
97 HYDRODATA_EXPORT virtual AltitudePoints GetAltitudePoints(bool IsConvertToGlobal = false) const;
98 HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* GetQuadtreeNodes() const;
99 HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* ComputeQuadtreeNodes( int key) const;
102 HYDRODATA_EXPORT virtual vtkPolyData* GetVtkDelaunay2D() const;
103 HYDRODATA_EXPORT virtual vtkPolyData* ComputeVtkDelaunay2D(int key) const;
107 * Remove all altitude points.
109 HYDRODATA_EXPORT virtual void RemoveAltitudePoints();
112 * Returns altitude for given point.
113 * \param thePoint the point to examine
114 * \param theMethod interpolation model, default 0 = nearest point
115 * \return altitude value
117 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint, int theMethod=0 ) const;
120 // Public methods to work with files.
123 * Stores the bathymetry file path
124 * \param theFilePath image file path
126 HYDRODATA_EXPORT void SetFilePath( const TCollection_AsciiString& theFilePath );
128 HYDRODATA_EXPORT void SetFilePaths( const QStringList& theFilePaths );
131 * Returns uploaded bathymetry file path
133 HYDRODATA_EXPORT TCollection_AsciiString GetFilePath() const;
135 HYDRODATA_EXPORT QStringList GetFilePaths() const;
138 * Set flag indicating needs to invert altitude values
139 * \param theIsInverted new invert value
140 * \param theIsUpdate flag indicating necessity to update points
142 HYDRODATA_EXPORT void SetAltitudesInverted( const bool theIsInverted,
143 const bool theIsUpdate = true );
146 * Returns flag indicating needs to invert altitude values.
148 HYDRODATA_EXPORT bool IsAltitudesInverted() const;
151 * Imports Bathymetry data from file. The supported file types:
153 * \param theFileName the path to file
154 * \return \c true if file has been successfully read
156 HYDRODATA_EXPORT virtual bool ImportFromFiles( const QStringList& theFileNames );
158 HYDRODATA_EXPORT virtual bool ImportFromFile( const QString& theFileName );
160 HYDRODATA_EXPORT Handle(HYDROData_PolylineXY) CreateBoundaryPolyline() const;
162 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
167 * Imports Bathymetry data from 'XYZ' file.
169 bool importFromXYZFile( QFile& theFile,
170 AltitudePoints& thePoints ) const;
171 //static int myQuadTreeNumber;
172 static std::map<int, HYDROData_QuadtreeNode*> myQuadtrees;
174 //static int myDelaunayNumber;
175 static std::map<int, vtkPolyData*> myDelaunay2D;
177 bool importFromASCFile( QFile& theFile,
178 AltitudePoints& thePoints ) const;
182 friend class HYDROData_Iterator;
185 * Creates new object in the internal data structure. Use higher level objects
186 * to create objects with real content.
188 HYDRODATA_EXPORT HYDROData_Bathymetry();
191 * Destructs properties of the object and object itself, removes it from the document.
193 HYDRODATA_EXPORT ~HYDROData_Bathymetry();