src/HYDROData/HYDROData_Stream.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_Stream_HeaderFile
  20 #define HYDROData_Stream_HeaderFile
  21
  22 #include "HYDROData_NaturalObject.h"
  23
  24 #include <TopoDS_Face.hxx>
  25 #include <TopoDS_Edge.hxx>
  26
  27 #include <Geom_BSplineCurve.hxx>
  28
  29 DEFINE_STANDARD_HANDLE(HYDROData_Stream, HYDROData_NaturalObject)
  30
  31 class Handle(HYDROData_PolylineXY);
  32 class Handle(HYDROData_Polyline3D);
  33 class Handle(HYDROData_Profile);
  34 class HYDROData_IProfilesInterpolator;
  35 class TColStd_Array1OfReal;
  36 class Handle(TopTools_HArray1OfShape);
  37
  38
  39 /**\class HYDROData_Stream
  40  * \brief
  41  *
  42  */
  43 class HYDROData_Stream : public HYDROData_NaturalObject
  44 {
  45 public:
  46
  47   struct PrsDefinition
  48   {
  49     TopoDS_Shape myPrs3D;
  50     TopoDS_Shape myPrs2D;
  51     TopoDS_Edge  myLeftBank;
  52     TopoDS_Edge  myRightBank;
  53     TopoDS_Edge  myInlet;
  54     TopoDS_Edge  myOutlet;
  55   };
  56
  57 protected:
  58   /**
  59    * Enumeration of tags corresponding to the persistent object parameters.
  60    */
  61   enum DataTag
  62   {
  63     DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
  64     DataTag_HydraulicAxis,     ///< reference hydraulic axis
  65     DataTag_Profile,           ///< reference profiles
  66     DataTag_ParamsArray,       ///< parameters array
  67     DataTag_BottomPolyline     ///< reference bottom polyline
  68   };
  69
  70 public:
  71
  72   DEFINE_STANDARD_RTTI(HYDROData_Stream);
  73
  74 public:
  75
  76   /**
  77    * Creates the presentations(2D and 3D) by given hydraulic axis and profiles.
  78    */
  79   HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_PolylineXY)& theHydAxis,
  80                                                     const HYDROData_SequenceOfObjects&  theProfiles,
  81                                                     PrsDefinition&                      thePrs );
  82
  83   /**
  84    * Creates the presentations(2D and 3D) by given first points, last points and profiles.
  85    * If 2D profiles is null - they will not used in the presentation.
  86    */
  87   HYDRODATA_EXPORT static bool CreatePresentations( const Handle(TColgp_HArray1OfPnt)     theArrayOfFPnt,
  88                                                     const Handle(TColgp_HArray1OfPnt)     theArrayOfLPnt,
  89                                                     const Handle(TopTools_HArray1OfShape) theArrOfProfiles,
  90                                                     const Handle(TopTools_HArray1OfShape) theArrOf2DProfiles,
  91                                                     PrsDefinition&                        thePrs );
  92
  93 public:
  94
  95   /**
  96    * Returns the kind of this object. Must be redefined in all objects of known type.
  97    */
  98   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_STREAM;}
  99
 100   /**
 101    * Dump object to Python script representation.
 102    */
 103   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
 104
 105   /**
 106    * Returns the list of all reference objects of this object.
 107    */
 108   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 109
 110   /**
 111    * Update the profiles order and shape presentations of stream.
 112    * Call this method whenever you made changes for stream data.
 113    */
 114   HYDRODATA_EXPORT virtual void Update();
 115
 116   /**
 117    * Checks that object has 2D presentation. Reimlemented to retun true.
 118    */
 119   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 120
 121   /**
 122    * Update the shape presentations of stream.
 123    */
 124   HYDRODATA_EXPORT virtual void UpdatePrs();
 125
 126   /**
 127    *
 128    */
 129   HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination,
 130                                         bool isGenerateNewName ) const;
 131
 132
 133   /**
 134    * Returns default filling color for new stream.
 135    */
 136   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
 137
 138   /**
 139    * Returns default border color for new stream.
 140    */
 141   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
 142
 143   /**
 144    * Returns true if given polyline can be used as stream axis.
 145    */
 146   HYDRODATA_EXPORT static bool IsValidAsAxis( const Handle(HYDROData_PolylineXY)& theAxis );
 147
 148 public:
 149   // Public methods to work with Stream presentation
 150
 151   /**
 152    * Returns the left edge of the stream.
 153    */
 154   HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const;
 155
 156   /**
 157    * Returns the right edge of the stream.
 158    */
 159   HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const;
 160
 161   /**
 162    * Returns the inlet edge of the stream.
 163    */
 164   HYDRODATA_EXPORT virtual TopoDS_Shape GetInletShape() const;
 165
 166   /**
 167    * Returns the outlet edge of the stream.
 168    */
 169   HYDRODATA_EXPORT virtual TopoDS_Shape GetOutletShape() const;
 170
 171
 172 public:
 173   // Public methods to work with Stream data fields
 174
 175   /**
 176    * Sets reference hydraulic axis object for stream.
 177    */
 178   HYDRODATA_EXPORT virtual bool SetHydraulicAxis( const Handle(HYDROData_PolylineXY)& theAxis );
 179
 180   /**
 181    * Returns reference hydraulic axis object of stream.
 182    */
 183   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetHydraulicAxis() const;
 184
 185   /**
 186    * Remove reference hydraulic axis object from stream.
 187    */
 188   HYDRODATA_EXPORT virtual void RemoveHydraulicAxis();
 189
 190   /**
 191    * Returns true if profile has the intersection with the given hydraulic axis.
 192    * Returns the parameter of inresection point on axis if axis is presented by one curve,
 193    * if axis presented by set of edges the <outPar> returns a common length of segments till the intersection point.
 194    */
 195   HYDRODATA_EXPORT static bool HasIntersection( const Handle(HYDROData_PolylineXY)& theHydAxis,
 196                                                 const Handle(HYDROData_Profile)&    theProfile,
 197                                                 const TopoDS_Face&                  thePlane,
 198                                                 Standard_Real&                      theOutPar );
 199
 200   /**
 201    * Returns true if profile has the intersection with reference hydraulic axis.
 202    * Returns the parameter of inresection point on axis if axis is presented by one curve,
 203    * if axis presented by set of edges the <outPar> returns a common length of segments till the intersection point.
 204    */
 205   HYDRODATA_EXPORT virtual bool HasIntersection( const Handle(HYDROData_Profile)& theProfile,
 206                                                  const TopoDS_Face&               thePlane,
 207                                                  Standard_Real&                   theOutPar ) const;
 208
 209   /**
 210   * Builds a planar face
 211   */
 212   HYDRODATA_EXPORT static bool BuildFace( const Handle(HYDROData_PolylineXY)& theHydAxis,
 213                                           TopoDS_Face&                        thePlane );
 214
 215   /**
 216    * Add new one reference profile object for stream.
 217    */
 218   HYDRODATA_EXPORT virtual bool AddProfile( const Handle(HYDROData_Profile)& theProfile );
 219
 220   /**
 221    * Add new one reference profile object for stream.
 222    */
 223   HYDRODATA_EXPORT virtual bool SetProfiles( const HYDROData_SequenceOfObjects& theProfiles,
 224                                              const bool&                        theIsToOrder = true );
 225
 226   /**
 227    * Returns all reference profile objects of stream.
 228    */
 229   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetProfiles() const;
 230
 231   /**
 232    * Removes reference profile object from stream.
 233    */
 234   HYDRODATA_EXPORT virtual bool RemoveProfile( const Handle(HYDROData_Profile)& theProfile );
 235
 236   /**
 237    * Removes all reference profile objects from stream.
 238    */
 239   HYDRODATA_EXPORT virtual void RemoveProfiles();
 240
 241   /**
 242    * Generates bottom polyline for stream or update the existing bottom polyline.
 243    * \return true in case of success
 244    */
 245   HYDRODATA_EXPORT virtual bool GenerateBottomPolyline();
 246
 247   /**
 248    * Returns reference bottom polyline object of stream.
 249    */
 250   HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetBottomPolyline() const;
 251
 252   /**
 253    * Sets reference bottom polyline object for stream.
 254    * \param theBottom the polyline 3D
 255    * \return true in case of success
 256    */
 257   HYDRODATA_EXPORT virtual bool SetBottomPolyline( const Handle(HYDROData_Polyline3D)& theBottom );
 258
 259   /**
 260    * Add interpolated profiles into the stream.
 261    * \param theInterpolator the interpolator
 262    * \return true in case of success
 263    */
 264   HYDRODATA_EXPORT virtual bool Interpolate( HYDROData_IProfilesInterpolator* theInterpolator );
 265
 266 protected:
 267
 268   /**
 269    * Insert one profile in to the stream profiles order.
 270    */
 271   void insertProfileInToOrder( const Handle(HYDROData_Profile)& theProfile,
 272                                const int                        theBeforeIndex = -1 );
 273
 274   /**
 275    * Fully recompute the order of all profiles in accordance with reference hydraulic axis.
 276    * If hydraulic axis is not set all profiles will be removed from order.
 277    */
 278   void updateProfilesOrder();
 279
 280   /**
 281    * Returns the type of child altitude object.
 282    * Reimplemented to create stream altitude object.
 283    */
 284   HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 285
 286   /**
 287    * Builds b-spline using interpolation algorithm.
 288    */
 289   static Handle(Geom_BSplineCurve) buildInterpolationCurve(
 290     const Handle(TColgp_HArray1OfPnt)& theArrayOfPnt );
 291
 292 private:
 293
 294   void setParametersArray( const TColStd_Array1OfReal& theArray );
 295
 296   TColStd_Array1OfReal* getParametersArray() const;
 297
 298   void removeParametersArray();
 299
 300   int insertParameter( const Standard_Real& theParam );
 301
 302   void removeParameter( const int& theIndex );
 303
 304 protected:
 305
 306   friend class HYDROData_Iterator;
 307
 308   /**
 309    * Creates new object in the internal data structure. Use higher level objects
 310    * to create objects with real content.
 311    */
 312   HYDRODATA_EXPORT HYDROData_Stream();
 313
 314   /**
 315    * Destructs properties of the object and object itself, removes it from the document.
 316    */
 317   virtual HYDRODATA_EXPORT ~HYDROData_Stream();
 318 };
 319
 320 #endif
 321
 322