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 #include <TopTools_SequenceOfShape.hxx>
  58
  59 #include <TopoDS.hxx>
  60 #include <TopoDS_Wire.hxx>
  61 #include <TopoDS_Vertex.hxx>
  62
  63 #define DEB_CHANNEL 1
  64 #ifdef DEB_CHANNEL
  65 #include <BRepTools.hxx>
  66 #endif
  67
  68 #include <QColor>
  69 #include <QStringList>
  70
  71 #define _DEVDEBUG_
  72 #include "HYDRO_trace.hxx"
  73
  74 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Channel,HYDROData_ArtificialObject)
  75
  76
  77 HYDROData_Channel::HYDROData_Channel()
  78 : HYDROData_ArtificialObject( Geom_3d )
  79 {
  80 }
  81
  82 HYDROData_Channel::~HYDROData_Channel()
  83 {
  84 }
  85
  86 QStringList HYDROData_Channel::DumpToPython( const QString& thePyScriptPath,
  87                                              MapOfTreatedObjects& theTreatedObjects ) const
  88 {
  89   QStringList aResList = dumpObjectCreation( theTreatedObjects );
  90   QString aName = GetObjPyName();
  91
  92   Handle(HYDROData_Polyline3D) aRefGideLine = GetGuideLine();
  93   setPythonReferenceObject( thePyScriptPath, theTreatedObjects, aResList, aRefGideLine, "SetGuideLine" );
  94
  95   Handle(HYDROData_Profile) aRefProfile = GetProfile();
  96   setPythonReferenceObject( thePyScriptPath, theTreatedObjects, aResList, aRefProfile, "SetProfile" );
  97
  98   aResList << QString( "%1.SetEquiDistance( %2 )" ).arg( aName ).arg( GetEquiDistance() );
  99
 100   aResList << QString( "" );
 101   aResList << QString( "%1.Update()" ).arg( aName );
 102   aResList << QString( "" );
 103
 104   return aResList;
 105 }
 106
 107 HYDROData_SequenceOfObjects HYDROData_Channel::GetAllReferenceObjects() const
 108 {
 109   HYDROData_SequenceOfObjects aResSeq = HYDROData_ArtificialObject::GetAllReferenceObjects();
 110
 111   Handle(HYDROData_Polyline3D) aGuideLine = GetGuideLine();
 112   if ( !aGuideLine.IsNull() )
 113     aResSeq.Append( aGuideLine );
 114
 115   Handle(HYDROData_Profile) aProfile = GetProfile();
 116   if ( !aProfile.IsNull() )
 117     aResSeq.Append( aProfile );
 118
 119   return aResSeq;
 120 }
 121
 122 bool HYDROData_Channel::CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
 123                                              const Handle(HYDROData_Profile)&    theProfile,
 124                                              PrsDefinition&                      thePrs,
 125                                              double                              theEquiDistance )
 126 {
 127   // Check input parameters
 128   if ( theGuideLine.IsNull() || theProfile.IsNull() ) {
 129     return false;
 130   }
 131
 132   TopoDS_Wire aPathWire = TopoDS::Wire( theGuideLine->GetShape3D() );
 133   TopoDS_Wire aProfileWire = TopoDS::Wire( theProfile->GetShape3D() );
 134   if ( aPathWire.IsNull() || aProfileWire.IsNull() ) {
 135     return false;
 136   }
 137
 138 #ifdef DEB_CHANNEL
 139   std::string brepName = "guideline_";
 140   brepName += theGuideLine->GetName().toStdString();
 141   brepName += ".brep";
 142   BRepTools::Write( aPathWire, brepName.c_str() );
 143   brepName = "profile_";
 144   brepName += theGuideLine->GetName().toStdString();
 145   brepName += ".brep";
 146   BRepTools::Write( aProfileWire, brepName.c_str() );
 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( theEquiDistance );
 162   int aNbPoints = aPolylinePoints3D.Length();
 163   if ( aNbPoints < 2 )
 164     return false;
 165
 166   // Get tangent in each point of the guide line ( 2D )
 167   TColgp_Array1OfDir aTangents( 1, aNbPoints );
 168
 169   HYDROData_IPolyline::SectionType aSectionType = aPolylineXY->GetSectionType( 0 );
 170
 171   if( aSectionType == HYDROData_IPolyline::SECTION_POLYLINE )
 172   {
 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( true ) );
 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   double anEquiDistance = GetEquiDistance();
 310   if ( !CreatePresentations( aGuideLine, aProfile, aResultPrs, anEquiDistance ) )
 311     return;
 312
 313   SetShape3D( aResultPrs.myPrs3D );
 314   SetTopShape( aResultPrs.myPrs2D );
 315
 316   // Create groups for channel
 317   TopTools_SequenceOfShape aLeftBankEdges;
 318   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myLeftBank, TopAbs_EDGE, aLeftBankEdges );
 319
 320   TopTools_SequenceOfShape aRightBankEdges;
 321   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myRightBank, TopAbs_EDGE, aRightBankEdges );
 322
 323   TopTools_SequenceOfShape anInletEdges;
 324   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myInlet, TopAbs_EDGE, anInletEdges );
 325
 326   TopTools_SequenceOfShape anOutletEdges;
 327   HYDROData_ShapesTool::ExploreShapeToShapes( aResultPrs.myOutlet, TopAbs_EDGE, anOutletEdges );
 328
 329   QString aLeftGroupName = GetName() + "_Left_Bank";
 330
 331   Handle(HYDROData_ShapesGroup) aLeftGroup = createGroupObject();
 332   aLeftGroup->SetName( aLeftGroupName );
 333   aLeftGroup->SetShapes( aLeftBankEdges );
 334
 335   QString aRightGroupName = GetName() + "_Right_Bank";
 336
 337   Handle(HYDROData_ShapesGroup) aRightGroup = createGroupObject();
 338   aRightGroup->SetName( aRightGroupName );
 339   aRightGroup->SetShapes( aRightBankEdges );
 340
 341   QString anInGroupName = GetName() + "_Inlet";
 342
 343   Handle(HYDROData_ShapesGroup) anInGroup = createGroupObject();
 344   anInGroup->SetName( anInGroupName );
 345   anInGroup->SetShapes( anInletEdges );
 346
 347   QString anOutGroupName = GetName() + "_Outlet";
 348
 349   Handle(HYDROData_ShapesGroup) anOutGroup = createGroupObject();
 350   anOutGroup->SetName( anOutGroupName );
 351   anOutGroup->SetShapes( anOutletEdges );
 352 }
 353
 354 bool HYDROData_Channel::IsHas2dPrs() const
 355 {
 356   return true;
 357 }
 358
 359 QColor HYDROData_Channel::DefaultFillingColor() const
 360 {
 361   return QColor( Qt::blue );
 362 }
 363
 364 QColor HYDROData_Channel::DefaultBorderColor() const
 365 {
 366   return QColor( Qt::transparent );
 367 }
 368
 369 bool HYDROData_Channel::SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine )
 370 {
 371   Handle(HYDROData_Polyline3D) aPrevGuideLine = GetGuideLine();
 372
 373   if ( theGuideLine.IsNull() )
 374   {
 375     RemoveGuideLine();
 376     return !aPrevGuideLine.IsNull();
 377   }
 378
 379   if ( IsEqual( aPrevGuideLine, theGuideLine ) )
 380     return false;
 381
 382   TopoDS_Wire aHydraulicWire = TopoDS::Wire( theGuideLine->GetTopShape() );
 383   if ( aHydraulicWire.IsNull() )
 384     return false; // The polyline must be a single wire
 385
 386   SetReferenceObject( theGuideLine, DataTag_GuideLine );
 387
 388   // Indicate model of the need to update the chanel presentation
 389   Changed( Geom_3d );
 390
 391   return true;
 392 }
 393
 394 Handle(HYDROData_Polyline3D) HYDROData_Channel::GetGuideLine() const
 395 {
 396   return Handle(HYDROData_Polyline3D)::DownCast(
 397            GetReferenceObject( DataTag_GuideLine ) );
 398 }
 399
 400 void HYDROData_Channel::RemoveGuideLine()
 401 {
 402   Handle(HYDROData_Polyline3D) aPrevGuideLine = GetGuideLine();
 403   if ( aPrevGuideLine.IsNull() )
 404     return;
 405
 406   ClearReferenceObjects( DataTag_GuideLine );
 407
 408   // Indicate model of the need to update the chanel presentation
 409   Changed( Geom_3d );
 410 }
 411
 412 bool HYDROData_Channel::SetProfile( const Handle(HYDROData_Profile)& theProfile )
 413 {
 414   Handle(HYDROData_Profile) aPrevProfile = GetProfile();
 415
 416   if ( theProfile.IsNull() )
 417   {
 418     RemoveProfile();
 419     return !aPrevProfile.IsNull();
 420   }
 421
 422   if ( IsEqual( aPrevProfile, theProfile ) )
 423     return false;
 424
 425   SetReferenceObject( theProfile, DataTag_Profile );
 426
 427   // Indicate model of the need to update the chanel presentation
 428   Changed( Geom_3d );
 429
 430   return true;
 431 }
 432
 433 Handle(HYDROData_Profile) HYDROData_Channel::GetProfile() const
 434 {
 435   return Handle(HYDROData_Profile)::DownCast(
 436            GetReferenceObject( DataTag_Profile ) );
 437 }
 438
 439 void HYDROData_Channel::RemoveProfile()
 440 {
 441   Handle(HYDROData_Profile) aPrevProfile = GetProfile();
 442   if ( aPrevProfile.IsNull() )
 443     return;
 444
 445   ClearReferenceObjects( DataTag_Profile );
 446
 447   // Indicate model of the need to update the chanel presentation
 448   Changed( Geom_3d );
 449 }
 450
 451 ObjectKind HYDROData_Channel::getAltitudeObjectType() const
 452 {
 453   DEBTRACE("HYDROData_Channel::getAltitudeObjectType");
 454   return KIND_CHANNEL_ALTITUDE;
 455   //return KIND_STREAM_ALTITUDE;
 456 }
 457
 458 TopoDS_Shape HYDROData_Channel::GetLeftShape() const
 459 {
 460   HYDROData_SequenceOfObjects aGroups = GetGroups();
 461   return HYDROData_Tool::getFirstShapeFromGroup( aGroups, 1);
 462 }
 463
 464 TopoDS_Shape HYDROData_Channel::GetRightShape() const
 465 {
 466   HYDROData_SequenceOfObjects aGroups = GetGroups();
 467   return HYDROData_Tool::getFirstShapeFromGroup( aGroups, 2);
 468 }
 469
 470 void HYDROData_Channel::SetEquiDistance( double theEquiDistance )
 471 {
 472   double anEquiDistance = theEquiDistance > 0 ? theEquiDistance : 1E-3;
 473   SetDouble( DataTag_EquiDistance, theEquiDistance );
 474 }
 475
 476 double HYDROData_Channel::GetEquiDistance() const
 477 {
 478   return GetDouble( DataTag_EquiDistance, 1.0 );
 479 }