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>
42 #include "HYDRO_trace.hxx"
44 static const Standard_GUID GUID_MUST_BE_UPDATED("80f2bb81-3873-4631-8ddd-940d2119f000");
46 IMPLEMENT_STANDARD_HANDLE(HYDROData_Entity,MMgt_TShared)
47 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Entity,MMgt_TShared)
49 // is equal function for unique object mapping
50 bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2)
52 if ( !theObj1.IsNull() && !theObj2.IsNull() )
53 return theObj1->Label() == theObj2->Label();
57 QString HYDROData_Entity::GetName() const
59 Handle(TDataStd_Name) aName;
60 if (myLab.FindAttribute(TDataStd_Name::GetID(), aName)) {
61 TCollection_AsciiString aStr(aName->Get());
62 return QString(aStr.ToCString());
67 QString HYDROData_Entity::GetObjPyName() const
69 QString aName = GetName();
70 aName.replace(QRegExp("[\\W]"), "_");
75 void HYDROData_Entity::SetName(const QString& theName)
77 TDataStd_Name::Set(myLab, TCollection_ExtendedString(theName.toLatin1().constData()));
80 QStringList HYDROData_Entity::DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const
82 QStringList anEmptyList;
86 void HYDROData_Entity::Update()
91 void HYDROData_Entity::UpdateLocalCS( double theDx, double theDy )
93 //On the base level no actions are necessary
96 bool HYDROData_Entity::IsHas2dPrs() const
101 void HYDROData_Entity::Show()
106 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
107 if ( aDocument.IsNull() )
110 aDocument->Show( this );
113 QVariant HYDROData_Entity::GetDataVariant()
118 void HYDROData_Entity::SetToUpdate( bool theFlag )
120 if ( IsMustBeUpdated() == theFlag )
125 TDataStd_UAttribute::Set( myLab, GUID_MUST_BE_UPDATED );
127 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
128 if ( !aDocument.IsNull() )
130 // Change the states of this and all depended objects
131 HYDROData_Tool::SetMustBeUpdatedObjects( aDocument );
136 myLab.ForgetAttribute( GUID_MUST_BE_UPDATED );
140 bool HYDROData_Entity::IsMustBeUpdated() const
142 return myLab.IsAttribute( GUID_MUST_BE_UPDATED );
145 bool HYDROData_Entity::CanBeUpdated() const
150 bool HYDROData_Entity::IsRemoved() const
152 return !myLab.HasAttribute();
155 void HYDROData_Entity::Remove()
157 return myLab.ForgetAllAttributes( true );
160 bool HYDROData_Entity::CanRemove()
165 HYDROData_Entity::HYDROData_Entity()
169 HYDROData_Entity::~HYDROData_Entity()
173 void HYDROData_Entity::CopyTo( const Handle(HYDROData_Entity)& theDestination ) const
175 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
176 if ( aDocument.IsNull() ) {
180 TDF_CopyLabel aCopy(myLab, theDestination->Label());
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 );
202 Handle(HYDROData_Entity) HYDROData_Entity::GetFatherObject() const
204 Handle(HYDROData_Entity) aFather;
206 if ( !myLab.IsNull() )
208 TDF_Label aFatherLabel = myLab.Father();
210 while ( aFather.IsNull() && !aFatherLabel.IsNull() && !aFatherLabel.IsRoot() )
212 aFather = HYDROData_Iterator::Object( aFatherLabel );
213 aFatherLabel = aFatherLabel.Father();
220 HYDROData_SequenceOfObjects HYDROData_Entity::GetAllReferenceObjects() const
222 return HYDROData_SequenceOfObjects();
225 Standard_Boolean HYDROData_Entity::GetZLevel( Standard_Integer& theLevel ) const
229 TDF_Label aLabel = myLab.FindChild( DataTag_ZLevel, false );
230 if ( !aLabel.IsNull() )
232 Handle(TDataStd_Integer) anIntVal;
233 if ( aLabel.FindAttribute( TDataStd_Integer::GetID(), anIntVal ) )
235 theLevel = anIntVal->Get();
236 return Standard_True;
240 return Standard_False;
243 void HYDROData_Entity::SetZLevel( const Standard_Integer& theLevel )
245 TDataStd_Integer::Set( myLab.FindChild( DataTag_ZLevel ), theLevel );
248 void HYDROData_Entity::RemoveZLevel()
250 TDF_Label aLabel = myLab.FindChild( DataTag_ZLevel, false );
251 if ( !aLabel.IsNull() )
252 aLabel.ForgetAllAttributes();
255 void HYDROData_Entity::SetLabel( const TDF_Label& theLabel )
260 void HYDROData_Entity::SaveByteArray( const int theTag,
264 TDF_Label aLab = theTag == 0 ? myLab : myLab.FindChild(theTag);
265 // array is empty, remove the attribute
267 aLab.ForgetAttribute(TDataStd_ByteArray::GetID());
270 // store data of image in byte array
271 Handle(TDataStd_ByteArray) aData;
272 if (!aLab.FindAttribute(TDataStd_ByteArray::GetID(), aData)) {
273 aData = TDataStd_ByteArray::Set(aLab, 1, theLen);
275 // copy bytes one by one
276 if (aData->Length() != theLen) {
277 Handle(TColStd_HArray1OfByte) aNewData = new TColStd_HArray1OfByte(1, theLen);
278 for(int a = 0; a < theLen; a++)
279 aNewData->SetValue(a + 1, theData[a]);
280 aData->ChangeArray(aNewData);
282 for(int a = 0; a < theLen; a++)
283 aData->SetValue(a + 1, theData[a]);
287 const char* HYDROData_Entity::ByteArray(const int theTag, int& theLen) const
289 TDF_Label aLab = theTag == 0 ? myLab : myLab.FindChild(theTag);
290 Handle(TDataStd_ByteArray) aData;
291 if (!aLab.FindAttribute(TDataStd_ByteArray::GetID(), aData))
292 return NULL; // return empty image if there is no array
293 theLen = aData->Length();
295 return (const char*)(&(aData->InternalArray()->ChangeArray1().ChangeValue(1)));
299 int HYDROData_Entity::NbReferenceObjects( const int theTag ) const
301 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
302 return aRefs.IsNull() ? 0 : aRefs->Extent();
305 bool HYDROData_Entity::HasReference( const Handle_HYDROData_Entity& theObj,
306 const int theTag ) const
308 if ( theObj.IsNull() )
311 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
312 if ( aRefs.IsNull() || aRefs->IsEmpty() )
315 TDF_ListIteratorOfLabelList aListIt( aRefs->List() );
316 for ( ; aListIt.More(); aListIt.Next() )
318 const TDF_Label& aRefLabel = aListIt.Value();
319 if ( theObj->Label() == aRefLabel )
326 void HYDROData_Entity::AddReferenceObject( const Handle_HYDROData_Entity& theObj,
329 if ( theObj.IsNull() )
332 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
333 aRefs->Append( theObj->Label() );
336 void HYDROData_Entity::SetReferenceObject( const Handle_HYDROData_Entity& theObj,
340 if ( theObj.IsNull() )
342 RemoveReferenceObject( theTag, theIndex );
346 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
348 if ( theIndex >= aRefs->Extent() )
350 aRefs->Append( theObj->Label() );
352 else if ( theIndex < 0 )
354 aRefs->Prepend( theObj->Label() );
358 RemoveReferenceObject( theTag, theIndex );
360 Handle(HYDROData_Entity) aBeforeObj = GetReferenceObject( theTag, theIndex );
362 aRefs = getReferenceList( theTag, true ); // because reference list can be removed
363 if ( !aBeforeObj.IsNull() )
364 aRefs->InsertBefore( theObj->Label(), aBeforeObj->Label() );
366 aRefs->Append( theObj->Label() );
370 void HYDROData_Entity::InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
372 const int theBeforeIndex )
374 if ( theObj.IsNull() )
377 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, true );
379 if ( theBeforeIndex >= aRefs->Extent() )
381 aRefs->Append( theObj->Label() );
383 else if ( theBeforeIndex < 0 )
385 aRefs->Prepend( theObj->Label() );
389 Handle(HYDROData_Entity) aBeforeObj = GetReferenceObject( theTag, theBeforeIndex );
390 if ( !aBeforeObj.IsNull() )
391 aRefs->InsertBefore( theObj->Label(), aBeforeObj->Label() );
393 aRefs->Append( theObj->Label() );
397 void HYDROData_Entity::SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
400 ClearReferenceObjects( theTag );
401 if ( theObjects.IsEmpty() )
404 HYDROData_SequenceOfObjects::Iterator anIter( theObjects );
405 for ( ; anIter.More(); anIter.Next() )
406 AddReferenceObject( anIter.Value(), theTag );
409 Handle(HYDROData_Entity) HYDROData_Entity::GetReferenceObject( const int theTag,
410 const int theIndex ) const
412 Handle(HYDROData_Entity) aRes;
414 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
415 if ( aRefs.IsNull() || theIndex < 0 || theIndex >= aRefs->Extent() )
418 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
419 for ( int anIndex = 0; anIndex != theIndex && anIter.More(); anIter.Next(), ++anIndex );
421 const TDF_Label& aRefLabel = anIter.Value();
422 aRes = HYDROData_Iterator::Object( aRefLabel );
427 HYDROData_SequenceOfObjects HYDROData_Entity::GetReferenceObjects( const int theTag ) const
429 HYDROData_SequenceOfObjects aRes;
431 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
432 if ( aRefs.IsNull() )
435 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
436 for ( ; anIter.More(); anIter.Next() )
438 const TDF_Label& aRefLabel = anIter.Value();
440 Handle(HYDROData_Entity) aRefObject = HYDROData_Iterator::Object( aRefLabel );
441 if ( aRefObject.IsNull() )
444 aRes.Append( aRefObject );
450 void HYDROData_Entity::RemoveReferenceObject( const TDF_Label& theRefLabel,
453 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
454 if ( aRefs.IsNull() )
457 if ( aRefs->Extent() == 1 )
459 // remove all if only one
460 ClearReferenceObjects( theTag );
464 aRefs->Remove( theRefLabel );
467 void HYDROData_Entity::RemoveReferenceObject( const int theTag,
470 Handle(TDataStd_ReferenceList) aRefs = getReferenceList( theTag, false );
471 if ( aRefs.IsNull() )
474 if ( aRefs->Extent() == 1 && theIndex == 0 )
476 // remove all if only one
477 ClearReferenceObjects( theTag );
482 TDF_ListIteratorOfLabelList anIter( aRefs->List() );
483 for ( ; anIndex != theIndex && anIter.More(); anIter.Next(), ++anIndex );
485 if ( anIndex != theIndex || !anIter.More() )
488 const TDF_Label& aRefLabel = anIter.Value();
489 aRefs->Remove( aRefLabel );
492 void HYDROData_Entity::ClearReferenceObjects( const int theTag )
494 TDF_Label aSetLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
495 aSetLabel.ForgetAttribute( TDataStd_ReferenceList::GetID() );
498 Handle(TDataStd_ReferenceList) HYDROData_Entity::getReferenceList( const int theTag,
499 const bool theIsCreate ) const
501 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
503 Handle(TDataStd_ReferenceList) aRefs;
504 if ( !aLabel.FindAttribute( TDataStd_ReferenceList::GetID(), aRefs ) && theIsCreate )
505 aRefs = TDataStd_ReferenceList::Set( aLabel );
510 void HYDROData_Entity::SetColor( const QColor& theColor,
513 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
515 Handle(TDataStd_IntegerArray) aColorArray;
516 if ( !aLabel.FindAttribute( TDataStd_IntegerArray::GetID(), aColorArray ) )
517 aColorArray = TDataStd_IntegerArray::Set( aLabel, 1, 4 );
519 aColorArray->SetValue( 1, theColor.red() );
520 aColorArray->SetValue( 2, theColor.green() );
521 aColorArray->SetValue( 3, theColor.blue() );
522 aColorArray->SetValue( 4, theColor.alpha() );
525 QColor HYDROData_Entity::GetColor( const QColor& theDefColor,
526 const int theTag ) const
528 QColor aResColor = theDefColor;
530 TDF_Label aLabel = theTag == 0 ? myLab : myLab.FindChild( theTag );
532 Handle(TDataStd_IntegerArray) aColorArray;
533 if ( aLabel.FindAttribute( TDataStd_IntegerArray::GetID(), aColorArray ) )
535 aResColor.setRed( aColorArray->Value( 1 ) );
536 aResColor.setGreen( aColorArray->Value( 2 ) );
537 aResColor.setBlue( aColorArray->Value( 3 ) );
538 aResColor.setAlpha( aColorArray->Value( 4 ) );
544 QStringList HYDROData_Entity::dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const
546 QStringList aResList;
548 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
549 if ( aDocument.IsNull() )
552 QString aDocName = aDocument->GetDocPyName();
553 QString aName = GetObjPyName();
555 aResList << QString( "%1 = %2.CreateObject( %3 );" )
556 .arg( aName ).arg( aDocName ).arg( getPyTypeID() );
557 aResList << QString( "%1.SetName( \"%2\" );" )
558 .arg( aName ).arg( GetName() );
559 aResList << QString( "" );
563 // Dump object z-level in viewer
564 Standard_Integer anObjZLevel = -1;
565 if ( GetZLevel( anObjZLevel ) )
567 aResList << QString( "%1.SetZLevel( %2 );" )
568 .arg( aName ).arg( anObjZLevel );
569 aResList << QString( "" );
576 QString HYDROData_Entity::getPyTypeID() const
578 DEBTRACE("HYDROData_Entity::getPyTypeID " << GetKind());
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 case KIND_CHANNEL_ALTITUDE: return "KIND_CHANNEL_ALTITUDE";
609 default: return "KIND_UNKNOWN"; ///! Unrecognized object
613 void HYDROData_Entity::setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
614 QStringList& theScript,
615 const Handle(HYDROData_Entity)& theRefObject,
616 const QString& theMethod ) const
618 if ( !checkObjectPythonDefinition( theTreatedObjects, theScript, theRefObject ) )
621 QString aRefObjName = theRefObject->GetObjPyName();
623 QString anObjName = GetObjPyName();
624 theScript << QString( "%1.%2( %3 );" )
625 .arg( anObjName ).arg( theMethod ).arg( aRefObjName );
628 bool HYDROData_Entity::checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
629 QStringList& theScript,
630 const Handle(HYDROData_Entity)& theRefObject ) const
632 if ( theRefObject.IsNull() )
635 QString aRefObjName = theRefObject->GetName();
636 if ( aRefObjName.isEmpty() )
639 if ( theTreatedObjects.contains( aRefObjName ) )
642 // The definition of reference object must be dumped before this
643 QStringList aRefObjDump = theRefObject->DumpToPython( theTreatedObjects );
644 if ( aRefObjDump.isEmpty() )
647 QStringList aTmpList = theScript;
648 theScript = aRefObjDump;
650 theScript << QString( "" );
651 theScript << aTmpList;
653 theTreatedObjects.insert( aRefObjName, theRefObject );
658 void HYDROData_Entity::setPythonObjectColor( QStringList& theScript,
659 const QColor& theColor,
660 const QColor& theDefaultColor,
661 const QString& theMethod ) const
663 if ( theColor == theDefaultColor )
664 return; //Do not set the color for object if it like default
666 QString anObjName = GetObjPyName();
667 theScript << QString( "%1.%2( QColor( %3, %4, %5, %6 ) );" )
668 .arg( anObjName ).arg( theMethod )
669 .arg( theColor.red() ).arg( theColor.green() )
670 .arg( theColor.blue() ).arg( theColor.alpha() );
673 void HYDROData_Entity::findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
674 QStringList& theScript ) const
676 Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
677 if ( aDocument.IsNull() )
680 theScript << QString( "%1 = %2.FindObjectByName( \"%3\" );" ).arg( GetObjPyName() )
681 .arg( aDocument->GetDocPyName() )