src/HYDROData/HYDROData_DTM.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_DTM_HeaderFile
  20 #define HYDROData_DTM_HeaderFile
  21
  22 #include "HYDROData_Bathymetry.h"
  23 #include <vector>
  24 #include <gp_Pnt2d.hxx>
  25
  26 class Handle_HYDROData_Profile;
  27 class Handle_Geom2d_BSplineCurve;
  28 class Handle_Geom2d_Curve;
  29 class gp_Pnt;
  30 class gp_Vec2d;
  31 class TopoDS_Edge;
  32
  33 DEFINE_STANDARD_HANDLE( HYDROData_DTM, HYDROData_Bathymetry )
  34
  35 /**\class HYDROData_DTM
  36  * \brief Class that represents the Digital Terrain Model
  37  */
  38 class HYDROData_DTM : public HYDROData_Bathymetry
  39 {
  40 protected:
  41   /**
  42    * Enumeration of tags corresponding to the persistent object parameters.
  43    */
  44   enum DataTag
  45   {
  46     DataTag_First = HYDROData_Bathymetry::DataTag_First + 100, ///< first tag, to reserve
  47     DataTag_Profiles,
  48     DataTag_DDZ,
  49     DataTag_SpatialStep,
  50   };
  51
  52 public:
  53   DEFINE_STANDARD_RTTI( HYDROData_DTM );
  54
  55   HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetProfiles() const;
  56   HYDRODATA_EXPORT void SetProfiles( const HYDROData_SequenceOfObjects& );
  57
  58   HYDRODATA_EXPORT double GetDDZ() const;
  59   HYDRODATA_EXPORT void SetDDZ( double );
  60
  61   HYDRODATA_EXPORT double GetSpatialStep() const;
  62   HYDRODATA_EXPORT void SetSpatialStep( double );
  63
  64   HYDRODATA_EXPORT virtual void Update();
  65
  66   HYDRODATA_EXPORT void CreateBankShapes( TopoDS_Edge& theLeft, TopoDS_Edge& theRight ) const;
  67
  68 public:
  69   struct PointUZ
  70   {
  71     PointUZ( double u=0, double z=0 ) { U=u; Z=z; }
  72     double U;
  73     double Z;
  74   };
  75   class CurveUZ : public std::vector<PointUZ>
  76   {
  77   public:
  78     CurveUZ( double theXcurv, const gp_Vec2d& theProfileDir = gp_Vec2d() );
  79     ~CurveUZ();
  80
  81     double Xcurv() const;
  82     gp_Vec2d ProfileDir() const;
  83
  84     CurveUZ operator + ( const CurveUZ& ) const;
  85     CurveUZ operator * ( double ) const;
  86
  87   private:
  88     double myXcurv;
  89     gp_Vec2d myProfileDir;
  90   };
  91   class Bank
  92   {
  93   public:
  94     void reserve( int theNbPoints );
  95     void push_back( const gp_Pnt& thePnt, const gp_Dir& theTangent );
  96     void clear();
  97     TopoDS_Edge createEdge3d() const;
  98
  99   public:
 100     std::vector<gp_Pnt> myPoints;
 101     std::vector<gp_Dir> myDirs;
 102   };
 103
 104 protected:
 105   friend class HYDROData_Iterator;
 106   friend class test_HYDROData_DTM;
 107
 108   HYDRODATA_EXPORT HYDROData_DTM();
 109   virtual HYDRODATA_EXPORT ~HYDROData_DTM();
 110
 111   static Handle_Geom2d_BSplineCurve CreateHydraulicAxis(
 112     const std::vector<Handle_HYDROData_Profile>& theProfiles,
 113     std::vector<double>& theDistances );
 114
 115   static std::vector<Handle_Geom2d_Curve> ProfileToParametric( const Handle_HYDROData_Profile& theProfile,
 116                                                                double& theUMin, double& theUMax,
 117                                                                gp_Vec2d& theDir );
 118
 119   static void GetProperties( const Handle_HYDROData_Profile& theProfile,
 120                              gp_Pnt& theLowestPoint, gp_Vec2d& theDir,
 121                              bool isNormalDir,
 122                              double& theZMin, double& theZMax );
 123
 124   static void ProfileDiscretization( const Handle_HYDROData_Profile& theProfile,
 125                                      double theXCurv, double theMinZ, double theMaxZ, double theDDZ,
 126                                      CurveUZ& theMidPointCurve,
 127                                      CurveUZ& theWidthCurve,
 128                                      double theTolerance = 1E-6 );
 129
 130   static void CurveTo3D( const Handle_Geom2d_BSplineCurve& theHydraulicAxis,
 131                          const CurveUZ& theMidCurve, const CurveUZ& theWidthCurve,
 132                          AltitudePoints& thePoints,
 133                          Bank* theLeftBank = 0,
 134                          Bank* theRightBank = 0,
 135                          double dz = 0 );
 136
 137   static void Interpolate( const CurveUZ& theCurveA, const CurveUZ& theCurveB,
 138                            int theNbSteps, std::vector<CurveUZ>& theInterpolation,
 139                            bool isAddSecond );
 140
 141   static AltitudePoints Interpolate( const Handle_Geom2d_BSplineCurve& theHydraulicAxis,
 142                                      const Handle_HYDROData_Profile& theProfileA,
 143                                      double theXCurvA,
 144                                      const Handle_HYDROData_Profile& theProfileB,
 145                                      double theXCurvB,
 146                                      double theDDZ, int theNbSteps, bool isAddSecond,
 147                                      Bank* theLeftBank = 0,
 148                                      Bank* theRightBank = 0 );
 149
 150   static AltitudePoints Interpolate( const std::vector<Handle_HYDROData_Profile>& theProfiles,
 151                                      double theDDZ, double theSpatialStep,
 152                                      Bank* theLeftBank = 0,
 153                                      Bank* theRightBank = 0 );
 154
 155 private:
 156   Bank myLeft;
 157   Bank myRight;
 158 };
 159
 160 #endif