src/HYDROData/HYDROData_Channel.cxx

   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 #include "HYDROData_Channel.h"
  20
  21 #include "HYDROData_Document.h"
  22 #include "HYDROData_Polyline3D.h"
  23 #include "HYDROData_Profile.h"
  24 #include "HYDROData_PolylineXY.h"
  25 #include "HYDROData_Projection.h"
  26 #include "HYDROData_ShapesGroup.h"
  27 #include "HYDROData_ShapesTool.h"
  28 #include "HYDROData_Stream.h"
  29 #include "HYDROData_Tool.h"
  30
  31 #include <BRepBuilderAPI_MakeWire.hxx>
  32
  33 #include <BRepOffsetAPI_MakePipeShell.hxx>
  34 #include <BRepOffsetAPI_MakePipe.hxx>
  35 #include <BRepCheck_Analyzer.hxx>
  36
  37 #include <BRep_Tool.hxx>
  38
  39 #include <BRepBuilderAPI_Transform.hxx>
  40
  41 #include <BRepLib_MakeEdge.hxx>
  42 #include <BRepLib_MakeWire.hxx>
  43
  44 #include <GeomAPI_ProjectPointOnCurve.hxx>
  45
  46 #include <gp_Ax1.hxx>
  47
  48 #include <TopExp.hxx>
  49 #include <TopExp_Explorer.hxx>
  50
  51 #include <TColgp_HArray1OfPnt.hxx>
  52 #include <TColgp_Array1OfDir.hxx>
  53
  54 #include <TColStd_Array1OfReal.hxx>
  55
  56 #include <TopTools_HArray1OfShape.hxx>
  57
  58 #include <TopoDS.hxx>
  59 #include <TopoDS_Wire.hxx>
  60 #include <TopoDS_Vertex.hxx>
  61
  62 //#define DEB_CHANNEL 1
  63 #ifdef DEB_CHANNEL
  64 #include <BRepTools.hxx>
  65 #endif
  66
  67 #include <QColor>
  68 #include <QStringList>
  69
  70 IMPLEMENT_STANDARD_HANDLE(HYDROData_Channel,HYDROData_ArtificialObject)
  71 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Channel,HYDROData_ArtificialObject)
  72
  73
  74 HYDROData_Channel::HYDROData_Channel()
  75 : HYDROData_ArtificialObject( Geom_3d )
  76 {
  77 }
  78
  79 HYDROData_Channel::~HYDROData_Channel()
  80 {
  81 }
  82
  83 QStringList HYDROData_Channel::DumpToPython( const QString& thePyScriptPath,
  84                                              MapOfTreatedObjects& theTreatedObjects ) const
  85 {
  86   QStringList aResList = dumpObjectCreation( theTreatedObjects );
  87   QString aName = GetObjPyName();
  88
  89   Handle(HYDROData_Polyline3D) aRefGideLine = GetGuideLine();
  90   setPythonReferenceObject( thePyScriptPath, theTreatedObjects, aResList, aRefGideLine, "SetGuideLine" );
  91
  92   Handle(HYDROData_Profile) aRefProfile = GetProfile();
  93   setPythonReferenceObject( thePyScriptPath, theTreatedObjects, aResList, aRefProfile, "SetProfile" );
  94
  95   aResList << QString( "" );
  96   aResList << QString( "%1.Update();" ).arg( aName );
  97   aResList << QString( "" );
  98
  99   return aResList;
 100 }
 101
 102 HYDROData_SequenceOfObjects HYDROData_Channel::GetAllReferenceObjects() const
 103 {
 104   HYDROData_SequenceOfObjects aResSeq = HYDROData_ArtificialObject::GetAllReferenceObjects();
 105
 106   Handle(HYDROData_Polyline3D) aGuideLine = GetGuideLine();
 107   if ( !aGuideLine.IsNull() )
 108     aResSeq.Append( aGuideLine );
 109
 110   Handle(HYDROData_Profile) aProfile = GetProfile();
 111   if ( !aProfile.IsNull() )
 112     aResSeq.Append( aProfile );
 113
 114   return aResSeq;
 115 }
 116
 117 bool HYDROData_Channel::CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
 118                                              const Handle(HYDROData_Profile)&    theProfile,
 119                                              PrsDefinition&                      thePrs )
 120 {
 121   // Check input parameters
 122   if ( theGuideLine.IsNull() || theProfile.IsNull() ) {
 123     return false;
 124   }
 125
 126   TopoDS_Wire aPathWire = TopoDS::Wire( theGuideLine->GetShape3D() );
 127   TopoDS_Wire aProfileWire = TopoDS::Wire( theProfile->GetShape3D() );
 128   if ( aPathWire.IsNull() || aProfileWire.IsNull() ) {
 129     return false;
 130   }
 131
 132 #ifdef DEB_CHANNEL
 133   BRepTools::Write( aPathWire, "guideline.brep" );
 134   BRepTools::Write( aProfileWire, "profile.brep" );
 135 #endif
 136
 137   // Pre-processing
 138   Handle(HYDROData_PolylineXY) aPolylineXY = theGuideLine->GetPolylineXY();
 139   if ( aPolylineXY.IsNull() ) {
 140     return false;
 141   }
 142
 143   /*
 144   HYDROData_IPolyline::SectionType aSectionType = aPolylineXY->GetSectionType( 0 );
 145   HYDROData_IPolyline::PointsList aPolylinePoints = aPolylineXY->GetPoints( 0 );
 146   int aNbPoints = aPolylinePoints.Length();
 147   */
 148
 149   HYDROData_Polyline3D::Polyline3DPoints aPolylinePoints3D = theGuideLine->GetPoints();
 150   int aNbPoints = aPolylinePoints3D.Length();
 151   if ( aNbPoints < 2 ) {
 152     return false;
 153   }
 154
 155   // Get tangent in each point of the guide line ( 2D )
 156   TColgp_Array1OfDir aTangents( 1, aNbPoints );
 157
 158   HYDROData_IPolyline::SectionType aSectionType = aPolylineXY->GetSectionType( 0 );
 159
 160   if ( aSectionType == HYDROData_IPolyline::SECTION_POLYLINE ) {
 161     for ( int i = 1; i <= aNbPoints; ++i ) {
 162       gp_XYZ aPnt = aPolylinePoints3D.Value( i );
 163       aPnt.SetZ( 0. );
 164       gp_XYZ aPrevPnt;
 165       if ( i > 1 ) {
 166         aPrevPnt = aPolylinePoints3D.Value( i - 1 );
 167         aPrevPnt.SetZ( 0. );
 168       }
 169
 170       gp_Vec aDir;
 171       if ( i < aNbPoints ) {
 172         gp_XYZ aNextPnt = aPolylinePoints3D.Value( i + 1 );
 173         aNextPnt.SetZ( 0. );
 174
 175         gp_Vec anEdgeVec( aPnt, aNextPnt );
 176
 177         if ( i == 1 ) {
 178           aDir = anEdgeVec;
 179         } else {
 180           gp_Vec aPrevVec( aPrevPnt, aPnt );
 181           aDir = aPrevVec.Normalized() + anEdgeVec.Normalized();
 182         }
 183       } else {
 184         aDir = gp_Vec( aPrevPnt, aPnt );
 185       }
 186
 187       aTangents.SetValue( i, aDir );
 188     }
 189   } else {
 190     // Get curve from the first edge ( 2D )
 191     TopTools_SequenceOfShape anEdges;
 192     HYDROData_ShapesTool::ExploreShapeToShapes( aPolylineXY->GetShape(), TopAbs_EDGE, anEdges );
 193     Standard_Real aStart, anEnd;
 194
 195     Handle(Geom_Curve) aCurve = BRep_Tool::Curve( TopoDS::Edge( anEdges.First() ), aStart, anEnd );
 196     GeomAPI_ProjectPointOnCurve aProject;
 197
 198     // Get tangents
 199     for ( int i = 1; i <= aNbPoints; ++i ) {
 200       gp_XYZ aPointToTest = aPolylinePoints3D.Value( i );
 201       aPointToTest.SetZ( 0. );
 202
 203       aProject.Init( aPointToTest, aCurve );
 204       Quantity_Parameter aParam = aProject.LowerDistanceParameter();
 205       gp_Pnt aPnt;
 206       gp_Vec aDir;
 207       aCurve->D1( aParam, aPnt, aDir);
 208
 209       aTangents.SetValue( i, aDir );
 210     }
 211   }
 212
 213   // Get the profile middle point ( 3D )
 214   gp_Pnt aMiddlePoint( theProfile->GetMiddlePoint( true ) );
 215
 216   // Translate the profile to each point on the guide line ( 3D )
 217   Handle(TColgp_HArray1OfPnt) anArrayOfFPnt = new TColgp_HArray1OfPnt(1, aNbPoints );
 218   Handle(TColgp_HArray1OfPnt) anArrayOfLPnt = new TColgp_HArray1OfPnt(1, aNbPoints );
 219   Handle(TopTools_HArray1OfShape) anArrOfProfiles = new TopTools_HArray1OfShape( 1, aNbPoints );
 220
 221   for ( int i = 1; i <= aNbPoints; ++i ) {
 222     // Get point on the guide line
 223     gp_Pnt aPointOnGuide( aPolylinePoints3D.Value( i ) );
 224
 225     // Define translation and rotation:
 226     gp_Trsf Translation, Rotation;
 227
 228     // Translation
 229     Translation.SetTranslation( aMiddlePoint, aPointOnGuide );
 230     TopoDS_Wire aTransformedProfile =
 231       TopoDS::Wire( BRepBuilderAPI_Transform( aProfileWire, Translation, Standard_True ) );
 232
 233     // Rotation
 234     gp_Vec aVertical( 0., 0., 1. );
 235     TopoDS_Vertex aLeftVertex, aRightVertex;
 236     TopExp::Vertices( aTransformedProfile, aLeftVertex, aRightVertex );
 237     gp_Pnt aLeftPoint  = BRep_Tool::Pnt( aLeftVertex );
 238     gp_Pnt aRightPoint = BRep_Tool::Pnt( aRightVertex );
 239     gp_Vec aLeftToRight( aLeftPoint, aRightPoint);
 240     gp_Vec NormalToProfile = aVertical ^ aLeftToRight;
 241
 242     gp_Vec aDir = aTangents.Value( i );
 243     gp_Vec AxisOfRotation = NormalToProfile ^ aDir;
 244     if (AxisOfRotation.Magnitude() <= gp::Resolution()) {
 245       if ( aVertical * aLeftToRight < 0. ) {
 246         gp_Ax1 theVertical(aPointOnGuide, gp::DZ() );
 247         Rotation.SetRotation(theVertical, M_PI);
 248       }
 249     } else {
 250       gp_Ax1 theAxis(aPointOnGuide, AxisOfRotation);
 251       Standard_Real theAngle = NormalToProfile.AngleWithRef(aDir, AxisOfRotation);
 252       Rotation.SetRotation(theAxis, theAngle);
 253     }
 254
 255     aTransformedProfile = TopoDS::Wire(BRepBuilderAPI_Transform( aTransformedProfile, Rotation, Standard_True) );
 256
 257     // Get the first and the last points of the transformed profile
 258     TopoDS_Vertex V1, V2;
 259     TopExp::Vertices( aTransformedProfile, V1, V2 );
 260
 261     // Fill the data
 262     anArrayOfFPnt->SetValue( i, BRep_Tool::Pnt( V1 ) );
 263     anArrayOfLPnt->SetValue( i, BRep_Tool::Pnt( V2 ) );
 264
 265     anArrOfProfiles->SetValue( i, aTransformedProfile );
 266   }
 267
 268   // Create presentation
 269   HYDROData_Stream::PrsDefinition aPrs;
 270   Handle(TopTools_HArray1OfShape) anArrOf2DProfiles; // we don't need 2D profiles for channel/digue presentation
 271   bool aRes = HYDROData_Stream::CreatePresentations( anArrayOfFPnt, anArrayOfLPnt,
 272                                                      anArrOfProfiles, anArrOf2DProfiles, aPrs );
 273   if ( aRes ) {
 274     thePrs.myPrs3D = aPrs.myPrs3D;
 275     thePrs.myPrs2D = TopoDS::Face( aPrs.myPrs2D );
 276     BRepBuilderAPI_MakeWire aMakeWire( aPrs.myLeftBank ) ;
 277     thePrs.myLeftBank = aMakeWire.Wire();
 278     aMakeWire = BRepBuilderAPI_MakeWire( aPrs.myRightBank );
 279     thePrs.myRightBank = aMakeWire.Wire();
 280     aMakeWire = BRepBuilderAPI_MakeWire( aPrs.myInlet );
 281     thePrs.myInlet = aMakeWire.Wire();
 282     aMakeWire = BRepBuilderAPI_MakeWire( aPrs.myOutlet );
 283     thePrs.myOutlet = aMakeWire.Wire();
 284   }
 285
 286   return aRes;
 287 }
 288
 289 void HYDROData_Channel::Update()
 290 {
 291   HYDROData_ArtificialObject::Update();
 292
 293   Handle(HYDROData_Polyline3D) aGuideLine = GetGuideLine();
 294   Handle(HYDROData_Profile) aProfile = GetProfile();
 295
 296   PrsDefinition aResultPrs;
 297   if ( !CreatePresentations( aGuideLine, aProfile, aResultPrs ) )
 298     return;
 299
 300   SetShape3D( aResultPrs.myPrs3D );
 301   SetTopShape( aResultPrs.myPrs2D );
 302
 303   // Create groups for channel
 304   TopTools_SequenceOfShape aLeftBankEdges;
 305   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myLeftBank, TopAbs_EDGE, aLeftBankEdges );
 306
 307   TopTools_SequenceOfShape aRightBankEdges;
 308   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myRightBank, TopAbs_EDGE, aRightBankEdges );
 309
 310   TopTools_SequenceOfShape anInletEdges;
 311   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myInlet, TopAbs_EDGE, anInletEdges );
 312
 313   TopTools_SequenceOfShape anOutletEdges;
 314   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myOutlet, TopAbs_EDGE, anOutletEdges );
 315
 316   QString aLeftGroupName = GetName() + "_Left_Bank";
 317
 318   Handle(HYDROData_ShapesGroup) aLeftGroup = createGroupObject();
 319   aLeftGroup->SetName( aLeftGroupName );
 320   aLeftGroup->SetShapes( aLeftBankEdges );
 321
 322   QString aRightGroupName = GetName() + "_Right_Bank";
 323
 324   Handle(HYDROData_ShapesGroup) aRightGroup = createGroupObject();
 325   aRightGroup->SetName( aRightGroupName );
 326   aRightGroup->SetShapes( aRightBankEdges );
 327
 328   QString anInGroupName = GetName() + "_Inlet";
 329
 330   Handle(HYDROData_ShapesGroup) anInGroup = createGroupObject();
 331   anInGroup->SetName( anInGroupName );
 332   anInGroup->SetShapes( anInletEdges );
 333
 334   QString anOutGroupName = GetName() + "_Outlet";
 335
 336   Handle(HYDROData_ShapesGroup) anOutGroup = createGroupObject();
 337   anOutGroup->SetName( anOutGroupName );
 338   anOutGroup->SetShapes( anOutletEdges );
 339 }
 340
 341 bool HYDROData_Channel::IsHas2dPrs() const
 342 {
 343   return true;
 344 }
 345
 346 QColor HYDROData_Channel::DefaultFillingColor() const
 347 {
 348   return QColor( Qt::blue );
 349 }
 350
 351 QColor HYDROData_Channel::DefaultBorderColor() const
 352 {
 353   return QColor( Qt::transparent );
 354 }
 355
 356 bool HYDROData_Channel::SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine )
 357 {
 358   Handle(HYDROData_Polyline3D) aPrevGuideLine = GetGuideLine();
 359
 360   if ( theGuideLine.IsNull() )
 361   {
 362     RemoveGuideLine();
 363     return !aPrevGuideLine.IsNull();
 364   }
 365
 366   if ( IsEqual( aPrevGuideLine, theGuideLine ) )
 367     return false;
 368
 369   TopoDS_Wire aHydraulicWire = TopoDS::Wire( theGuideLine->GetTopShape() );
 370   if ( aHydraulicWire.IsNull() )
 371     return false; // The polyline must be a single wire
 372
 373   SetReferenceObject( theGuideLine, DataTag_GuideLine );
 374
 375   // Indicate model of the need to update the chanel presentation
 376   Changed( Geom_3d );
 377
 378   return true;
 379 }
 380
 381 Handle(HYDROData_Polyline3D) HYDROData_Channel::GetGuideLine() const
 382 {
 383   return Handle(HYDROData_Polyline3D)::DownCast(
 384            GetReferenceObject( DataTag_GuideLine ) );
 385 }
 386
 387 void HYDROData_Channel::RemoveGuideLine()
 388 {
 389   Handle(HYDROData_Polyline3D) aPrevGuideLine = GetGuideLine();
 390   if ( aPrevGuideLine.IsNull() )
 391     return;
 392
 393   ClearReferenceObjects( DataTag_GuideLine );
 394
 395   // Indicate model of the need to update the chanel presentation
 396   Changed( Geom_3d );
 397 }
 398
 399 bool HYDROData_Channel::SetProfile( const Handle(HYDROData_Profile)& theProfile )
 400 {
 401   Handle(HYDROData_Profile) aPrevProfile = GetProfile();
 402
 403   if ( theProfile.IsNull() )
 404   {
 405     RemoveProfile();
 406     return !aPrevProfile.IsNull();
 407   }
 408
 409   if ( IsEqual( aPrevProfile, theProfile ) )
 410     return false;
 411
 412   SetReferenceObject( theProfile, DataTag_Profile );
 413
 414   // Indicate model of the need to update the chanel presentation
 415   Changed( Geom_3d );
 416
 417   return true;
 418 }
 419
 420 Handle(HYDROData_Profile) HYDROData_Channel::GetProfile() const
 421 {
 422   return Handle(HYDROData_Profile)::DownCast(
 423            GetReferenceObject( DataTag_Profile ) );
 424 }
 425
 426 void HYDROData_Channel::RemoveProfile()
 427 {
 428   Handle(HYDROData_Profile) aPrevProfile = GetProfile();
 429   if ( aPrevProfile.IsNull() )
 430     return;
 431
 432   ClearReferenceObjects( DataTag_Profile );
 433
 434   // Indicate model of the need to update the chanel presentation
 435   Changed( Geom_3d );
 436 }
 437
 438 ObjectKind HYDROData_Channel::getAltitudeObjectType() const
 439 {
 440   return KIND_STREAM_ALTITUDE;
 441 }
 442
 443 TopoDS_Shape HYDROData_Channel::GetLeftShape() const
 444 {
 445   HYDROData_SequenceOfObjects aGroups = GetGroups();
 446   return HYDROData_Tool::getFirstShapeFromGroup( aGroups, 1);
 447 }
 448
 449 TopoDS_Shape HYDROData_Channel::GetRightShape() const
 450 {
 451   HYDROData_SequenceOfObjects aGroups = GetGroups();
 452   return HYDROData_Tool::getFirstShapeFromGroup( aGroups, 2);
 453 }