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