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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #include <HYDROData_LandCoverMap.h>
20 #include <HYDROData_Object.h>
21 #include <HYDROData_PolylineXY.h>
22 #include <HYDROData_Tool.h>
23 #include <HYDROData_ShapeFile.h>
25 #include <BOPAlgo_BOP.hxx>
26 #include <BOPAlgo_Builder.hxx>
27 #include <BOPAlgo_PaveFiller.hxx>
28 #include <BOPCol_ListOfShape.hxx>
29 #include <BRep_Builder.hxx>
30 #include <BRepAdaptor_Curve.hxx>
31 #include <BRepAlgoAPI_Fuse.hxx>
32 #include <BRepBuilderAPI_MakeFace.hxx>
33 #include <GCPnts_QuasiUniformDeflection.hxx>
34 #include <NCollection_IndexedMap.hxx>
36 #include <TopoDS_Compound.hxx>
37 #include <TopoDS_Edge.hxx>
38 #include <TopoDS_Face.hxx>
39 #include <TopoDS_Iterator.hxx>
40 #include <TopoDS_Shell.hxx>
41 #include <TopExp_Explorer.hxx>
42 #include <TopTools_ListIteratorOfListOfShape.hxx>
43 #include <BOPAlgo_PaveFiller.hxx>
44 #include <BRepTools.hxx>
45 #include <TopExp_Explorer.hxx>
46 #include <ShapeUpgrade_UnifySameDomain.hxx>
50 #include <QTextStream>
52 const char TELEMAC_FORMAT = 'f';
53 const int TELEMAC_PRECISION = 3;
56 IMPLEMENT_STANDARD_HANDLE(HYDROData_LandCoverMap, HYDROData_Entity)
57 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_LandCoverMap, HYDROData_Entity)
59 class HYDROData_MapOfFaceToStricklerType : public NCollection_IndexedDataMap<TopoDS_Face, QString>
65 @param theMap the land cover map to iterate through
67 HYDROData_LandCoverMap::Iterator::Iterator( const HYDROData_LandCoverMap& theMap )
72 HYDROData_LandCoverMap::Iterator::Iterator( const Handle( HYDROData_LandCoverMap )& theMap )
84 Initialize the iterator
85 @param theMap the land cover map to iterate through
87 void HYDROData_LandCoverMap::Iterator::Init( const HYDROData_LandCoverMap& theMap )
89 TopoDS_Shape aShape = theMap.GetShape();
93 myIterator = new TopoDS_Iterator( aShape );
95 theMap.myLab.FindChild( DataTag_Types ).FindAttribute( TDataStd_ExtStringArray::GetID(), myArray );
96 if( myArray.IsNull() )
99 myIndex = myArray->Lower();
105 HYDROData_LandCoverMap::Iterator::~Iterator()
111 Return the current 0-based index of the iterator
112 @return the current index
114 int HYDROData_LandCoverMap::Iterator::Index() const
116 if( myArray.IsNull() )
119 return myIndex - myArray->Lower();
123 Return if the iterator has more elements
124 @return if the iterator has more elements
126 bool HYDROData_LandCoverMap::Iterator::More() const
128 return !myArray.IsNull() && myIterator && myIterator->More();
132 Move iterator to the next element
134 void HYDROData_LandCoverMap::Iterator::Next()
144 Get the current land cover (face)
145 @return the land cover's face
147 TopoDS_Face HYDROData_LandCoverMap::Iterator::Face() const
150 return TopoDS::Face( myIterator->Value() );
152 return TopoDS_Face();
156 Get the current land cover's Strickler type
157 @return the land cover's Strickler type
159 QString HYDROData_LandCoverMap::Iterator::StricklerType() const
161 if( myArray.IsNull() || myIndex < myArray->Lower() || myIndex > myArray->Upper() )
164 return HYDROData_Tool::toQString( myArray->Value( myIndex ) );
168 Set the Strickler type for the current land cover
169 @param theType the Strickler type
171 void HYDROData_LandCoverMap::Iterator::SetStricklerType( const QString& theType )
173 if( myArray.IsNull() || myIndex < myArray->Lower() || myIndex > myArray->Upper() )
176 myArray->SetValue( myIndex, HYDROData_Tool::toExtString( theType ) );
182 HYDROData_LandCoverMap::HYDROData_LandCoverMap()
183 : HYDROData_Entity( Geom_No )
190 HYDROData_LandCoverMap::~HYDROData_LandCoverMap()
196 @return object's kind
198 const ObjectKind HYDROData_LandCoverMap::GetKind() const
200 return KIND_LAND_COVER_MAP;
204 Load attributes from DBF File
207 HYDROData_LandCoverMap::DBFStatus HYDROData_LandCoverMap::ImportDBF( const QString& theDBFFileName,
208 const QString& theFieldName,
209 const QStringList& theDBFValues,
210 const QStringList& theStricklerTypes,
211 QMap<int, int> theIndices )
213 HYDROData_ShapeFile aDBFImporter;
214 if (aDBFImporter.DBF_OpenDBF(theDBFFileName))
215 return DBFStatus_OPEN_FILE_ERROR; //cant open file
217 QStringList FieldList = aDBFImporter.DBF_GetFieldList();
218 int FieldNameIndex = FieldList.indexOf(theFieldName);
219 if (FieldNameIndex == -1)
220 return DBFStatus_NO_SUCH_FIELD_ERROR; //no such field
222 std::vector<HYDROData_ShapeFile::DBF_AttrValue> theAttrV;
223 aDBFImporter.DBF_GetAttributeList(FieldNameIndex, theAttrV );
226 Iterator anIt( *this );
227 for( ; anIt.More(); anIt.Next() )
229 int CurIndex = anIt.Index();
230 HYDROData_ShapeFile::DBF_AttrValue AValue = theAttrV[theIndices[CurIndex]];
231 int StricklerTypesInd = theDBFValues.indexOf(QString(AValue.myStrVal));
232 if ( StricklerTypesInd != -1)
233 anIt.SetStricklerType(theDBFValues[StricklerTypesInd]);
240 return DBFStatus_NO_DBFVALUES_CORRESPONDENCE_WARNING;
244 Export attributes to DBF File
247 void HYDROData_LandCoverMap::ExportDBF( const QString& theDBFFileName,
248 const QString& theFieldName,
249 const QStringList& theDBFValues,
250 const QStringList& theStricklerTypes) const
252 HYDROData_ShapeFile anExporter;
253 std::vector<HYDROData_ShapeFile::DBF_AttrValue> theAttrV;
254 Iterator anIt( *this );
255 for( ; anIt.More(); anIt.Next() )
257 QString CurST = anIt.StricklerType();
258 HYDROData_ShapeFile::DBF_AttrValue aCurAttrV;
259 aCurAttrV.myIsNull = false;
260 int StricklerTypesInd = theStricklerTypes.indexOf(CurST);
261 if (StricklerTypesInd != -1)
263 aCurAttrV.myStrVal = theDBFValues[StricklerTypesInd];
264 aCurAttrV.myFieldType = HYDROData_ShapeFile::DBF_FieldType_String;
265 theAttrV.push_back(aCurAttrV);
268 aCurAttrV.myIsNull = true;
271 anExporter.DBF_WriteFieldAndValues(theDBFFileName, theFieldName, HYDROData_ShapeFile::DBF_FieldType_String, theAttrV, true);
275 int HashCode( const gp_Pnt& thePoint, const Standard_Integer theUpper )
277 int aHashX = HashCode( thePoint.X(), theUpper );
278 int aHashY = HashCode( thePoint.Y(), theUpper );
279 return (aHashX^aHashY)%theUpper;
282 bool operator == ( const gp_Pnt& thePoint1, const gp_Pnt& thePoint2 )
284 return thePoint1.IsEqual( thePoint2, Precision::Confusion() );
287 bool EdgeDiscretization( const TopoDS_Edge& theEdge,
288 Standard_Real theDeflection,
289 NCollection_IndexedMap<gp_Pnt>& theVerticesMap,
290 QList<int>& theVerticesIds )
292 BRepAdaptor_Curve aCurve( theEdge );
293 GCPnts_QuasiUniformDeflection aDiscrete( aCurve, theDeflection );
294 if( !aDiscrete.IsDone() )
297 int n = aDiscrete.NbPoints();
298 for( int i=1; i<=n; i++ )
300 gp_Pnt aPnt = aDiscrete.Value( i );
302 if( theVerticesMap.Contains( aPnt ) )
303 anId = theVerticesMap.FindIndex( aPnt );
306 anId = theVerticesMap.Size();
307 theVerticesMap.Add( aPnt );
309 theVerticesIds.append( anId );
315 Export the land cover map for the solver (Telemac)
316 @param theFileName the name of file
317 @return if the export is successful
319 bool HYDROData_LandCoverMap::ExportTelemac( const QString& theFileName, Standard_Real theDeflection ) const
321 TopoDS_Shape aLandCoverMapShape = GetShape();
322 TopTools_ListOfShape aListOfFaces;
323 TopExp_Explorer anExp( aLandCoverMapShape, TopAbs_FACE );
324 for( ; anExp.More(); anExp.Next() )
325 aListOfFaces.Append( anExp.Current() );
327 TopoDS_Shape aShape = MergeFaces( aListOfFaces, false );
329 NCollection_IndexedMap<gp_Pnt> aVerticesMap;
330 NCollection_IndexedDataMap< TopoDS_Edge, QList<int> > anEdgesMap;
331 NCollection_IndexedDataMap< TopoDS_Face, QList<int> > aFacesMap;
333 // add into the map all edges existing in the shell
334 TopExp_Explorer anExp1( aShape, TopAbs_EDGE );
335 for( ; anExp1.More(); anExp1.Next() )
337 TopoDS_Edge anEdge = TopoDS::Edge( anExp1.Current() );
338 QList<int> aVerticesIdsList;
339 if( EdgeDiscretization( anEdge, theDeflection, aVerticesMap, aVerticesIdsList ) )
340 anEdgesMap.Add( anEdge, aVerticesIdsList );
343 // add into the map all faces existing in the shell and correspondence between face and edges ids
344 TopExp_Explorer anExp2( aShape, TopAbs_FACE );
345 for( ; anExp2.More(); anExp2.Next() )
347 TopoDS_Face aFace = TopoDS::Face( anExp2.Current() );
348 TopExp_Explorer anExp3( aFace, TopAbs_EDGE );
349 QList<int> anEdgesIdsList;
350 for( ; anExp3.More(); anExp3.Next() )
352 TopoDS_Edge anEdge = TopoDS::Edge( anExp3.Current() );
353 int anEdgeId = anEdgesMap.FindIndex( anEdge );
354 anEdgesIdsList.append( anEdgeId );
356 aFacesMap.Add( aFace, anEdgesIdsList );
359 QFile aFile( theFileName );
360 if( !aFile.open( QFile::WriteOnly | QFile::Text ) )
363 QTextStream aStream( &aFile );
364 aStream << "# nodes\n";
365 NCollection_IndexedMap<gp_Pnt>::Iterator anIt1( aVerticesMap );
366 for( ; anIt1.More(); anIt1.Next() )
368 gp_Pnt aPnt = anIt1.Value();
369 aStream << QString::number( aPnt.X(), TELEMAC_FORMAT, TELEMAC_PRECISION );
371 aStream << QString::number( aPnt.Y(), TELEMAC_FORMAT, TELEMAC_PRECISION );
373 aStream << QString::number( aPnt.Z(), TELEMAC_FORMAT, TELEMAC_PRECISION );
378 aStream << "# edges\n";
379 NCollection_IndexedDataMap< TopoDS_Edge, QList<int> >::Iterator anIt2( anEdgesMap );
380 for( ; anIt2.More(); anIt2.Next() )
382 QList<int> aVerticesIds = anIt2.Value();
383 foreach( int anId, aVerticesIds )
384 aStream << anId << " ";
389 aStream << "# faces\n";
390 NCollection_IndexedDataMap< TopoDS_Face, QList<int> >::Iterator anIt3( aFacesMap );
391 for( ; anIt3.More(); anIt3.Next() )
393 QList<int> anEdgesIds = anIt3.Value();
394 foreach( int anId, anEdgesIds )
395 aStream << anId << " ";
405 Add a new object as land cover
406 @param theObject the object to add as land cover
407 @param theType the Strickler type for the new land cover
408 @return if the addition is successful
410 bool HYDROData_LandCoverMap::Add( const Handle( HYDROData_Object )& theObject, const QString& theType )
412 if( theObject.IsNull() )
415 TopoDS_Shape aShape = theObject->GetTopShape();
416 if( aShape.ShapeType()!=TopAbs_FACE )
419 TopoDS_Face aFace = TopoDS::Face( aShape );
420 return LocalPartition( aFace, theType );
424 Add a new polyline as land cover
425 @param thePolyline the polyline to add as land cover
426 @param theType the Strickler type for the new land cover
427 @return if the addition is successful
429 bool HYDROData_LandCoverMap::Add( const Handle( HYDROData_PolylineXY )& thePolyline, const QString& theType )
431 if( thePolyline.IsNull() )
434 TopoDS_Shape aShape = thePolyline->GetShape();
435 if( aShape.ShapeType()!=TopAbs_WIRE )
438 TopoDS_Wire aWire = TopoDS::Wire( aShape );
439 if( !aWire.Closed() )
442 TopoDS_Face aFace = BRepBuilderAPI_MakeFace( aWire, Standard_True ).Face();
443 return LocalPartition( aFace, theType );
447 Remove the given face from land cover map
448 @param theFace the face to be removed
449 @return if the removing is successful
451 bool HYDROData_LandCoverMap::Remove( const TopoDS_Face& theFace )
453 TopTools_ListOfShape aList;
454 aList.Append( theFace );
455 return Remove( aList );
459 Remove the given faces from land cover map
460 @param theFacesToRemove the face list to be removed
461 @return if the removing is successful
463 bool HYDROData_LandCoverMap::Remove( const TopTools_ListOfShape& theFacesToRemove )
465 HYDROData_MapOfFaceToStricklerType aFacesToRemove, aNewFaces;
466 TopTools_ListIteratorOfListOfShape aFIt( theFacesToRemove );
467 for( ; aFIt.More(); aFIt.Next() )
469 TopoDS_Shape aShape = aFIt.Value();
470 if( aShape.ShapeType()==TopAbs_FACE )
471 aFacesToRemove.Add( TopoDS::Face( aShape ), "" );
474 Iterator anIt( *this );
475 for( ; anIt.More(); anIt.Next() )
476 if( !aFacesToRemove.Contains( anIt.Face() ) )
477 aNewFaces.Add( anIt.Face(), anIt.StricklerType() );
479 StoreLandCovers( aNewFaces );
484 Split the land cover map by the given polyline
485 @param thePolyline the tool polyline to split the land cover map
486 @return if the removing is successful
488 bool HYDROData_LandCoverMap::Split( const Handle( HYDROData_PolylineXY )& thePolyline )
490 if( thePolyline.IsNull() )
493 TopoDS_Shape aShape = thePolyline->GetShape();
494 return LocalPartition( aShape, "" );
498 Merge the given faces in the land cover
499 @param theFaces the faces to merge in the land cover map
500 @param theType the Strickler type for the merged land cover
501 @return if the merge is successful
503 bool HYDROData_LandCoverMap::Merge( const TopTools_ListOfShape& theFaces, const QString& theType )
505 // 1. to fuse the faces into the new face
506 TopoDS_Shape aMergedFace = MergeFaces( theFaces, true );
507 if( aMergedFace.ShapeType()==TopAbs_FACE )
509 // 2. to remove the merged faces from the current map
512 // 3. to add the face into the map
513 return LocalPartition( TopoDS::Face( aMergedFace ), theType );
518 TopoDS_Shape HYDROData_LandCoverMap::MergeFaces( const TopTools_ListOfShape& theFaces,
519 bool IsToUnify, double theTolerance )
522 TopTools_ListIteratorOfListOfShape anIt;
523 BOPCol_ListOfShape aLC;
524 anIt.Initialize(theFaces);
525 for( ; anIt.More(); anIt.Next() )
526 aLC.Append( anIt.Value() );
528 BOPAlgo_PaveFiller aPF;
529 aPF.SetArguments( aLC );
530 aPF.SetRunParallel( Standard_False );
531 aPF.SetFuzzyValue( theTolerance );
534 anError = aPF.ErrorStatus();
536 return TopoDS_Shape();
538 BOPAlgo_Builder anAlgo;
539 anIt.Initialize( theFaces );
540 for( ; anIt.More(); anIt.Next() )
541 anAlgo.AddArgument( anIt.Value() );
543 anAlgo.PerformWithFiller( aPF );
544 anError = anAlgo.ErrorStatus();
546 return TopoDS_Shape();
548 const TopoDS_Shape& aMergedShape = anAlgo.Shape();
550 BRep_Builder aBuilder;
552 aBuilder.MakeShell( aShell );
553 aShell.Closed( Standard_False );
554 TopExp_Explorer anExplorer( aMergedShape, TopAbs_FACE );
555 for( ; anExplorer.More(); anExplorer.Next() )
557 const TopoDS_Face& aFace = TopoDS::Face(anExplorer.Current());
560 if( aFace.ShapeType() == TopAbs_FACE )
562 aBuilder.Add( aShell, aFace );
563 aShell.Closed( Standard_False );
567 TopoDS_Shape aResult;
570 ShapeUpgrade_UnifySameDomain aUSD;
571 aUSD.Initialize( aShell );
573 aResult = aUSD.Shape();
578 anExplorer.Init( aResult, TopAbs_FACE );
580 TopoDS_Face anOneFace;
581 for( ; anExplorer.More(); anExplorer.Next(), i++ )
582 anOneFace = TopoDS::Face( anExplorer.Current() );
591 Get the shape of the land cover map
593 TopoDS_Shape HYDROData_LandCoverMap::GetShape() const
595 return HYDROData_Entity::GetShape( DataTag_Shape );
599 Set the shape of the land cover map
600 @param theShape the new shape for the land cover map
602 void HYDROData_LandCoverMap::SetShape( const TopoDS_Shape& theShape )
604 HYDROData_Entity::SetShape( DataTag_Shape, theShape );
608 Perform the local partition algorithm on the land cover
609 @param theNewShape the new shape to add into the land cover
610 @param theNewType the new Strickler type for the new land cover
611 @return if the local partition is successful
613 bool HYDROData_LandCoverMap::LocalPartition( const TopoDS_Shape& theNewShape, const QString& theNewType )
615 if( theNewShape.IsNull() )
618 BOPCol_ListOfShape aShapesList;
619 BOPAlgo_PaveFiller aPaveFiller;
620 HYDROData_MapOfFaceToStricklerType aNewFaces;
622 // add faces to shapes list
623 Iterator anIt( *this );
624 for( ; anIt.More(); anIt.Next() )
625 aShapesList.Append( anIt.Face() );
626 aShapesList.Append( theNewShape );
628 if( aShapesList.Size()==1 && theNewShape.ShapeType()==TopAbs_FACE )
630 aNewFaces.Add( TopoDS::Face( theNewShape ), theNewType );
631 StoreLandCovers( aNewFaces );
635 // prepare pave filler
636 aPaveFiller.SetArguments( aShapesList );
637 aPaveFiller.Perform();
638 Standard_Integer anError = aPaveFiller.ErrorStatus();
642 // add faces to builder
643 BOPAlgo_Builder aBuilder;
645 for( ; anIt.More(); anIt.Next() )
646 aBuilder.AddArgument( anIt.Face() );
647 aBuilder.AddArgument( theNewShape );
649 // perform the partition with the pave filler
650 aBuilder.PerformWithFiller( aPaveFiller );
651 anError = aBuilder.ErrorStatus();
655 // analysis of the history
656 // a. to fill map of shapes which come from the new face
657 NCollection_IndexedMap<TopoDS_Shape> aShapesFromNewFace;
658 //std::cout << "new: " << theNewShape << " " << theNewType << std::endl;
659 TopTools_ListOfShape aModified = aBuilder.Modified( theNewShape );
660 TopTools_ListIteratorOfListOfShape aMIt( aModified );
661 for( ; aMIt.More(); aMIt.Next() )
663 //std::cout << " " << aMIt.Value() << std::endl;
664 aShapesFromNewFace.Add( aMIt.Value() );
667 // b. to fill map of parts except parts from new face
669 for( ; anIt.More(); anIt.Next() )
671 QString aSType = anIt.StricklerType();
672 //std::cout << anIt.Face() << " " << anIt.StricklerType() << std::endl;
673 TopTools_ListOfShape aModified = aBuilder.Modified( anIt.Face() );
674 TopTools_ListIteratorOfListOfShape aMIt( aModified );
675 for( ; aMIt.More(); aMIt.Next() )
677 TopoDS_Shape aShape = aMIt.Value();
678 bool isFace = aShape.ShapeType()==TopAbs_FACE;
679 bool isAlsoFromNew = aShapesFromNewFace.Contains( aShape );
680 //std::cout << " " << aShape << " " << isAlsoFromNew << std::endl;
681 if( isFace && !isAlsoFromNew )
682 aNewFaces.Add( TopoDS::Face( aShape ), aSType );
686 // c. add the new shape if it is face with its type
687 if( theNewShape.ShapeType()==TopAbs_FACE )
688 aNewFaces.Add( TopoDS::Face( theNewShape ), theNewType );
690 // convert map of shape to type to compound and list of types
691 StoreLandCovers( aNewFaces );
696 Replace the set of land covers in the land cover map
697 @param theMap the map of shape (face) to Strickler type (string)
699 void HYDROData_LandCoverMap::StoreLandCovers( const HYDROData_MapOfFaceToStricklerType& theMap )
701 TopoDS_Compound aCompound;
702 BRep_Builder aCompoundBuilder;
703 aCompoundBuilder.MakeCompound( aCompound );
705 int n = theMap.Size();
706 Handle( TDataStd_ExtStringArray ) aTypes =
707 TDataStd_ExtStringArray::Set( myLab.FindChild( DataTag_Types ), 0, n-1, Standard_True );
708 HYDROData_MapOfFaceToStricklerType::Iterator aNFIt( theMap );
709 for( int i=0; aNFIt.More(); aNFIt.Next(), i++ )
711 TopoDS_Face aFace = aNFIt.Key();
712 QString aType = aNFIt.Value();
713 aCompoundBuilder.Add( aCompound, aFace );
714 aTypes->SetValue( i, HYDROData_Tool::toExtString( aType ) );
717 SetShape( aCompound );
721 Find the land cover for the given point
722 @param thePoint the point laying in some land cover
723 @param theType the returned type
724 @return the found land cover's face
726 TopoDS_Face HYDROData_LandCoverMap::FindByPoint( const gp_Pnt2d& thePoint, QString& theType ) const
728 //TODO: some more optimal algorithm
729 Iterator anIt( *this );
730 for( ; anIt.More(); anIt.Next() )
731 if( HYDROData_Tool::ComputePointState( thePoint.XY(), anIt.Face() ) == TopAbs_IN )
733 theType = anIt.StricklerType();
738 return TopoDS_Face();