]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Region.cxx
Salome HOME
Merge branch 'BR_v14_rc' into BR_SINUSX_FORMAT
[modules/hydro.git] / src / HYDROData / HYDROData_Region.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_Region.h"
20
21 #include "HYDROData_CalculationCase.h"
22 #include "HYDROData_Document.h"
23 #include "HYDROData_Iterator.h"
24 #include "HYDROData_Object.h"
25 #include "HYDROData_ShapesTool.h"
26 #include "HYDROData_Zone.h"
27 #include "HYDROData_Tool.h"
28
29 #include <TopoDS.hxx>
30 #include <TopoDS_Shape.hxx>
31 #include <TopoDS_Shell.hxx>
32 #include <TopoDS_Face.hxx>
33
34 #include <TopExp.hxx>
35
36 #include <TopTools_ListOfShape.hxx>
37 #include <TopTools_SequenceOfShape.hxx>
38 #include <TopTools_ListIteratorOfListOfShape.hxx>
39 #include <TopTools_IndexedMapOfShape.hxx>
40
41 #include <BRep_Builder.hxx>
42 #include <BRepAlgoAPI_Fuse.hxx>
43
44 #include <ShapeUpgrade_UnifySameDomain.hxx>
45
46 #include <QStringList>
47
48 //#define DEB_GET_REGION_SHAPE
49
50 IMPLEMENT_STANDARD_HANDLE(HYDROData_Region, HYDROData_Entity)
51 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Region, HYDROData_Entity)
52
53
54 HYDROData_Region::HYDROData_Region()
55  : HYDROData_Entity()
56 {
57 }
58
59 HYDROData_Region::~HYDROData_Region()
60 {
61 }
62
63 bool HYDROData_Region::CanBeUpdated() const
64 {
65   return false;
66 }
67
68 void HYDROData_Region::Remove()
69 {
70   Handle(HYDROData_CalculationCase) aFatherCalc = 
71     Handle(HYDROData_CalculationCase)::DownCast( GetFatherObject() );
72
73   HYDROData_Entity::Remove();
74
75   if ( !aFatherCalc.IsNull() )
76     aFatherCalc->UpdateRegionsOrder();
77 }
78
79 bool HYDROData_Region::CanRemove()
80 {
81   return false;
82 }
83
84 HYDROData_SequenceOfObjects HYDROData_Region::GetAllReferenceObjects() const
85 {
86   HYDROData_SequenceOfObjects aResSeq = HYDROData_Entity::GetAllReferenceObjects();
87
88   HYDROData_SequenceOfObjects aSeqOfZones = GetZones();
89   aResSeq.Append( aSeqOfZones );
90
91   return aResSeq;
92 }
93
94 bool HYDROData_Region::AddZone( const Handle(HYDROData_Zone)& theZone )
95 {
96   Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
97
98   if ( theZone.IsNull() )
99     return false;
100   
101   if ( HasReference( theZone, DataTag_Zone ) )
102     return false; // Object is already in reference list
103
104   // Move the zone from other region
105   Handle(HYDROData_Region) aFatherRegion = 
106     Handle(HYDROData_Region)::DownCast( theZone->GetFatherObject() );
107   if ( !aFatherRegion.IsNull() && aFatherRegion->Label() != myLab )
108   {
109     Handle(HYDROData_Zone) aNewZone = addNewZone( aDocument, "", TopoDS_Face(), QStringList() );
110     theZone->CopyTo( aNewZone );
111
112     // To prevent changing of stored shape
113     aNewZone->SetShape( theZone->GetShape() );
114
115     aFatherRegion->RemoveZone( theZone );
116
117     theZone->SetLabel( aNewZone->Label() );
118   }
119   else
120   {
121     AddReferenceObject( theZone, DataTag_Zone );
122   }
123
124   return true;
125 }
126
127 HYDROData_SequenceOfObjects HYDROData_Region::GetZones() const
128 {
129   return GetReferenceObjects( DataTag_Zone );
130 }
131
132 void HYDROData_Region::RemoveZone( const Handle(HYDROData_Zone)& theZone )
133 {
134   if ( theZone.IsNull() )
135     return;
136
137   RemoveReferenceObject( theZone->Label(), DataTag_Zone );
138
139   // Remove zone from data model
140   Handle(HYDROData_Region) aFatherRegion = 
141     Handle(HYDROData_Region)::DownCast( theZone->GetFatherObject() );
142   if ( !aFatherRegion.IsNull() && aFatherRegion->Label() == myLab )
143     theZone->Remove();
144
145   // If the last zone has been removed from region we remove this region
146   HYDROData_SequenceOfObjects aRefZones = GetZones();
147   if ( aRefZones.IsEmpty() )
148     Remove();
149 }
150
151 void HYDROData_Region::RemoveZones()
152 {
153   ClearReferenceObjects( DataTag_Zone );
154   myLab.FindChild( DataTag_ChildZone ).ForgetAllAttributes( true );
155 }
156
157 Handle(HYDROData_Zone) HYDROData_Region::addNewZone( const Handle(HYDROData_Document)& theDoc,
158                                                      const QString& thePrefix,
159                                                      const TopoDS_Face& theFace,
160                                                      const QStringList& theRefObjects )
161 {
162   TDF_Label aNewLab = myLab.FindChild( DataTag_ChildZone ).NewChild();
163
164   Handle(HYDROData_Zone) aNewZone =
165     Handle(HYDROData_Zone)::DownCast( HYDROData_Iterator::CreateObject( aNewLab, KIND_ZONE ) );
166   AddZone( aNewZone );
167
168   QString aZoneName = HYDROData_Tool::GenerateObjectName( theDoc, thePrefix );
169   aNewZone->SetName( aZoneName );
170
171   aNewZone->SetShape( theFace );
172
173   // Add the reference object for zone
174   for ( int i = 0, n = theRefObjects.length(); i < n; ++i )
175   {
176     const QString& anObjName = theRefObjects.at( i );
177     Handle(HYDROData_Object) aRefObject = 
178       Handle(HYDROData_Object)::DownCast( theDoc->FindObjectByName( anObjName ) );
179     if ( aRefObject.IsNull() )
180       continue;
181
182     aNewZone->AddGeometryObject( aRefObject );
183   }
184
185   return aNewZone;
186 }
187
188 void getUsedGroups( const TopoDS_Shape&                     theShape,
189                     HYDROData_ShapesGroup::SeqOfGroupsDefs& theOriGroups,
190                     HYDROData_ShapesGroup::SeqOfGroupsDefs& theUsedGroups )
191 {
192 #ifdef DEB_GET_REGION_SHAPE
193   HYDROData_ShapesTool::DumpShapeSubShapes( std::cout, "Zone face edges:", theShape, TopAbs_EDGE );
194 #endif
195
196   TopTools_IndexedMapOfShape aMapOfSubShapes;
197   TopExp::MapShapes( theShape, TopAbs_EDGE, aMapOfSubShapes );
198
199   HYDROData_ShapesGroup::SeqOfGroupsDefs::Iterator anIter( theOriGroups );
200   for ( ; anIter.More(); anIter.Next() )
201   {
202     HYDROData_ShapesGroup::GroupDefinition& anOriGroupDef = anIter.ChangeValue();
203     if ( anOriGroupDef.Shapes.IsEmpty() )
204       continue;
205
206     for ( int i = 1; i <= anOriGroupDef.Shapes.Length(); ++i )
207     {
208       TopoDS_Shape aGroupEdge = anOriGroupDef.Shapes.Value( i );
209       
210       int aShapeIndex = aMapOfSubShapes.FindIndex( aGroupEdge );
211       if ( aShapeIndex <= 0 )
212         continue;
213
214       anOriGroupDef.Shapes.Remove( i );
215       --i;
216
217       bool anIsAdded = false;
218
219       HYDROData_ShapesGroup::SeqOfGroupsDefs::Iterator aUsedIter( theUsedGroups );
220       for ( ; aUsedIter.More(); aUsedIter.Next() )
221       {
222         HYDROData_ShapesGroup::GroupDefinition& aUsedGroupDef = aUsedIter.ChangeValue();
223         if ( aUsedGroupDef.Name != anOriGroupDef.Name )
224           continue;
225
226         aUsedGroupDef.Shapes.Append( aGroupEdge );
227         anIsAdded = true;
228         break;
229       }
230
231       if ( !anIsAdded )
232       {
233         HYDROData_ShapesGroup::GroupDefinition aUsedGroupDef;
234         aUsedGroupDef.Name = anOriGroupDef.Name;
235         aUsedGroupDef.Shapes.Append( aGroupEdge );
236         theUsedGroups.Append( aUsedGroupDef );
237       }
238     }
239   }
240 }
241
242 TopoDS_Shape HYDROData_Region::GetShape( HYDROData_ShapesGroup::SeqOfGroupsDefs* theSeqOfGroups ) const
243 {
244   HYDROData_ShapesGroup::SeqOfGroupsDefs aSeqOfGroups;
245   HYDROData_ShapesGroup::SeqOfGroupsDefs aSeqOfUsedGroups;
246   if ( theSeqOfGroups )
247     aSeqOfGroups = *theSeqOfGroups;
248
249 #ifdef DEB_GET_REGION_SHAPE
250   HYDROData_ShapesGroup::GroupDefinition::Dump( std::cout, aSeqOfGroups );
251 #endif
252
253   TopoDS_Shape aResShape;
254
255   // Unite the region zones (each zone is a face) into one face (united face)
256   // If the zones can't be united into the single face - unite them into shell
257
258   // Collect the list of region faces
259   TopTools_ListOfShape aRegionFacesList;
260
261   HYDROData_SequenceOfObjects aZones = GetZones();
262   HYDROData_SequenceOfObjects::Iterator aZoneIter( aZones );
263   for ( ; aZoneIter.More(); aZoneIter.Next() )
264   {
265     Handle(HYDROData_Zone) aZone =
266       Handle(HYDROData_Zone)::DownCast( aZoneIter.Value() );
267     if ( aZone.IsNull() )
268       continue;
269
270     TopoDS_Shape aZoneShape = aZone->GetShape();
271     if ( aZoneShape.IsNull() || aZoneShape.ShapeType() != TopAbs_FACE )
272       continue;
273
274     TopoDS_Face aZoneFace = TopoDS::Face( aZoneShape );
275     aRegionFacesList.Append( aZoneFace );
276
277     getUsedGroups( aZoneFace, aSeqOfGroups, aSeqOfUsedGroups );
278   } // zones iterator
279   
280   if ( aRegionFacesList.IsEmpty() )
281     return aResShape;
282
283   // The unite region face
284   TopoDS_Face aRegionFace;
285
286   if ( aRegionFacesList.Extent() == 1 )
287   {
288     aRegionFace = TopoDS::Face( aRegionFacesList.First() );
289   }
290   else
291   {
292 #ifdef DEB_GET_REGION_SHAPE
293     HYDROData_ShapesGroup::GroupDefinition::Dump( std::cout, aSeqOfUsedGroups );
294 #endif
295
296     // Try to fuse all region faces into one common face
297     TopoDS_Shape aFuseShape;
298     TopTools_ListIteratorOfListOfShape aFaceIter( aRegionFacesList );
299     for ( ; aFaceIter.More(); aFaceIter.Next() )
300     {
301       if ( aFuseShape.IsNull() )
302       {
303         aFuseShape = aFaceIter.Value();
304         continue;
305       }
306
307       BRepAlgoAPI_Fuse aFuse( aFuseShape, aFaceIter.Value() );
308       if ( !aFuse.IsDone() )
309       {
310         aFuseShape.Nullify();
311         break;
312       }
313
314       aFuseShape = aFuse.Shape();
315       HYDROData_ShapesGroup::GroupDefinition::Update( &aSeqOfUsedGroups, &aFuse );
316     } // faces iterator
317
318 #ifdef DEB_GET_REGION_SHAPE
319     HYDROData_ShapesTool::DumpShapeSubShapes( std::cout, "Fused face edges:", aFuseShape, TopAbs_EDGE );
320 #endif
321
322     // Check the result of fuse operation
323     if ( !aFuseShape.IsNull() )
324     {
325       ShapeUpgrade_UnifySameDomain anUnifier( aFuseShape );
326       anUnifier.Build();
327
328       const TopoDS_Shape& anUnitedShape = anUnifier.Shape();
329
330       TopTools_SequenceOfShape aShapeFaces;
331       HYDROData_ShapesTool::ExploreShapeToShapes( anUnitedShape, TopAbs_FACE, aShapeFaces );
332       if ( aShapeFaces.Length() == 1 )
333       {
334         aRegionFace = TopoDS::Face( aShapeFaces.Value( 1 ) );
335
336 #ifdef DEB_GET_REGION_SHAPE
337         HYDROData_ShapesTool::DumpShapeSubShapes( std::cout, "Result face edges:", aRegionFace, TopAbs_EDGE );
338 #endif
339
340         HYDROData_ShapesGroup::GroupDefinition::Update( &aSeqOfUsedGroups, &anUnifier );
341
342         // Update the sequence of groups
343         if ( theSeqOfGroups )
344         {
345           HYDROData_ShapesGroup::SeqOfGroupsDefs::Iterator aUsedIter( aSeqOfUsedGroups );
346           for ( ; aUsedIter.More(); aUsedIter.Next() )
347           {
348             const HYDROData_ShapesGroup::GroupDefinition& aUsedGroupDef = aUsedIter.Value();
349             if ( aUsedGroupDef.Shapes.IsEmpty() )
350               continue;
351
352             HYDROData_ShapesGroup::SeqOfGroupsDefs::Iterator anOriIter( aSeqOfGroups );
353             for ( ; anOriIter.More(); anOriIter.Next() )
354             {
355               HYDROData_ShapesGroup::GroupDefinition& anOriGroupDef = anOriIter.ChangeValue();
356               if ( anOriGroupDef.Name != aUsedGroupDef.Name )
357                 continue;
358
359               HYDROData_ShapesTool::AddShapes( anOriGroupDef.Shapes, aUsedGroupDef.Shapes );
360               break;
361             }
362           }
363
364           *theSeqOfGroups = aSeqOfGroups;
365         }
366       }
367     }
368   }
369
370   if ( !aRegionFace.IsNull() )
371   {
372     // result shape is a face
373     aResShape = aRegionFace;
374   }
375   else
376   {
377     // result shape is a shell
378     TopoDS_Shell aShell;
379     BRep_Builder aBuilder;
380     aBuilder.MakeShell( aShell );
381
382     TopTools_ListIteratorOfListOfShape aFaceIter( aRegionFacesList );
383     for ( ; aFaceIter.More(); aFaceIter.Next() )
384       aBuilder.Add( aShell, aFaceIter.Value() );
385
386     aResShape = aShell;
387   }
388   
389   return aResShape;
390 }
391
392 QStringList HYDROData_Region::DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const
393 {
394   QStringList aResList;
395
396   // Find region
397   findPythonReferenceObject( theTreatedObjects, aResList );
398
399   // Add zones
400   HYDROData_SequenceOfObjects aZones = GetZones();
401   HYDROData_SequenceOfObjects::Iterator aZonesIter( aZones );
402   for ( ; aZonesIter.More(); aZonesIter.Next() ) {
403     Handle(HYDROData_Zone) aZone =
404       Handle(HYDROData_Zone)::DownCast( aZonesIter.Value() );
405     if ( aZone.IsNull() ) {
406       continue;
407     }
408     
409     // find zone
410     aZone->findPythonReferenceObject( theTreatedObjects, aResList );
411     theTreatedObjects.insert( aZone->GetName(), aZone );
412     
413     // set zone merge type
414     QString aMergeTypeStr;
415     HYDROData_Zone::MergeAltitudesType aMergeType = aZone->GetMergeType();
416     if ( aMergeType == HYDROData_Zone::Merge_ZMIN ) {
417       aMergeTypeStr = "HYDROData_Zone.Merge_ZMIN";
418     } else if ( aMergeType == HYDROData_Zone::Merge_ZMAX ) {
419       aMergeTypeStr = "HYDROData_Zone.Merge_ZMAX";
420     } else if ( aMergeType == HYDROData_Zone::Merge_Object ) {
421       aMergeTypeStr = "HYDROData_Zone.Merge_Object";
422     }
423
424     if ( !aMergeTypeStr.isEmpty() ) {
425       aResList << QString( "%1.SetMergeType( %2 )" ).arg( aZone->GetObjPyName() ).arg( aMergeTypeStr );
426     }
427     if ( aMergeType == HYDROData_Zone::Merge_Object ) {
428       Handle(HYDROData_IAltitudeObject) aMergeAltitude = aZone->GetMergeAltitude();
429       if ( !aMergeAltitude.IsNull() ) {
430         aMergeAltitude->findPythonReferenceObject( theTreatedObjects, aResList );
431         aResList << QString( "%1.SetMergeAltitude( %2 )" ).arg( aZone->GetObjPyName() )
432                                                           .arg( aMergeAltitude->GetObjPyName() );
433       }
434     }
435
436     // add zone
437     setPythonReferenceObject( theTreatedObjects, aResList, aZone, "AddZone" );
438   }
439
440   return aResList;
441 }
442
443 bool HYDROData_Region::IsSubmersible() const
444 {
445   HYDROData_SequenceOfObjects aZones = GetZones();
446   HYDROData_SequenceOfObjects::Iterator aZonesIter( aZones );
447   for ( ; aZonesIter.More(); aZonesIter.Next() )
448   {
449     Handle(HYDROData_Zone) aZone =
450       Handle(HYDROData_Zone)::DownCast( aZonesIter.Value() );
451     if ( !aZone->IsSubmersible() )
452       return false; //if one of zones is not submersible the region is considered as not submersible
453   }
454   return true;
455 }