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