src/HYDROData/HYDROData_Object.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_Object.h"
  20
  21 #include "HYDROData_DummyObject3D.h"
  22 #include "HYDROData_ShapesGroup.h"
  23 #include "HYDROData_Tool.h"
  24 #include "HYDROData_Iterator.h"
  25 #include "HYDROData_IAltitudeObject.h"
  26
  27 #include <TNaming_Builder.hxx>
  28 #include <TNaming_NamedShape.hxx>
  29
  30 #include <TopoDS_Shape.hxx>
  31 #include <TDataStd_Integer.hxx>
  32
  33 #include <QColor>
  34
  35 IMPLEMENT_STANDARD_HANDLE(HYDROData_Object,HYDROData_Entity)
  36 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Object,HYDROData_Entity)
  37
  38 HYDROData_Object::HYDROData_Object()
  39 : HYDROData_Entity()
  40 {
  41 }
  42
  43 HYDROData_Object::~HYDROData_Object()
  44 {
  45 }
  46
  47 void HYDROData_Object::SetName( const QString& theName )
  48 {
  49   QString anOldObjName = GetName();
  50   if ( anOldObjName != theName )
  51   {
  52     HYDROData_SequenceOfObjects aGroups = GetGroups();
  53     HYDROData_SequenceOfObjects::Iterator anIter( aGroups );
  54     for ( ; anIter.More(); anIter.Next() )
  55     {
  56       Handle(HYDROData_ShapesGroup) aGroup =
  57         Handle(HYDROData_ShapesGroup)::DownCast( anIter.Value() );
  58       if ( aGroup.IsNull() )
  59         continue;
  60
  61       HYDROData_Tool::UpdateChildObjectName( anOldObjName, theName, aGroup );
  62     }
  63
  64     Handle(HYDROData_DummyObject3D) anObject3D = GetObject3D();
  65     if ( !anObject3D.IsNull() )
  66       HYDROData_Tool::UpdateChildObjectName( anOldObjName, theName, anObject3D );
  67
  68     Handle(HYDROData_IAltitudeObject) anAltitudeObj = getChildAltitudeObject();
  69     if ( !anAltitudeObj.IsNull() )
  70       HYDROData_Tool::UpdateChildObjectName( anOldObjName, theName, anAltitudeObj );
  71   }
  72
  73   HYDROData_Entity::SetName( theName );
  74 }
  75
  76 void HYDROData_Object::Update()
  77 {
  78   removeTopShape();
  79   removeShape3D();
  80   removeGroupObjects();
  81   checkAndSetAltitudeObject();
  82   HYDROData_Entity::Update();
  83 }
  84
  85 HYDROData_SequenceOfObjects HYDROData_Object::GetAllReferenceObjects() const
  86 {
  87   HYDROData_SequenceOfObjects aResSeq = HYDROData_Entity::GetAllReferenceObjects();
  88
  89   Handle(HYDROData_IAltitudeObject) aRefAltitude = GetAltitudeObject();
  90   if ( !aRefAltitude.IsNull() )
  91     aResSeq.Append( aRefAltitude );
  92
  93   return aResSeq;
  94 }
  95
  96 void HYDROData_Object::SetToUpdate( bool theFlag )
  97 {
  98   HYDROData_Entity::SetToUpdate( theFlag );
  99
 100   Handle(HYDROData_DummyObject3D) anObject3D = GetObject3D();
 101   if ( !anObject3D.IsNull() )
 102     anObject3D->SetToUpdate( theFlag );
 103 }
 104
 105 void HYDROData_Object::SetTopShape( const TopoDS_Shape& theShape )
 106 {
 107   TNaming_Builder aBuilder( myLab.FindChild( DataTag_TopShape ) );
 108   aBuilder.Generated( theShape );
 109 }
 110
 111 void HYDROData_Object::SetShape3D( const TopoDS_Shape& theShape )
 112 {
 113   TNaming_Builder aBuilder( myLab.FindChild( DataTag_Shape3D ) );
 114   aBuilder.Generated( theShape );
 115
 116   // Check the object 3D existance
 117   checkAndSetObject3D();
 118 }
 119
 120 Handle(HYDROData_DummyObject3D) HYDROData_Object::GetObject3D() const
 121 {
 122   Handle(HYDROData_DummyObject3D) anObject;
 123
 124   TDF_Label aLabel = myLab.FindChild( DataTag_Object3D, false );
 125   if ( !aLabel.IsNull() )
 126   {
 127     TDF_Label aChildLabel = aLabel.FindChild( 0, false );
 128     if ( !aChildLabel.IsNull() )
 129     {
 130       anObject = Handle(HYDROData_DummyObject3D)::DownCast(
 131         HYDROData_Iterator::Object( aChildLabel ) );
 132     }
 133   }
 134
 135   return anObject;
 136 }
 137
 138 void HYDROData_Object::checkAndSetObject3D()
 139 {
 140   TDF_Label aLabel = myLab.FindChild( DataTag_Object3D, false );
 141   if ( !aLabel.IsNull() )
 142     return;
 143
 144   TDF_Label aChildLabel = myLab.FindChild( DataTag_Object3D ).FindChild( 0 );
 145   HYDROData_Iterator::CreateObject( aChildLabel, KIND_DUMMY_3D );
 146 }
 147
 148 HYDROData_SequenceOfObjects HYDROData_Object::GetGroups() const
 149 {
 150   return GetReferenceObjects( DataTag_EdgesGroup );
 151 }
 152
 153 Handle(HYDROData_ShapesGroup) HYDROData_Object::GetGroup( const int theGroupId ) const
 154 {
 155   Handle(HYDROData_ShapesGroup) aResGroup;
 156
 157   HYDROData_SequenceOfObjects aGroups = GetGroups();
 158   if ( theGroupId < 0 || theGroupId >= aGroups.Length() )
 159     return aResGroup;
 160
 161   aResGroup = Handle(HYDROData_ShapesGroup)::DownCast( aGroups.Value( theGroupId + 1 ) );
 162
 163   return aResGroup;
 164 }
 165
 166 int HYDROData_Object::GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const
 167 {
 168   int aRes = -1;
 169
 170   HYDROData_SequenceOfObjects aGroups = GetGroups();
 171   for ( int i = 1, n = aGroups.Length(); i <= n; ++i )
 172   {
 173     Handle(HYDROData_ShapesGroup) aGroup =
 174       Handle(HYDROData_ShapesGroup)::DownCast( aGroups.Value( i ) );
 175     if ( IsEqual( theGroup, aGroup ) )
 176     {
 177       aRes = i - 1;
 178       break;
 179     }
 180   }
 181
 182   return aRes;
 183 }
 184
 185 bool HYDROData_Object::SetAltitudeObject(
 186   const Handle(HYDROData_IAltitudeObject)& theAltitude )
 187 {
 188   if ( theAltitude.IsNull() )
 189     return false;
 190
 191   Handle(HYDROData_IAltitudeObject) aPrevAltitude = GetAltitudeObject();
 192   if ( IsEqual( aPrevAltitude, theAltitude ) )
 193     return true;
 194
 195   SetReferenceObject( theAltitude, DataTag_AltitudeObject );
 196
 197   // Indicate model of the need to update object
 198   SetToUpdate( true );
 199
 200   return true;
 201 }
 202
 203 Handle(HYDROData_IAltitudeObject) HYDROData_Object::GetAltitudeObject() const
 204 {
 205   return Handle(HYDROData_IAltitudeObject)::DownCast(
 206            GetReferenceObject( DataTag_AltitudeObject ) );
 207 }
 208
 209 void HYDROData_Object::RemoveAltitudeObject()
 210 {
 211   Handle(HYDROData_IAltitudeObject) aPrevAltitude = GetAltitudeObject();
 212   if ( aPrevAltitude.IsNull() )
 213     return;
 214
 215   ClearReferenceObjects( DataTag_AltitudeObject );
 216
 217   // Indicate model of the need to update object
 218   SetToUpdate( true );
 219 }
 220
 221 void HYDROData_Object::SetFillingColor( const QColor& theColor )
 222 {
 223   SetColor( theColor, DataTag_FillingColor );
 224 }
 225
 226 QColor HYDROData_Object::GetFillingColor() const
 227 {
 228   return GetColor( getDefaultFillingColor(), DataTag_FillingColor );
 229 }
 230
 231 void HYDROData_Object::SetBorderColor( const QColor& theColor )
 232 {
 233   SetColor( theColor, DataTag_BorderColor );
 234 }
 235
 236 QColor HYDROData_Object::GetBorderColor() const
 237 {
 238   return GetColor( getDefaultBorderColor(), DataTag_BorderColor );
 239 }
 240
 241 QColor HYDROData_Object::getDefaultFillingColor() const
 242 {
 243   return QColor( Qt::yellow );
 244 }
 245
 246 QColor HYDROData_Object::getDefaultBorderColor() const
 247 {
 248   return QColor( Qt::transparent );
 249 }
 250
 251 QStringList HYDROData_Object::dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const
 252 {
 253   QStringList aResList = HYDROData_Entity::dumpObjectCreation( theTreatedObjects );
 254   if ( aResList.isEmpty() )
 255     return aResList; //Object was not created
 256
 257   QStringList aColorsDef;
 258
 259   QColor aFillingColor = GetFillingColor();
 260   setPythonObjectColor( aColorsDef, aFillingColor, getDefaultFillingColor(), "SetFillingColor" );
 261
 262   QColor aBorderColor = GetBorderColor();
 263   setPythonObjectColor( aColorsDef, aBorderColor, getDefaultBorderColor(), "SetBorderColor" );
 264
 265   if ( !aColorsDef.isEmpty() )
 266   {
 267     aResList << aColorsDef;
 268     aResList << QString( "" );
 269   }
 270
 271   return aResList;
 272 }
 273
 274 ObjectKind HYDROData_Object::getAltitudeObjectType() const
 275 {
 276   return KIND_UNKNOWN;
 277 }
 278
 279 Handle(HYDROData_IAltitudeObject) HYDROData_Object::getChildAltitudeObject() const
 280 {
 281   Handle(HYDROData_IAltitudeObject) anObject;
 282
 283   TDF_Label aLabel = myLab.FindChild( DataTag_ChildAltitudeObject, false );
 284   if ( !aLabel.IsNull() )
 285   {
 286     TDF_Label aChildLabel = aLabel.FindChild( 0, false );
 287     if ( !aChildLabel.IsNull() )
 288     {
 289       anObject = Handle(HYDROData_IAltitudeObject)::DownCast(
 290         HYDROData_Iterator::Object( aChildLabel ) );
 291     }
 292   }
 293
 294   return anObject;
 295 }
 296
 297 void HYDROData_Object::checkAndSetAltitudeObject()
 298 {
 299   Handle(HYDROData_Document) aDocument = HYDROData_Document::Document( myLab );
 300
 301   ObjectKind anAltitudeObjectType = getAltitudeObjectType();
 302   if ( anAltitudeObjectType == KIND_UNKNOWN )
 303     return; // No need to create altitude object
 304
 305   TDF_Label aLabel = myLab.FindChild( DataTag_ChildAltitudeObject, false );
 306   if ( !aLabel.IsNull() )
 307     return;
 308
 309   TDF_Label aChildLabel = myLab.FindChild( DataTag_ChildAltitudeObject ).FindChild( 0 );
 310
 311   Handle(HYDROData_IAltitudeObject) anAltitudeObject =
 312     Handle(HYDROData_IAltitudeObject)::DownCast(
 313       HYDROData_Iterator::CreateObject( aChildLabel, anAltitudeObjectType ) );
 314
 315   QString anAltitudePref = GetName() + "_Altitude";
 316   QString anAltitudeName = HYDROData_Tool::GenerateObjectName( aDocument, anAltitudePref );
 317   anAltitudeObject->SetName( anAltitudeName );
 318
 319   SetAltitudeObject( anAltitudeObject );
 320 }
 321
 322 Handle(HYDROData_ShapesGroup) HYDROData_Object::createGroupObject()
 323 {
 324   TDF_Label aNewLab = myLab.FindChild( DataTag_EdgesGroup ).NewChild();
 325
 326   Handle(HYDROData_ShapesGroup) aNewGroup =
 327     Handle(HYDROData_ShapesGroup)::DownCast( HYDROData_Iterator::CreateObject( aNewLab, KIND_SHAPES_GROUP ) );
 328   AddReferenceObject( aNewGroup, DataTag_EdgesGroup );
 329
 330   return aNewGroup;
 331 }
 332
 333 void HYDROData_Object::removeGroupObjects()
 334 {
 335   TDF_Label aLabel = myLab.FindChild( DataTag_EdgesGroup, false );
 336   if ( !aLabel.IsNull() )
 337     aLabel.ForgetAllAttributes();
 338 }
 339
 340 TopoDS_Shape HYDROData_Object::getTopShape() const
 341 {
 342   TDF_Label aLabel = myLab.FindChild( DataTag_TopShape, false );
 343   if ( !aLabel.IsNull() )
 344   {
 345     Handle(TNaming_NamedShape) aNamedShape;
 346     if( aLabel.FindAttribute( TNaming_NamedShape::GetID(), aNamedShape ) )
 347       return aNamedShape->Get();
 348   }
 349
 350   return TopoDS_Shape();
 351 }
 352
 353 void HYDROData_Object::removeTopShape()
 354 {
 355   TDF_Label aLabel = myLab.FindChild( DataTag_TopShape, false );
 356   if ( !aLabel.IsNull() )
 357     aLabel.ForgetAllAttributes();
 358 }
 359
 360 TopoDS_Shape HYDROData_Object::getShape3D() const
 361 {
 362   TDF_Label aLabel = myLab.FindChild( DataTag_Shape3D, false );
 363   if ( !aLabel.IsNull() )
 364   {
 365     Handle(TNaming_NamedShape) aNamedShape;
 366     if( aLabel.FindAttribute( TNaming_NamedShape::GetID(), aNamedShape ) )
 367       return aNamedShape->Get();
 368   }
 369
 370   return TopoDS_Shape();
 371 }
 372
 373 void HYDROData_Object::removeShape3D()
 374 {
 375   TDF_Label aLabel = myLab.FindChild( DataTag_Shape3D, false );
 376   if ( !aLabel.IsNull() )
 377     aLabel.ForgetAllAttributes();
 378 }
 379
 380 bool HYDROData_Object::IsSubmersible() const
 381 {
 382   Handle(TDataStd_Integer) aSubMersibleAttr;
 383
 384   bool isSubmersible = true; //default
 385   if( myLab.FindAttribute(TDataStd_Integer::GetID(), aSubMersibleAttr ) )
 386   {
 387     int aValue = aSubMersibleAttr->Get();
 388     isSubmersible = ( aValue != 0 );
 389   }
 390   return isSubmersible;
 391 }
 392
 393 void HYDROData_Object::SetIsSubmersible( bool isSubmersible ) const
 394 {
 395   TDataStd_Integer::Set( myLab, isSubmersible ? 1 : 0 );
 396 }