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