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_Entity.h"
21 #include "HYDROData_Iterator.h"
22 #include "HYDROData_Tool.h"
24 #include <TDataStd_Name.hxx>
25 #include <TDataStd_ByteArray.hxx>
26 #include <TDataStd_UAttribute.hxx>
27 #include <TDataStd_IntegerArray.hxx>
28 #include <TDataStd_BooleanArray.hxx>
29 #include <TDataStd_Integer.hxx>
30 #include <TDataStd_RealArray.hxx>
31 #include <TDataStd_ReferenceList.hxx>
33 #include <TDF_CopyLabel.hxx>
34 #include <TDF_ListIteratorOfLabelList.hxx>
38 #include <QStringList>
41 static const Standard_GUID GUID_MUST_BE_UPDATED("80f2bb81-3873-4631-8ddd-940d2119f000");
43 IMPLEMENT_STANDARD_HANDLE(HYDROData_Entity,MMgt_TShared)
44 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Entity,MMgt_TShared)
46 // is equal function for unique object mapping
47 bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2)
49 if ( !theObj1.IsNull() && !theObj2.IsNull() )
50 return theObj1->Label() == theObj2->Label();
54 QString HYDROData_Entity::GetName() const
56 Handle(TDataStd_Name) aName;
57 if (myLab.FindAttribute(TDataStd_Name::GetID(), aName)) {
58 TCollection_AsciiString aStr(aName->Get());
59 return QString(aStr.ToCString());
64 QString HYDROData_Entity::GetObjPyName() const
66 QString aName = GetName();
67 aName.replace(QRegExp("[\\W]"), "_");
72 void HYDROData_Entity::SetName(const QString& theName)
74 TDataStd_Name::Set(myLab, TCollection_ExtendedString(theName.toLatin1().constData()));
77 QStringList HYDROData_Entity::DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const
79 QStringList anEmptyList;
83 void HYDROData_Entity::Update()
88 void HYDROData_Entity::UpdateLocalCS( double theDx, double theDy )
90 //On the base level no actions are necessary
93 bool HYDROData_Entity::IsHas2dPrs() const
98 void HYDROData_Entity::Show()
103 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
104 if ( aDocument.IsNull() )
107 aDocument->Show( this );
110 QVariant HYDROData_Entity::GetDataVariant()
115 void HYDROData_Entity::SetToUpdate( bool theFlag )
117 if ( IsMustBeUpdated() == theFlag )
122 TDataStd_UAttribute::Set( myLab, GUID_MUST_BE_UPDATED );
124 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
125 if ( !aDocument.IsNull() )
127 // Change the states of this and all depended objects
128 HYDROData_Tool::SetMustBeUpdatedObjects( aDocument );
133 myLab.ForgetAttribute( GUID_MUST_BE_UPDATED );
137 bool HYDROData_Entity::IsMustBeUpdated() const
139 return myLab.IsAttribute( GUID_MUST_BE_UPDATED );
142 bool HYDROData_Entity::CanBeUpdated() const
147 bool HYDROData_Entity::IsRemoved() const
149 return !myLab.HasAttribute();
152 void HYDROData_Entity::Remove()
154 return myLab.ForgetAllAttributes( true );
157 bool HYDROData_Entity::CanRemove()
162 HYDROData_Entity::HYDROData_Entity()
166 HYDROData_Entity::~HYDROData_Entity()
170 void HYDROData_Entity::CopyTo( const Handle(HYDROData_Entity)& theDestination,
171 bool isGenerateNewName ) const
173 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
174 if ( aDocument.IsNull() ) {
178 TDF_CopyLabel aCopy(myLab, theDestination->Label());
181 if( isGenerateNewName )
183 // generate a new unique name for the clone object:
184 // case 1: Image_1 -> Image_2
185 // case 2: ImageObj -> ImageObj_1
186 QString aName = theDestination->GetName();
187 QString aPrefix = aName;
188 if( aName.contains( '_' ) ) { // case 1
189 QString aSuffix = aName.section( '_', -1 );
190 bool anIsInteger = false;
191 aSuffix.toInt( &anIsInteger );
193 aPrefix = aName.section( '_', 0, -2 );
198 aName = HYDROData_Tool::GenerateObjectName( aDocument, aPrefix );
199 theDestination->SetName( aName );
203 Handle(HYDROData_Entity) HYDROData_Entity::GetFatherObject() const
205 Handle(HYDROData_Entity) aFather;
207 if ( !myLab.IsNull() )
209 TDF_Label aFatherLabel = myLab.Father();
211 while ( aFather.IsNull() && !aFatherLabel.IsNull() && !aFatherLabel.IsRoot() )
213 aFather = HYDROData_Iterator::Object( aFatherLabel );
214 aFatherLabel = aFatherLabel.Father();
221 HYDROData_SequenceOfObjects HYDROData_Entity::GetAllReferenceObjects() const
223 return HYDROData_SequenceOfObjects();
226 Standard_Boolean HYDROData_Entity::GetZLevel( Standard_Integer& theLevel ) const
230 TDF_Label aLabel = myLab.FindChild( DataTag_ZLevel, false );
231 if ( !aLabel.IsNull() )
233 Handle(TDataStd_Integer) anIntVal;
234 if ( aLabel.FindAttribute( TDataStd_Integer::GetID(), anIntVal ) )
236 theLevel = anIntVal->Get();
237 return Standard_True;
241 return Standard_False;
244 void HYDROData_Entity::SetZLevel( const Standard_Integer& theLevel )
246 TDataStd_Integer::Set( myLab.FindChild( DataTag_ZLevel ), theLevel );
249 void HYDROData_Entity::RemoveZLevel()
251 TDF_Label aLabel = myLab.FindChild( DataTag_ZLevel, false );
252 if ( !aLabel.IsNull() )
253 aLabel.ForgetAllAttributes();
256 void HYDROData_Entity::SetLabel( const TDF_Label& theLabel )
261 void HYDROData_Entity::SaveByteArray( const int theTag,
265 TDF_Label aLab = theTag == 0 ? myLab : myLab.FindChild(theTag);
266 // array is empty, remove the attribute
268 aLab.ForgetAttribute(TDataStd_ByteArray::GetID());
271 // store data of image in byte array
272 Handle(TDataStd_ByteArray) aData;
273 if (!aLab.FindAttribute(TDataStd_ByteArray::GetID(), aData)) {
274 aData = TDataStd_ByteArray::Set(aLab, 1, theLen);
276 // copy bytes one by one
277 if (aData->Length() != theLen) {
278 Handle(TColStd_HArray1OfByte) aNewData = new TColStd_HArray1OfByte(1, theLen);
279 for(int a = 0; a < theLen; a++)
280 aNewData->SetValue(a + 1, theData[a]);
281 aData->ChangeArray(aNewData);
283 for(int a = 0; a < theLen; a++)
284 aData->SetValue(a + 1, theData[a]);
288 const char* HYDROData_Entity::ByteArray(const int theTag, int& theLen) const
290 TDF_Label aLab = theTag == 0 ? myLab : myLab.FindChild(theTag);
291 Handle(TDataStd_ByteArray) aData;
292 if (!aLab.FindAttribute(TDataStd_ByteArray::GetID(), aData))
293 return NULL; // return empty image if there is no array
294 theLen = aData->Length();
296 return (const char*)(&(aData->InternalArray()->ChangeArray1().ChangeValue(1)));
300 int HYDROData_Entity::NbReferenceObjects( const int theTag ) const
302 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
303 return aRefs.IsNull() ? 0 : aRefs->Extent();
306 bool HYDROData_Entity::HasReference( const Handle_HYDROData_Entity& theObj,
307 const int theTag ) const
309 if ( theObj.IsNull() )
312 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
313 if ( aRefs.IsNull() || aRefs->IsEmpty() )
316 TDF_ListIteratorOfLabelList aListIt( aRefs->List() );
317 for ( ; aListIt.More(); aListIt.Next() )
319 const TDF_Label& aRefLabel = aListIt.Value();
320 if ( theObj->Label() == aRefLabel )
327 void HYDROData_Entity::AddReferenceObject( const Handle_HYDROData_Entity& theObj,
330 if ( theObj.IsNull() )
333 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
334 aRefs->Append( theObj->Label() );
337 void HYDROData_Entity::SetReferenceObject( const Handle_HYDROData_Entity& theObj,
341 if ( theObj.IsNull() )
343 RemoveReferenceObject( theTag, theIndex );
347 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
349 if ( theIndex >= aRefs->Extent() )
351 aRefs->Append( theObj->Label() );
353 else if ( theIndex < 0 )
355 aRefs->Prepend( theObj->Label() );
359 RemoveReferenceObject( theTag, theIndex );
361 Handle(HYDROData_Entity) aBeforeObj = GetReferenceObject( theTag, theIndex );
363 aRefs = getReferenceList( theTag, true ); // because reference list can be removed
364 if ( !aBeforeObj.IsNull() )
365 aRefs->InsertBefore( theObj->Label(), aBeforeObj->Label() );
367 aRefs->Append( theObj->Label() );
371 void HYDROData_Entity::InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
373 const int theBeforeIndex )
375 if ( theObj.IsNull() )
378 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
380 if ( theBeforeIndex >= aRefs->Extent() )
382 aRefs->Append( theObj->Label() );
384 else if ( theBeforeIndex < 0 )
386 aRefs->Prepend( theObj->Label() );
390 Handle(HYDROData_Entity) aBeforeObj = GetReferenceObject( theTag, theBeforeIndex );
391 if ( !aBeforeObj.IsNull() )
392 aRefs->InsertBefore( theObj->Label(), aBeforeObj->Label() );
394 aRefs->Append( theObj->Label() );
398 void HYDROData_Entity::SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
401 ClearReferenceObjects( theTag );
402 if ( theObjects.IsEmpty() )
405 HYDROData_SequenceOfObjects::Iterator anIter( theObjects );
406 for ( ; anIter.More(); anIter.Next() )
407 AddReferenceObject( anIter.Value(), theTag );
410 Handle(HYDROData_Entity) HYDROData_Entity::GetReferenceObject( const int theTag,
411 const int theIndex ) const
413 Handle(HYDROData_Entity) aRes;
415 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
416 if ( aRefs.IsNull() || theIndex < 0 || theIndex >= aRefs->Extent() )
419 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
420 for ( int anIndex = 0; anIndex != theIndex && anIter.More(); anIter.Next(), ++anIndex );
422 const TDF_Label& aRefLabel = anIter.Value();
423 aRes = HYDROData_Iterator::Object( aRefLabel );
428 HYDROData_SequenceOfObjects HYDROData_Entity::GetReferenceObjects( const int theTag ) const
430 HYDROData_SequenceOfObjects aRes;
432 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
433 if ( aRefs.IsNull() )
436 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
437 for ( ; anIter.More(); anIter.Next() )
439 const TDF_Label& aRefLabel = anIter.Value();
441 Handle(HYDROData_Entity) aRefObject = HYDROData_Iterator::Object( aRefLabel );
442 if ( aRefObject.IsNull() )
445 aRes.Append( aRefObject );
451 void HYDROData_Entity::RemoveReferenceObject( const TDF_Label& theRefLabel,
454 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
455 if ( aRefs.IsNull() )
458 if ( aRefs->Extent() == 1 )
460 // remove all if only one
461 ClearReferenceObjects( theTag );
465 aRefs->Remove( theRefLabel );
468 void HYDROData_Entity::RemoveReferenceObject( const int theTag,
471 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
472 if ( aRefs.IsNull() )
475 if ( aRefs->Extent() == 1 && theIndex == 0 )
477 // remove all if only one
478 ClearReferenceObjects( theTag );
483 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
484 for ( ; anIndex != theIndex && anIter.More(); anIter.Next(), ++anIndex );
486 if ( anIndex != theIndex || !anIter.More() )
489 const TDF_Label& aRefLabel = anIter.Value();
490 aRefs->Remove( aRefLabel );
493 void HYDROData_Entity::ClearReferenceObjects( const int theTag )
495 TDF_Label aSetLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
496 aSetLabel.ForgetAttribute( TDataStd_ReferenceList::GetID() );
499 Handle(TDataStd_ReferenceList) HYDROData_Entity::getReferenceList( const int theTag,
500 const bool theIsCreate ) const
502 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
504 Handle(TDataStd_ReferenceList) aRefs;
505 if ( !aLabel.FindAttribute( TDataStd_ReferenceList::GetID(), aRefs ) && theIsCreate )
506 aRefs = TDataStd_ReferenceList::Set( aLabel );
511 void HYDROData_Entity::SetColor( const QColor& theColor,
514 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
516 Handle(TDataStd_IntegerArray) aColorArray;
517 if ( !aLabel.FindAttribute( TDataStd_IntegerArray::GetID(), aColorArray ) )
518 aColorArray = TDataStd_IntegerArray::Set( aLabel, 1, 4 );
520 aColorArray->SetValue( 1, theColor.red() );
521 aColorArray->SetValue( 2, theColor.green() );
522 aColorArray->SetValue( 3, theColor.blue() );
523 aColorArray->SetValue( 4, theColor.alpha() );
526 QColor HYDROData_Entity::GetColor( const QColor& theDefColor,
527 const int theTag ) const
529 QColor aResColor = theDefColor;
531 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
533 Handle(TDataStd_IntegerArray) aColorArray;
534 if ( aLabel.FindAttribute( TDataStd_IntegerArray::GetID(), aColorArray ) )
536 aResColor.setRed( aColorArray->Value( 1 ) );
537 aResColor.setGreen( aColorArray->Value( 2 ) );
538 aResColor.setBlue( aColorArray->Value( 3 ) );
539 aResColor.setAlpha( aColorArray->Value( 4 ) );
545 QStringList HYDROData_Entity::dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const
547 QStringList aResList;
549 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
550 if ( aDocument.IsNull() )
553 QString aDocName = aDocument->GetDocPyName();
554 QString aName = GetObjPyName();
556 aResList << QString( "%1 = %2.CreateObject( %3 );" )
557 .arg( aName ).arg( aDocName ).arg( getPyTypeID() );
558 aResList << QString( "%1.SetName( \"%2\" );" )
559 .arg( aName ).arg( GetName() );
560 aResList << QString( "" );
564 // Dump object z-level in viewer
565 Standard_Integer anObjZLevel = -1;
566 if ( GetZLevel( anObjZLevel ) )
568 aResList << QString( "%1.SetZLevel( %2 );" )
569 .arg( aName ).arg( anObjZLevel );
570 aResList << QString( "" );
577 QString HYDROData_Entity::getPyTypeID() const
581 case KIND_IMAGE: return "KIND_IMAGE";
582 case KIND_POLYLINE: return "KIND_POLYLINE";
583 case KIND_BATHYMETRY: return "KIND_BATHYMETRY";
584 case KIND_ALTITUDE: return "KIND_ALTITUDE";
585 case KIND_IMMERSIBLE_ZONE: return "KIND_IMMERSIBLE_ZONE";
586 case KIND_RIVER: return "KIND_RIVER";
587 case KIND_STREAM: return "KIND_STREAM";
588 case KIND_CONFLUENCE: return "KIND_CONFLUENCE";
589 case KIND_CHANNEL: return "KIND_CHANNEL";
590 case KIND_OBSTACLE: return "KIND_OBSTACLE";
591 case KIND_DIGUE: return "KIND_DIGUE";
592 case KIND_PROFILE: return "KIND_PROFILE";
593 case KIND_PROFILEUZ: return "KIND_PROFILEUZ";
594 case KIND_POLYLINEXY: return "KIND_POLYLINEXY";
595 case KIND_CALCULATION: return "KIND_CALCULATION";
596 case KIND_ZONE: return "KIND_ZONE";
597 case KIND_REGION: return "KIND_REGION";
598 case KIND_VISUAL_STATE: return "KIND_VISUAL_STATE";
599 case KIND_ARTIFICIAL_OBJECT: return "KIND_ARTIFICIAL_OBJECT";
600 case KIND_NATURAL_OBJECT: return "KIND_NATURAL_OBJECT";
601 case KIND_DUMMY_3D: return "KIND_DUMMY_3D";
602 case KIND_SHAPES_GROUP: return "KIND_SHAPES_GROUP";
603 case KIND_SPLITTED_GROUP: return "KIND_SPLITTED_GROUP";
604 case KIND_STREAM_ALTITUDE: return "KIND_STREAM_ALTITUDE";
605 case KIND_OBSTACLE_ALTITUDE: return "KIND_OBSTACLE_ALTITUDE";
606 case KIND_STRICKLER_TABLE: return "KIND_STRICKLER_TABLE";
607 case KIND_LAND_COVER: return "KIND_LAND_COVER";
608 default: return "KIND_UNKNOWN"; ///! Unrecognized object
612 void HYDROData_Entity::setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
613 QStringList& theScript,
614 const Handle(HYDROData_Entity)& theRefObject,
615 const QString& theMethod ) const
617 if ( !checkObjectPythonDefinition( theTreatedObjects, theScript, theRefObject ) )
620 QString aRefObjName = theRefObject->GetObjPyName();
622 QString anObjName = GetObjPyName();
623 theScript << QString( "%1.%2( %3 );" )
624 .arg( anObjName ).arg( theMethod ).arg( aRefObjName );
627 bool HYDROData_Entity::checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
628 QStringList& theScript,
629 const Handle(HYDROData_Entity)& theRefObject ) const
631 if ( theRefObject.IsNull() )
634 QString aRefObjName = theRefObject->GetName();
635 if ( aRefObjName.isEmpty() )
638 if ( theTreatedObjects.contains( aRefObjName ) )
641 // The definition of reference object must be dumped before this
642 QStringList aRefObjDump = theRefObject->DumpToPython( theTreatedObjects );
643 if ( aRefObjDump.isEmpty() )
646 QStringList aTmpList = theScript;
647 theScript = aRefObjDump;
649 theScript << QString( "" );
650 theScript << aTmpList;
652 theTreatedObjects.insert( aRefObjName, theRefObject );
657 void HYDROData_Entity::setPythonObjectColor( QStringList& theScript,
658 const QColor& theColor,
659 const QColor& theDefaultColor,
660 const QString& theMethod ) const
662 if ( theColor == theDefaultColor )
663 return; //Do not set the color for object if it like default
665 QString anObjName = GetObjPyName();
666 theScript << QString( "%1.%2( QColor( %3, %4, %5, %6 ) );" )
667 .arg( anObjName ).arg( theMethod )
668 .arg( theColor.red() ).arg( theColor.green() )
669 .arg( theColor.blue() ).arg( theColor.alpha() );
672 void HYDROData_Entity::findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
673 QStringList& theScript ) const
675 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
676 if ( aDocument.IsNull() )
679 theScript << QString( "%1 = %2.FindObjectByName( \"%3\" );" ).arg( GetObjPyName() )
680 .arg( aDocument->GetDocPyName() )