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