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 HYDROData_SequenceOfObjects::HYDROData_SequenceOfObjects()
42 : NCollection_Sequence<Handle_HYDROData_Entity>()
46 HYDROData_SequenceOfObjects::HYDROData_SequenceOfObjects( const HYDROData_SequenceOfObjects& theSequence )
47 : NCollection_Sequence<Handle_HYDROData_Entity>( theSequence )
51 HYDROData_SequenceOfObjects::HYDROData_SequenceOfObjects( const NCollection_Sequence<Handle_HYDROData_Entity>& theSequence )
52 : NCollection_Sequence<Handle_HYDROData_Entity>( theSequence )
57 static const Standard_GUID GUID_MUST_BE_UPDATED("80f2bb81-3873-4631-8ddd-940d2119f000");
59 IMPLEMENT_STANDARD_HANDLE(HYDROData_Entity,MMgt_TShared)
60 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Entity,MMgt_TShared)
62 // is equal function for unique object mapping
63 bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2)
65 if ( !theObj1.IsNull() && !theObj2.IsNull() )
66 return theObj1->Label() == theObj2->Label();
70 QString HYDROData_Entity::GetName() const
72 Handle(TDataStd_Name) aName;
73 if (myLab.FindAttribute(TDataStd_Name::GetID(), aName)) {
74 TCollection_AsciiString aStr(aName->Get());
75 return QString(aStr.ToCString());
80 QString HYDROData_Entity::GetObjPyName() const
82 QString aName = GetName();
83 aName.replace(QRegExp("[\\W]"), "_");
88 void HYDROData_Entity::SetName(const QString& theName)
90 TDataStd_Name::Set(myLab, TCollection_ExtendedString(theName.toLatin1().constData()));
93 QStringList HYDROData_Entity::DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const
95 QStringList anEmptyList;
99 void HYDROData_Entity::Update()
101 SetToUpdate( false );
104 void HYDROData_Entity::UpdateLocalCS( double theDx, double theDy )
106 //On the base level no actions are necessary
109 bool HYDROData_Entity::IsHas2dPrs() const
114 void HYDROData_Entity::Show()
119 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
120 if ( aDocument.IsNull() )
123 aDocument->Show( this );
126 QVariant HYDROData_Entity::GetDataVariant()
131 void HYDROData_Entity::SetToUpdate( bool theFlag )
133 if ( IsMustBeUpdated() == theFlag )
138 TDataStd_UAttribute::Set( myLab, GUID_MUST_BE_UPDATED );
140 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
141 if ( !aDocument.IsNull() )
143 // Change the states of this and all depended objects
144 HYDROData_Tool::SetMustBeUpdatedObjects( aDocument );
149 myLab.ForgetAttribute( GUID_MUST_BE_UPDATED );
153 bool HYDROData_Entity::IsMustBeUpdated() const
155 return myLab.IsAttribute( GUID_MUST_BE_UPDATED );
158 bool HYDROData_Entity::CanBeUpdated() const
163 bool HYDROData_Entity::IsRemoved() const
165 return !myLab.HasAttribute();
168 void HYDROData_Entity::Remove()
170 return myLab.ForgetAllAttributes( true );
173 bool HYDROData_Entity::CanRemove()
178 HYDROData_Entity::HYDROData_Entity()
182 HYDROData_Entity::~HYDROData_Entity()
186 void HYDROData_Entity::CopyTo( const Handle(HYDROData_Entity)& theDestination,
187 bool isGenerateNewName ) const
189 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
190 if ( aDocument.IsNull() ) {
194 TDF_CopyLabel aCopy(myLab, theDestination->Label());
197 if( isGenerateNewName )
199 // generate a new unique name for the clone object:
200 // case 1: Image_1 -> Image_2
201 // case 2: ImageObj -> ImageObj_1
202 QString aName = theDestination->GetName();
203 QString aPrefix = aName;
204 if( aName.contains( '_' ) ) { // case 1
205 QString aSuffix = aName.section( '_', -1 );
206 bool anIsInteger = false;
207 aSuffix.toInt( &anIsInteger );
209 aPrefix = aName.section( '_', 0, -2 );
214 aName = HYDROData_Tool::GenerateObjectName( aDocument, aPrefix );
215 theDestination->SetName( aName );
219 Handle(HYDROData_Entity) HYDROData_Entity::GetFatherObject() const
221 Handle(HYDROData_Entity) aFather;
223 if ( !myLab.IsNull() )
225 TDF_Label aFatherLabel = myLab.Father();
227 while ( aFather.IsNull() && !aFatherLabel.IsNull() && !aFatherLabel.IsRoot() )
229 aFather = HYDROData_Iterator::Object( aFatherLabel );
230 aFatherLabel = aFatherLabel.Father();
237 HYDROData_SequenceOfObjects HYDROData_Entity::GetAllReferenceObjects() const
239 return HYDROData_SequenceOfObjects();
242 Standard_Boolean HYDROData_Entity::GetZLevel( Standard_Integer& theLevel ) const
246 TDF_Label aLabel = myLab.FindChild( DataTag_ZLevel, false );
247 if ( !aLabel.IsNull() )
249 Handle(TDataStd_Integer) anIntVal;
250 if ( aLabel.FindAttribute( TDataStd_Integer::GetID(), anIntVal ) )
252 theLevel = anIntVal->Get();
253 return Standard_True;
257 return Standard_False;
260 void HYDROData_Entity::SetZLevel( const Standard_Integer& theLevel )
262 TDataStd_Integer::Set( myLab.FindChild( DataTag_ZLevel ), theLevel );
265 void HYDROData_Entity::RemoveZLevel()
267 TDF_Label aLabel = myLab.FindChild( DataTag_ZLevel, false );
268 if ( !aLabel.IsNull() )
269 aLabel.ForgetAllAttributes();
272 void HYDROData_Entity::SetLabel( const TDF_Label& theLabel )
277 void HYDROData_Entity::SaveByteArray( const int theTag,
281 TDF_Label aLab = theTag == 0 ? myLab : myLab.FindChild(theTag);
282 // array is empty, remove the attribute
284 aLab.ForgetAttribute(TDataStd_ByteArray::GetID());
287 // store data of image in byte array
288 Handle(TDataStd_ByteArray) aData;
289 if (!aLab.FindAttribute(TDataStd_ByteArray::GetID(), aData)) {
290 aData = TDataStd_ByteArray::Set(aLab, 1, theLen);
292 // copy bytes one by one
293 if (aData->Length() != theLen) {
294 Handle(TColStd_HArray1OfByte) aNewData = new TColStd_HArray1OfByte(1, theLen);
295 for(int a = 0; a < theLen; a++)
296 aNewData->SetValue(a + 1, theData[a]);
297 aData->ChangeArray(aNewData);
299 for(int a = 0; a < theLen; a++)
300 aData->SetValue(a + 1, theData[a]);
304 const char* HYDROData_Entity::ByteArray(const int theTag, int& theLen) const
306 TDF_Label aLab = theTag == 0 ? myLab : myLab.FindChild(theTag);
307 Handle(TDataStd_ByteArray) aData;
308 if (!aLab.FindAttribute(TDataStd_ByteArray::GetID(), aData))
309 return NULL; // return empty image if there is no array
310 theLen = aData->Length();
312 return (const char*)(&(aData->InternalArray()->ChangeArray1().ChangeValue(1)));
316 int HYDROData_Entity::NbReferenceObjects( const int theTag ) const
318 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
319 return aRefs.IsNull() ? 0 : aRefs->Extent();
322 bool HYDROData_Entity::HasReference( const Handle_HYDROData_Entity& theObj,
323 const int theTag ) const
325 if ( theObj.IsNull() )
328 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
329 if ( aRefs.IsNull() || aRefs->IsEmpty() )
332 TDF_ListIteratorOfLabelList aListIt( aRefs->List() );
333 for ( ; aListIt.More(); aListIt.Next() )
335 const TDF_Label& aRefLabel = aListIt.Value();
336 if ( theObj->Label() == aRefLabel )
343 void HYDROData_Entity::AddReferenceObject( const Handle_HYDROData_Entity& theObj,
346 if ( theObj.IsNull() )
349 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
350 aRefs->Append( theObj->Label() );
353 void HYDROData_Entity::SetReferenceObject( const Handle_HYDROData_Entity& theObj,
357 if ( theObj.IsNull() )
359 RemoveReferenceObject( theTag, theIndex );
363 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
365 if ( theIndex >= aRefs->Extent() )
367 aRefs->Append( theObj->Label() );
369 else if ( theIndex < 0 )
371 aRefs->Prepend( theObj->Label() );
375 RemoveReferenceObject( theTag, theIndex );
377 Handle(HYDROData_Entity) aBeforeObj = GetReferenceObject( theTag, theIndex );
379 aRefs = getReferenceList( theTag, true ); // because reference list can be removed
380 if ( !aBeforeObj.IsNull() )
381 aRefs->InsertBefore( theObj->Label(), aBeforeObj->Label() );
383 aRefs->Append( theObj->Label() );
387 void HYDROData_Entity::InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
389 const int theBeforeIndex )
391 if ( theObj.IsNull() )
394 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
396 if ( theBeforeIndex >= aRefs->Extent() )
398 aRefs->Append( theObj->Label() );
400 else if ( theBeforeIndex < 0 )
402 aRefs->Prepend( theObj->Label() );
406 Handle(HYDROData_Entity) aBeforeObj = GetReferenceObject( theTag, theBeforeIndex );
407 if ( !aBeforeObj.IsNull() )
408 aRefs->InsertBefore( theObj->Label(), aBeforeObj->Label() );
410 aRefs->Append( theObj->Label() );
414 void HYDROData_Entity::SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
417 ClearReferenceObjects( theTag );
418 if ( theObjects.IsEmpty() )
421 HYDROData_SequenceOfObjects::Iterator anIter( theObjects );
422 for ( ; anIter.More(); anIter.Next() )
423 AddReferenceObject( anIter.Value(), theTag );
426 Handle(HYDROData_Entity) HYDROData_Entity::GetReferenceObject( const int theTag,
427 const int theIndex ) const
429 Handle(HYDROData_Entity) aRes;
431 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
432 if ( aRefs.IsNull() || theIndex < 0 || theIndex >= aRefs->Extent() )
435 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
436 for ( int anIndex = 0; anIndex != theIndex && anIter.More(); anIter.Next(), ++anIndex );
438 const TDF_Label& aRefLabel = anIter.Value();
439 aRes = HYDROData_Iterator::Object( aRefLabel );
444 HYDROData_SequenceOfObjects HYDROData_Entity::GetReferenceObjects( const int theTag ) const
446 HYDROData_SequenceOfObjects aRes;
448 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
449 if ( aRefs.IsNull() )
452 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
453 for ( ; anIter.More(); anIter.Next() )
455 const TDF_Label& aRefLabel = anIter.Value();
457 Handle(HYDROData_Entity) aRefObject = HYDROData_Iterator::Object( aRefLabel );
458 if ( aRefObject.IsNull() )
461 aRes.Append( aRefObject );
467 void HYDROData_Entity::RemoveReferenceObject( const TDF_Label& theRefLabel,
470 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
471 if ( aRefs.IsNull() )
474 if ( aRefs->Extent() == 1 )
476 // remove all if only one
477 ClearReferenceObjects( theTag );
481 aRefs->Remove( theRefLabel );
484 void HYDROData_Entity::RemoveReferenceObject( const int theTag,
487 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
488 if ( aRefs.IsNull() )
491 if ( aRefs->Extent() == 1 && theIndex == 0 )
493 // remove all if only one
494 ClearReferenceObjects( theTag );
499 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
500 for ( ; anIndex != theIndex && anIter.More(); anIter.Next(), ++anIndex );
502 if ( anIndex != theIndex || !anIter.More() )
505 const TDF_Label& aRefLabel = anIter.Value();
506 aRefs->Remove( aRefLabel );
509 void HYDROData_Entity::ClearReferenceObjects( const int theTag )
511 TDF_Label aSetLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
512 aSetLabel.ForgetAttribute( TDataStd_ReferenceList::GetID() );
515 Handle(TDataStd_ReferenceList) HYDROData_Entity::getReferenceList( const int theTag,
516 const bool theIsCreate ) const
518 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
520 Handle(TDataStd_ReferenceList) aRefs;
521 if ( !aLabel.FindAttribute( TDataStd_ReferenceList::GetID(), aRefs ) && theIsCreate )
522 aRefs = TDataStd_ReferenceList::Set( aLabel );
527 void HYDROData_Entity::SetColor( const QColor& theColor,
530 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
532 Handle(TDataStd_IntegerArray) aColorArray;
533 if ( !aLabel.FindAttribute( TDataStd_IntegerArray::GetID(), aColorArray ) )
534 aColorArray = TDataStd_IntegerArray::Set( aLabel, 1, 4 );
536 aColorArray->SetValue( 1, theColor.red() );
537 aColorArray->SetValue( 2, theColor.green() );
538 aColorArray->SetValue( 3, theColor.blue() );
539 aColorArray->SetValue( 4, theColor.alpha() );
542 QColor HYDROData_Entity::GetColor( const QColor& theDefColor,
543 const int theTag ) const
545 QColor aResColor = theDefColor;
547 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
549 Handle(TDataStd_IntegerArray) aColorArray;
550 if ( aLabel.FindAttribute( TDataStd_IntegerArray::GetID(), aColorArray ) )
552 aResColor.setRed( aColorArray->Value( 1 ) );
553 aResColor.setGreen( aColorArray->Value( 2 ) );
554 aResColor.setBlue( aColorArray->Value( 3 ) );
555 aResColor.setAlpha( aColorArray->Value( 4 ) );
561 QStringList HYDROData_Entity::dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const
563 QStringList aResList;
565 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
566 if ( aDocument.IsNull() )
569 QString aDocName = aDocument->GetDocPyName();
570 QString aName = GetObjPyName();
572 aResList << QString( "%1 = %2.CreateObject( %3 );" )
573 .arg( aName ).arg( aDocName ).arg( getPyTypeID() );
574 aResList << QString( "%1.SetName( \"%2\" );" )
575 .arg( aName ).arg( GetName() );
576 aResList << QString( "" );
580 // Dump object z-level in viewer
581 Standard_Integer anObjZLevel = -1;
582 if ( GetZLevel( anObjZLevel ) )
584 aResList << QString( "%1.SetZLevel( %2 );" )
585 .arg( aName ).arg( anObjZLevel );
586 aResList << QString( "" );
593 QString HYDROData_Entity::getPyTypeID() const
597 case KIND_IMAGE: return "KIND_IMAGE";
598 case KIND_POLYLINE: return "KIND_POLYLINE";
599 case KIND_BATHYMETRY: return "KIND_BATHYMETRY";
600 case KIND_ALTITUDE: return "KIND_ALTITUDE";
601 case KIND_IMMERSIBLE_ZONE: return "KIND_IMMERSIBLE_ZONE";
602 case KIND_RIVER: return "KIND_RIVER";
603 case KIND_STREAM: return "KIND_STREAM";
604 case KIND_CONFLUENCE: return "KIND_CONFLUENCE";
605 case KIND_CHANNEL: return "KIND_CHANNEL";
606 case KIND_OBSTACLE: return "KIND_OBSTACLE";
607 case KIND_DIGUE: return "KIND_DIGUE";
608 case KIND_PROFILE: return "KIND_PROFILE";
609 case KIND_PROFILEUZ: return "KIND_PROFILEUZ";
610 case KIND_POLYLINEXY: return "KIND_POLYLINEXY";
611 case KIND_CALCULATION: return "KIND_CALCULATION";
612 case KIND_ZONE: return "KIND_ZONE";
613 case KIND_REGION: return "KIND_REGION";
614 case KIND_VISUAL_STATE: return "KIND_VISUAL_STATE";
615 case KIND_ARTIFICIAL_OBJECT: return "KIND_ARTIFICIAL_OBJECT";
616 case KIND_NATURAL_OBJECT: return "KIND_NATURAL_OBJECT";
617 case KIND_DUMMY_3D: return "KIND_DUMMY_3D";
618 case KIND_SHAPES_GROUP: return "KIND_SHAPES_GROUP";
619 case KIND_SPLITTED_GROUP: return "KIND_SPLITTED_GROUP";
620 case KIND_STREAM_ALTITUDE: return "KIND_STREAM_ALTITUDE";
621 case KIND_OBSTACLE_ALTITUDE: return "KIND_OBSTACLE_ALTITUDE";
622 case KIND_STRICKLER_TABLE: return "KIND_STRICKLER_TABLE";
623 case KIND_LAND_COVER: return "KIND_LAND_COVER";
624 case KIND_LAND_COVER_MAP: return "KIND_LAND_COVER_MAP";
625 default: return "KIND_UNKNOWN"; ///! Unrecognized object
629 void HYDROData_Entity::setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
630 QStringList& theScript,
631 const Handle(HYDROData_Entity)& theRefObject,
632 const QString& theMethod ) const
634 if ( !checkObjectPythonDefinition( theTreatedObjects, theScript, theRefObject ) )
637 QString aRefObjName = theRefObject->GetObjPyName();
639 QString anObjName = GetObjPyName();
640 theScript << QString( "%1.%2( %3 );" )
641 .arg( anObjName ).arg( theMethod ).arg( aRefObjName );
644 bool HYDROData_Entity::checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
645 QStringList& theScript,
646 const Handle(HYDROData_Entity)& theRefObject ) const
648 if ( theRefObject.IsNull() )
651 QString aRefObjName = theRefObject->GetName();
652 if ( aRefObjName.isEmpty() )
655 if ( theTreatedObjects.contains( aRefObjName ) )
658 // The definition of reference object must be dumped before this
659 QStringList aRefObjDump = theRefObject->DumpToPython( theTreatedObjects );
660 if ( aRefObjDump.isEmpty() )
663 QStringList aTmpList = theScript;
664 theScript = aRefObjDump;
666 theScript << QString( "" );
667 theScript << aTmpList;
669 theTreatedObjects.insert( aRefObjName, theRefObject );
674 void HYDROData_Entity::setPythonObjectColor( QStringList& theScript,
675 const QColor& theColor,
676 const QColor& theDefaultColor,
677 const QString& theMethod ) const
679 if ( theColor == theDefaultColor )
680 return; //Do not set the color for object if it like default
682 QString anObjName = GetObjPyName();
683 theScript << QString( "%1.%2( QColor( %3, %4, %5, %6 ) );" )
684 .arg( anObjName ).arg( theMethod )
685 .arg( theColor.red() ).arg( theColor.green() )
686 .arg( theColor.blue() ).arg( theColor.alpha() );
689 void HYDROData_Entity::findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
690 QStringList& theScript ) const
692 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
693 if ( aDocument.IsNull() )
696 theScript << QString( "%1 = %2.FindObjectByName( \"%3\" );" ).arg( GetObjPyName() )
697 .arg( aDocument->GetDocPyName() )