Salome HOME
Merge branch 'master' of https://git.salome-platform.org/git/modules/hydro
[modules/hydro.git] / src / HYDROData / HYDROData_Polyline3D.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_Polyline3D.h"
20
21 #include "HYDROData_IAltitudeObject.h"
22 #include "HYDROData_Document.h"
23 #include "HYDROData_PolylineXY.h"
24 #include "HYDROData_Profile.h"
25 #include "HYDROData_ProfileUZ.h"
26 #include "HYDROData_ShapesTool.h"
27 #include "HYDROData_Tool.h"
28
29 #include <BRep_Tool.hxx>
30
31 #include <Geom_BSplineCurve.hxx>
32 #include <GeomAdaptor_Curve.hxx>
33 #include <GCPnts_QuasiUniformAbscissa.hxx>
34 #include <GCPnts_AbscissaPoint.hxx>
35
36 #include <gp_Pnt2d.hxx>
37 #include <gp_XY.hxx>
38 #include <gp_XYZ.hxx>
39
40 #include <TColStd_Array1OfReal.hxx>
41
42 #include <TopoDS.hxx>
43 #include <TopoDS_Edge.hxx>
44 #include <TopoDS_Vertex.hxx>
45 #include <TopoDS_Wire.hxx>
46
47 #include <TopExp.hxx>
48
49 #include <TopExp_Explorer.hxx>
50
51 #include <TopTools_SequenceOfShape.hxx>
52
53 #include <QColor>
54 #include <QStringList>
55
56 IMPLEMENT_STANDARD_HANDLE(HYDROData_Polyline3D,HYDROData_Object)
57 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Polyline3D,HYDROData_Object)
58
59
60 HYDROData_Polyline3D::HYDROData_Polyline3D()
61 : HYDROData_Object( Geom_3d )
62 {
63 }
64
65 HYDROData_Polyline3D::~HYDROData_Polyline3D()
66 {
67 }
68
69 QStringList HYDROData_Polyline3D::DumpToPython( const QString& thePyScriptPath,
70                                                 MapOfTreatedObjects& theTreatedObjects ) const
71 {
72   QStringList aResList = dumpObjectCreation( theTreatedObjects );
73   QString aPolylineName = GetObjPyName();
74
75   Handle(HYDROData_PolylineXY) aRefPolyline = GetPolylineXY();
76   setPythonReferenceObject( thePyScriptPath, theTreatedObjects, aResList, aRefPolyline, "SetPolylineXY" );
77
78   Handle(HYDROData_ProfileUZ) aRefProfileUZ = GetProfileUZ();
79   if ( !aRefProfileUZ.IsNull() )
80   {
81     Handle(HYDROData_Profile) aProfile = 
82       Handle(HYDROData_Profile)::DownCast( aRefProfileUZ->GetFatherObject() );
83     if ( checkObjectPythonDefinition( thePyScriptPath, theTreatedObjects, aResList, aProfile ) )
84     {
85       QString aProfileName = aProfile->GetObjPyName();
86       if ( !aProfileName.isEmpty() )
87       {
88         aResList << QString( "%1.SetProfileUZ( %2.GetProfileUZ() )" )
89                      .arg( aPolylineName ).arg( aProfileName );
90       }
91     }
92   }
93   else
94   {
95     Handle(HYDROData_IAltitudeObject) aRefBathymetry = GetAltitudeObject();
96     if ( !aRefBathymetry.IsNull() )
97     {
98       Handle(HYDROData_ProfileUZ) aChildProfileUZ = GetChildProfileUZ();
99       if ( !aChildProfileUZ.IsNull() )
100       {
101         Handle(HYDROData_Profile) aProfile = 
102           Handle(HYDROData_Profile)::DownCast( aChildProfileUZ->GetFatherObject() );
103         if ( checkObjectPythonDefinition( thePyScriptPath, theTreatedObjects, aResList, aProfile ) )
104         {
105           QString aProfileName = aProfile->GetObjPyName();
106           if ( !aProfileName.isEmpty() )
107           {
108             aResList << QString( "%1.SetChildProfileUZ( %2.GetProfileUZ() )" )
109                          .arg( aPolylineName ).arg( aProfileName );
110           }
111         }
112       }
113
114       setPythonReferenceObject( thePyScriptPath, theTreatedObjects, aResList, aRefBathymetry, "SetAltitudeObject" );
115     }
116   }
117
118   aResList << QString( "" );
119   aResList << QString( "%1.Update()" ).arg( aPolylineName );
120   aResList << QString( "" );
121
122   return aResList;
123 }
124
125 HYDROData_SequenceOfObjects HYDROData_Polyline3D::GetAllReferenceObjects() const
126 {
127   HYDROData_SequenceOfObjects aResSeq = HYDROData_Object::GetAllReferenceObjects();
128
129   Handle(HYDROData_PolylineXY) aPolylineXY = GetPolylineXY();
130   if ( !aPolylineXY.IsNull() )
131     aResSeq.Append( aPolylineXY );
132
133   Handle(HYDROData_ProfileUZ) aProfileUZ = GetProfileUZ();
134   if ( !aProfileUZ.IsNull() )
135     aResSeq.Append( aProfileUZ );
136
137   Handle(HYDROData_ProfileUZ) aChildProfileUZ = GetChildProfileUZ( false );
138   if ( !aChildProfileUZ.IsNull() )
139     aResSeq.Append( aChildProfileUZ );
140
141   return aResSeq;
142 }
143
144 void HYDROData_Polyline3D::Update()
145 {
146   HYDROData_Object::Update();
147
148   Handle(HYDROData_PolylineXY) aPolylineXY = GetPolylineXY();
149   if ( aPolylineXY.IsNull() )
150     return;
151
152   bool anIsSectionClosed = aPolylineXY->IsClosedSection( 0 );
153   HYDROData_IPolyline::SectionType aSectionType = aPolylineXY->GetSectionType( 0 );
154   HYDROData_IPolyline::PointsList aPolylinePoints = aPolylineXY->GetPoints( 0 );
155   if ( aPolylinePoints.IsEmpty() )
156     return;
157
158   Handle(HYDROData_ProfileUZ) aProfileUZ = GetProfileUZ();
159
160   Handle(HYDROData_IAltitudeObject) anAltitude = GetAltitudeObject();
161   if ( !anAltitude.IsNull() )
162     aProfileUZ = GetChildProfileUZ();
163
164   if ( aProfileUZ.IsNull() )
165     return;
166
167   HYDROData_IPolyline::PointsList aProfilePoints = aProfileUZ->GetPoints();
168   if ( aProfilePoints.IsEmpty() )
169     return;
170
171   const HYDROData_IPolyline::Point& aFirstPoint = aPolylinePoints.First();
172   const HYDROData_IPolyline::Point& aLastPoint = aPolylinePoints.Last();
173
174   const HYDROData_IPolyline::Point& aFirstParPoint = aProfilePoints.First();
175   const HYDROData_IPolyline::Point& aLastParPoint = aProfilePoints.Last();
176
177   double aPolylineCommonDist = aPolylineXY->GetDistance( 0, aPolylinePoints.Size() - 1 );
178   double aParCommonDist = gp_Pnt2d( aFirstParPoint.X(), 0 ).Distance( gp_Pnt2d( aLastParPoint.X(), 0 ) );
179
180   NCollection_Sequence<Polyline3DPoint> aResPoints;
181   
182   // Add first point as is
183   aResPoints.Append( Polyline3DPoint( aFirstPoint.X(), aFirstPoint.Y(), aFirstParPoint.Y() ) );
184
185   for ( int i = 2, aNbPoints = aPolylinePoints.Size(); i < aNbPoints; ++i )
186   {
187     const HYDROData_IPolyline::Point& aPolylinePoint = aPolylinePoints.Value( i );
188
189     double aDistance = aPolylineXY->GetDistance( 0, i - 1 );
190
191     double aParLen = ( aDistance / aPolylineCommonDist ) * aParCommonDist;
192     double aDepth = HYDROData_ProfileUZ::GetDepthFromDistance( aProfilePoints, aParLen );
193
194     Polyline3DPoint aCompPoint( aPolylinePoint.X(), aPolylinePoint.Y(), aDepth );
195     aResPoints.Append( aCompPoint );
196   }
197
198   // Add last point as is
199   aResPoints.Append( Polyline3DPoint( aLastPoint.X(), aLastPoint.Y(), aLastParPoint.Y() ) );
200
201   TopoDS_Wire aResWire = HYDROData_PolylineXY::BuildWire( aSectionType, anIsSectionClosed, aResPoints );
202   SetTopShape( aResWire );
203   SetShape3D( aResWire );
204
205
206 QColor HYDROData_Polyline3D::DefaultFillingColor() const
207 {
208   return QColor( Qt::transparent );
209 }
210
211 QColor HYDROData_Polyline3D::DefaultBorderColor() const
212 {
213   return QColor( Qt::red );
214 }
215
216 bool HYDROData_Polyline3D::SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline,
217                                           const bool                          theIsUpdateProfile )
218 {
219   if ( thePolyline.IsNull() )
220     return false;
221   
222   Handle(HYDROData_PolylineXY) aPrevPolyline = GetPolylineXY();
223   if ( IsEqual( aPrevPolyline, thePolyline ) )
224     return true;
225
226   SetReferenceObject( thePolyline, DataTag_PolylineXY );
227
228   // Update the child profile object 
229   if ( theIsUpdateProfile )
230     updateChildProfilePoints();
231
232   // Indicate model of the need to update the polyline presentation
233   Changed( Geom_2d );
234
235   return true;
236 }
237
238 Handle(HYDROData_PolylineXY) HYDROData_Polyline3D::GetPolylineXY() const
239 {
240   return Handle(HYDROData_PolylineXY)::DownCast( 
241            GetReferenceObject( DataTag_PolylineXY ) );
242 }
243
244 void HYDROData_Polyline3D::RemovePolylineXY()
245 {
246   Handle(HYDROData_PolylineXY) aPrevPolyline = GetPolylineXY();
247   if ( aPrevPolyline.IsNull() )
248     return;
249
250   ClearReferenceObjects( DataTag_PolylineXY );
251
252   // Indicate model of the need to update the polyline presentation
253   Changed( Geom_2d );
254 }
255
256 bool HYDROData_Polyline3D::SetProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile )
257 {
258   if ( theProfile.IsNull() )
259     return false;
260   
261   Handle(HYDROData_ProfileUZ) aPrevProfile = GetProfileUZ();
262   if ( IsEqual( aPrevProfile, theProfile ) )
263     return true;
264
265   SetReferenceObject( theProfile, DataTag_ProfileUZ );
266
267   // Remove the bathymetry, because one altitude object can be presented at time
268   RemoveAltitudeObject();
269
270   // Indicate model of the need to update the polyline presentation
271   Changed( Geom_Z );
272
273   return true;
274 }
275
276 Handle(HYDROData_ProfileUZ) HYDROData_Polyline3D::GetProfileUZ() const
277 {
278   return Handle(HYDROData_ProfileUZ)::DownCast( 
279            GetReferenceObject( DataTag_ProfileUZ ) );
280 }
281
282 void HYDROData_Polyline3D::RemoveProfileUZ()
283 {
284   Handle(HYDROData_ProfileUZ) aPrevProfile = GetProfileUZ();
285   if ( aPrevProfile.IsNull() )
286     return;
287
288   ClearReferenceObjects( DataTag_ProfileUZ );
289
290   // Indicate model of the need to update the polyline presentation
291   Changed( Geom_Z );
292 }
293
294 bool HYDROData_Polyline3D::SetAltitudeObject( 
295   const Handle(HYDROData_IAltitudeObject)& theAltitude )
296 {
297   Handle(HYDROData_IAltitudeObject) aPrevAltitude = GetAltitudeObject();
298
299   if ( !HYDROData_Object::SetAltitudeObject( theAltitude ) )
300     return false;
301
302   if ( IsEqual( aPrevAltitude, theAltitude ) )
303     return true;
304
305   // Remove the u,z profile, because one altitude object can be presented at time
306   RemoveProfileUZ();
307
308   // Create the child profile object 
309   updateChildProfilePoints();
310
311   return true;
312 }
313
314
315 void HYDROData_Polyline3D::RemoveAltitudeObject()
316 {
317   HYDROData_Object::RemoveAltitudeObject();
318
319   // Remove the child profile object 
320   removeChildProfileUZ();
321 }
322
323 Handle(HYDROData_ProfileUZ) HYDROData_Polyline3D::GetChildProfileUZ( const bool theIsCreate ) const
324 {
325   Handle(HYDROData_ProfileUZ) aProfileUZ =
326     Handle(HYDROData_ProfileUZ)::DownCast( GetReferenceObject( DataTag_ChildProfileUZ ) );
327   if ( !theIsCreate || !aProfileUZ.IsNull() )
328     return aProfileUZ;
329
330   Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
331   if ( aDocument.IsNull() )
332     return aProfileUZ;
333
334   Handle(HYDROData_Profile) aProfile =
335     Handle(HYDROData_Profile)::DownCast( aDocument->CreateObject( KIND_PROFILE ) );
336   
337   QString aProfilePref = GetName() + "_Profile";
338   QString aProfileName = HYDROData_Tool::GenerateObjectName( aDocument, aProfilePref );
339
340   aProfile->SetName( aProfileName );
341
342   aProfileUZ = aProfile->GetProfileUZ();
343
344   HYDROData_Polyline3D* me = const_cast<HYDROData_Polyline3D*>( this ); // Temporary to be revised
345   me->SetChildProfileUZ( aProfileUZ );
346
347   return aProfileUZ;
348 }
349
350 void HYDROData_Polyline3D::SetChildProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile )
351 {
352   SetReferenceObject( theProfile, DataTag_ChildProfileUZ );
353 }
354
355 HYDROData_IPolyline::PointsList generateProfileUZPoints(
356   const Handle(HYDROData_PolylineXY)&      thePolyline,
357   const Handle(HYDROData_IAltitudeObject)& theAltitude )
358 {
359   HYDROData_IPolyline::PointsList aPointsList;
360   if ( thePolyline.IsNull() || theAltitude.IsNull() )
361     return aPointsList;
362
363   bool anIsSectionClosed = thePolyline->IsClosedSection( 0 );
364   HYDROData_IPolyline::SectionType aSectionType = thePolyline->GetSectionType( 0 );
365   HYDROData_IPolyline::PointsList aPolylinePoints = thePolyline->GetPoints( 0 );
366   if ( aPolylinePoints.IsEmpty() )
367     return aPointsList;
368
369   for ( int i = 1, aNbPoints = aPolylinePoints.Size(); i <= aNbPoints; ++i )
370   {
371     const HYDROData_PolylineXY::Point& aSectPoint = aPolylinePoints.Value( i );
372
373     double aPointDistance = thePolyline->GetDistance( 0, i - 1 );
374     double aPointDepth = theAltitude->GetAltitudeForPoint( aSectPoint );
375     if( aPointDepth == theAltitude->GetInvalidAltitude() )
376       aPointDepth = 0.0;
377
378     HYDROData_IPolyline::Point anAltitudePoint( aPointDistance, aPointDepth );
379     aPointsList.Append( anAltitudePoint );
380   }
381
382   return aPointsList;
383 }
384
385 void HYDROData_Polyline3D::updateChildProfilePoints()
386 {
387   Handle(HYDROData_IAltitudeObject) anAltitude = GetAltitudeObject();
388   if ( anAltitude.IsNull() )
389     return;
390
391   Handle(HYDROData_ProfileUZ) aChildProfileUZ = GetChildProfileUZ();
392   if ( aChildProfileUZ.IsNull() )
393     return;
394
395   Handle(HYDROData_Profile) aProfile = 
396     Handle(HYDROData_Profile)::DownCast( aChildProfileUZ->GetFatherObject() );
397   if ( aProfile.IsNull() )
398     return;
399
400   HYDROData_IPolyline::PointsList aProfilePoints = 
401     generateProfileUZPoints( GetPolylineXY(), anAltitude );
402   aProfile->SetParametricPoints( aProfilePoints );
403
404   aProfile->Update();
405 }
406
407 void HYDROData_Polyline3D::removeChildProfileUZ()
408 {
409   Handle(HYDROData_ProfileUZ) aChildProfileUZ = GetChildProfileUZ( false );
410   if ( aChildProfileUZ.IsNull() )
411     return;
412
413   ClearReferenceObjects( DataTag_ChildProfileUZ );
414
415   /* Uncomment if removing is requested
416   Handle(HYDROData_Profile) aProfile = 
417     Handle(HYDROData_Profile)::DownCast( aChildProfileUZ->GetFatherObject() );
418   if ( !aProfile.IsNull() )
419     aProfile->Remove();
420   */
421 }
422
423 HYDROData_Polyline3D::Polyline3DPoints HYDROData_Polyline3D::GetPoints( double theEqDistance ) const
424 {
425   Polyline3DPoints aPoints;
426
427   Handle(HYDROData_PolylineXY) aPolylineXY = GetPolylineXY();
428   TopoDS_Wire aWire = TopoDS::Wire( GetShape3D() );
429   if ( aPolylineXY.IsNull() || aWire.IsNull() ) {
430     return aPoints; 
431   }
432
433   // Explode polyline on edges
434   TopTools_SequenceOfShape anEdges;
435   HYDROData_ShapesTool::ExploreShapeToShapes( aWire, TopAbs_EDGE, anEdges );
436
437   // Get points
438   if ( !anEdges.IsEmpty() ) {
439     HYDROData_IPolyline::SectionType aSectionType = aPolylineXY->GetSectionType( 0 );
440     
441     if ( aSectionType == HYDROData_IPolyline::SECTION_POLYLINE ) {
442       // Get points from wire
443       /* Seems that intermediate vertices are duplicated
444       TopExp_Explorer anExp( aWire, TopAbs_VERTEX );
445       for ( ; anExp.More(); anExp.Next() ) {
446         TopoDS_Vertex aVertex = TopoDS::Vertex( anExp.Current() );
447         if ( !aVertex.IsNull() ) {
448           gp_Pnt aPnt = BRep_Tool::Pnt( aVertex );
449           aPoints.Append( aPnt.XYZ() );
450         }
451       }
452       */
453       TopExp_Explorer anExp( aWire, TopAbs_EDGE );
454       bool isFirst = true;
455       for ( ; anExp.More(); anExp.Next() ) {
456         TopoDS_Edge anEdge = TopoDS::Edge( anExp.Current() );
457         if ( !anEdge.IsNull() ) {
458           TopoDS_Vertex aV1, aV2;
459           TopExp::Vertices( anEdge, aV1, aV2 );
460           if ( isFirst ) {
461             gp_Pnt aPnt1 = BRep_Tool::Pnt( aV1 );
462             aPoints.Append( aPnt1.XYZ() );
463           }
464
465           gp_Pnt aPnt2 = BRep_Tool::Pnt( aV2 );
466           aPoints.Append( aPnt2.XYZ() );
467
468           isFirst = false;
469         }
470       }
471     } else {
472       // Get points from spline curve
473       Standard_Real aStart, anEnd;
474       TopoDS_Edge anEdge = TopoDS::Edge( anEdges.First() );
475       Handle(Geom_Curve) aCurve = BRep_Tool::Curve( anEdge, aStart, anEnd );
476
477       if( theEqDistance > 0 )
478       {
479         GeomAdaptor_Curve anAdaptorCurve( aCurve );
480         double aLength = GCPnts_AbscissaPoint::Length( anAdaptorCurve );
481         int aNbPoints = ceil( aLength / theEqDistance );
482         GCPnts_QuasiUniformAbscissa aDist( anAdaptorCurve, aNbPoints );
483         if( aDist.IsDone() )
484         {
485           aNbPoints = aDist.NbPoints();
486           for( int i=1; i<=aNbPoints; i++ )
487           {
488             double p = aDist.Parameter( i );
489             gp_Pnt aPnt;
490             aCurve->D0( p, aPnt );
491             aPoints.Append( aPnt.XYZ() );
492           }
493           return aPoints;
494         }
495       }
496
497       Handle(Geom_BSplineCurve) aGeomSpline = Handle(Geom_BSplineCurve)::DownCast( aCurve );
498
499       if ( !aGeomSpline.IsNull() ) {
500         int aNbKnots = aGeomSpline->NbKnots();
501
502         TColStd_Array1OfReal aSplineKnots( 1, aNbKnots );
503         aGeomSpline->Knots( aSplineKnots );
504
505         for ( int i = 1; i <= aNbKnots; ++i ) {
506           const Standard_Real& aKnot = aSplineKnots.Value( i );
507           gp_Pnt aPnt;
508           aGeomSpline->D0( aKnot, aPnt );
509           aPoints.Append( aPnt.XYZ() );
510         }
511       }
512     }
513   }
514
515   return aPoints; 
516 }
517