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 #include <TopoDS_Shape.hxx>
  27 #include <TDataStd_Integer.hxx>
  28 #include <TDataStd_Real.hxx>
  29
  30 #include <QColor>
  31
  32 //#define _DEVDEBUG_
  33 #include "HYDRO_trace.hxx"
  34
  35 IMPLEMENT_STANDARD_RTTIEXT(HYDROData_Object,HYDROData_Entity)
  36
  37 HYDROData_Object::HYDROData_Object( Geometry theGeometry )
  38   : HYDROData_Entity( theGeometry )
  39 {
  40 }
  41
  42 HYDROData_Object::~HYDROData_Object()
  43 {
  44 }
  45
  46 void HYDROData_Object::SetName( const QString& theName )
  47 {
  48   //DEBTRACE("SetName");
  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   DEBTRACE("Update");
  79   if( IsMustBeUpdated( Geom_2d ) )
  80   {
  81     RemoveTopShape();
  82     RemoveGroupObjects();
  83   }
  84   if( IsMustBeUpdated( Geom_3d ) )
  85     RemoveShape3D();
  86
  87   checkAndSetAltitudeObject();
  88   HYDROData_Entity::Update();
  89 }
  90
  91 HYDROData_SequenceOfObjects HYDROData_Object::GetAllReferenceObjects() const
  92 {
  93   //DEBTRACE("GetAllReferenceObjects");
  94   HYDROData_SequenceOfObjects aResSeq = HYDROData_Entity::GetAllReferenceObjects();
  95
  96   Handle(HYDROData_IAltitudeObject) aRefAltitude = GetAltitudeObject();
  97   if ( !aRefAltitude.IsNull() )
  98     aResSeq.Append( aRefAltitude );
  99
 100   return aResSeq;
 101 }
 102
 103 void HYDROData_Object::Changed( Geometry theChangedGeometry )
 104 {
 105   DEBTRACE("Changed");
 106   HYDROData_Entity::Changed( theChangedGeometry );
 107
 108   Handle(HYDROData_DummyObject3D) anObject3D = GetObject3D();
 109   if ( !anObject3D.IsNull() )
 110     anObject3D->Changed( theChangedGeometry );
 111 }
 112
 113 void HYDROData_Object::SetTopShape( const TopoDS_Shape& theShape )
 114 {
 115   DEBTRACE("SetTopShape");
 116   HYDROData_Entity::SetShape( DataTag_TopShape, theShape );
 117 }
 118
 119 TopoDS_Shape HYDROData_Object::GetTopShape() const
 120 {
 121   //DEBTRACE("GetTopShape");
 122   return HYDROData_Entity::GetShape( DataTag_TopShape );
 123 }
 124
 125 void HYDROData_Object::SetShape3D( const TopoDS_Shape& theShape )
 126 {
 127   DEBTRACE("SetShape3D");
 128   HYDROData_Entity::SetShape( DataTag_Shape3D, theShape );
 129   // Check the object 3D existance
 130   checkAndSetObject3D();
 131 }
 132
 133 TopoDS_Shape HYDROData_Object::GetShape3D() const
 134 {
 135   //DEBTRACE("GetShape3D");
 136   return HYDROData_Entity::GetShape( DataTag_Shape3D );
 137 }
 138
 139 Handle(HYDROData_DummyObject3D) HYDROData_Object::GetObject3D() const
 140 {
 141   //DEBTRACE("GetObject3D");
 142   Handle(HYDROData_DummyObject3D) anObject;
 143
 144   TDF_Label aLabel = myLab.FindChild( DataTag_Object3D, false );
 145   if ( !aLabel.IsNull() )
 146   {
 147     TDF_Label aChildLabel = aLabel.FindChild( 0, false );
 148     if ( !aChildLabel.IsNull() )
 149     {
 150       anObject = Handle(HYDROData_DummyObject3D)::DownCast(
 151         HYDROData_Iterator::Object( aChildLabel ) );
 152     }
 153   }
 154
 155   return anObject;
 156 }
 157
 158 void HYDROData_Object::checkAndSetObject3D()
 159 {
 160   DEBTRACE("checkAndSetObject3D");
 161   TDF_Label aLabel = myLab.FindChild( DataTag_Object3D, false );
 162   if ( !aLabel.IsNull() )
 163     return;
 164
 165   TDF_Label aChildLabel = myLab.FindChild( DataTag_Object3D ).FindChild( 0 );
 166   HYDROData_Iterator::CreateObject( aChildLabel, KIND_DUMMY_3D );
 167 }
 168
 169 HYDROData_SequenceOfObjects HYDROData_Object::GetGroups() const
 170 {
 171   //DEBTRACE("GetGroups");
 172   return GetReferenceObjects( DataTag_EdgesGroup );
 173 }
 174
 175 Handle(HYDROData_ShapesGroup) HYDROData_Object::GetGroup( const int theGroupId ) const
 176 {
 177   //DEBTRACE("GetGroup");
 178   Handle(HYDROData_ShapesGroup) aResGroup;
 179
 180   HYDROData_SequenceOfObjects aGroups = GetGroups();
 181   if ( theGroupId < 0 || theGroupId >= aGroups.Length() )
 182     return aResGroup;
 183
 184   aResGroup = Handle(HYDROData_ShapesGroup)::DownCast( aGroups.Value( theGroupId + 1 ) );
 185
 186   return aResGroup;
 187 }
 188
 189 int HYDROData_Object::GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const
 190 {
 191   //DEBTRACE("GetGroupId");
 192   int aRes = -1;
 193
 194   HYDROData_SequenceOfObjects aGroups = GetGroups();
 195   for ( int i = 1, n = aGroups.Length(); i <= n; ++i )
 196   {
 197     Handle(HYDROData_ShapesGroup) aGroup =
 198       Handle(HYDROData_ShapesGroup)::DownCast( aGroups.Value( i ) );
 199     if ( theGroup->CompareLabels ( aGroup ) )
 200     {
 201       aRes = i - 1;
 202       break;
 203     }
 204   }
 205
 206   return aRes;
 207 }
 208
 209 bool HYDROData_Object::SetAltitudeObject(
 210   const Handle(HYDROData_IAltitudeObject)& theAltitude )
 211 {
 212   DEBTRACE("SetAltitudeObject");
 213   if ( theAltitude.IsNull() )
 214     return false;
 215
 216   Handle(HYDROData_IAltitudeObject) aPrevAltitude = GetAltitudeObject();
 217   if (!aPrevAltitude.IsNull())
 218     DEBTRACE("aPrevAltitude: " << aPrevAltitude->GetName())
 219   DEBTRACE("theAltitude: " << theAltitude->GetName())
 220   if ( IsEqual( aPrevAltitude, theAltitude ) )
 221     return true;
 222
 223   SetReferenceObject( theAltitude, DataTag_AltitudeObject );
 224
 225   // #636: In the case of the altitude object change the geometry of the main object is not changed,
 226   // to the object should not be marked as updated
 227   //SetToUpdate( true );
 228
 229   return true;
 230 }
 231
 232 Handle(HYDROData_IAltitudeObject) HYDROData_Object::GetAltitudeObject() const
 233 {
 234   //DEBTRACE("GetAltitudeObject");
 235   return Handle(HYDROData_IAltitudeObject)::DownCast(
 236            GetReferenceObject( DataTag_AltitudeObject ) );
 237 }
 238
 239 void HYDROData_Object::RemoveAltitudeObject()
 240 {
 241   DEBTRACE("RemoveAltitudeObject");
 242   Handle(HYDROData_IAltitudeObject) aPrevAltitude = GetAltitudeObject();
 243   if ( aPrevAltitude.IsNull() )
 244     return;
 245   DEBTRACE("aPrevAltitude: " << aPrevAltitude->GetName())
 246   ClearReferenceObjects( DataTag_AltitudeObject );
 247
 248   // #636: In the case of the altitude object change the geometry of the main object is not changed,
 249   // to the object should not be marked as updated
 250   //SetToUpdate( true );
 251 }
 252
 253 void HYDROData_Object::SetFillingColor( const QColor& theColor )
 254 {
 255   //DEBTRACE("SetFillingColor");
 256   SetColor( theColor, DataTag_FillingColor );
 257 }
 258
 259 QColor HYDROData_Object::GetFillingColor() const
 260 {
 261   //DEBTRACE("GetFillingColor");
 262   return GetColor( DefaultFillingColor(), DataTag_FillingColor );
 263 }
 264
 265 void HYDROData_Object::SetBorderColor( const QColor& theColor )
 266 {
 267   //DEBTRACE("SetBorderColor");
 268   SetColor( theColor, DataTag_BorderColor );
 269 }
 270
 271 QColor HYDROData_Object::GetBorderColor() const
 272 {
 273   //DEBTRACE("GetBorderColor");
 274   return GetColor( DefaultBorderColor(), DataTag_BorderColor );
 275 }
 276
 277 QColor HYDROData_Object::DefaultFillingColor() const
 278 {
 279   //DEBTRACE("DefaultFillingColor");
 280   return QColor( Qt::yellow );
 281 }
 282
 283 QColor HYDROData_Object::DefaultBorderColor() const
 284 {
 285   //DEBTRACE("DefaultBorderColor");
 286   return QColor( Qt::transparent );
 287 }
 288
 289 QStringList HYDROData_Object::dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const
 290 {
 291   DEBTRACE("dumpObjectCreation");
 292   QStringList aResList = HYDROData_Entity::dumpObjectCreation( theTreatedObjects );
 293   if ( aResList.isEmpty() )
 294     return aResList; //Object was not created
 295
 296   QStringList aColorsDef;
 297
 298   QColor aFillingColor = GetFillingColor();
 299   setPythonObjectColor( aColorsDef, aFillingColor, DefaultFillingColor(), "SetFillingColor" );
 300
 301   QColor aBorderColor = GetBorderColor();
 302   setPythonObjectColor( aColorsDef, aBorderColor, DefaultBorderColor(), "SetBorderColor" );
 303
 304   if ( !aColorsDef.isEmpty() )
 305   {
 306     aResList << aColorsDef;
 307     aResList << QString( "" );
 308   }
 309
 310   return aResList;
 311 }
 312
 313 ObjectKind HYDROData_Object::getAltitudeObjectType() const
 314 {
 315   return KIND_UNKNOWN;
 316 }
 317
 318 Handle(HYDROData_IAltitudeObject) HYDROData_Object::getChildAltitudeObject() const
 319 {
 320   //DEBTRACE("getChildAltitudeObject");
 321   Handle(HYDROData_IAltitudeObject) anObject;
 322
 323   TDF_Label aLabel = myLab.FindChild( DataTag_ChildAltitudeObject, false );
 324   if ( !aLabel.IsNull() )
 325   {
 326     TDF_Label aChildLabel = aLabel.FindChild( 0, false );
 327     if ( !aChildLabel.IsNull() )
 328     {
 329       anObject = Handle(HYDROData_IAltitudeObject)::DownCast(
 330         HYDROData_Iterator::Object( aChildLabel ) );
 331     }
 332   }
 333
 334   return anObject;
 335 }
 336
 337 void HYDROData_Object::checkAndSetAltitudeObject()
 338 {
 339   DEBTRACE("checkAndSetAltitudeObject");
 340   Handle(HYDROData_Document) aDocument = HYDROData_Document::Document();
 341
 342   ObjectKind anAltitudeObjectType = getAltitudeObjectType();
 343   DEBTRACE("HYDROData_Object::checkAndSetAltitudeObject anAltitudeObjectType="<< anAltitudeObjectType);
 344   if ( anAltitudeObjectType == KIND_UNKNOWN )
 345   {
 346     DEBTRACE("anAltitudeObjectType == KIND_UNKNOWN");
 347     return; // No need to create altitude object
 348   }
 349
 350   Handle(HYDROData_IAltitudeObject) altObject = GetAltitudeObject();
 351   if( !altObject.IsNull() )
 352       DEBTRACE(altObject->GetName());
 353   if( !altObject.IsNull() && altObject->GetKind()==anAltitudeObjectType )
 354     return;
 355
 356   TDF_Label aChildLabel = myLab.FindChild( DataTag_ChildAltitudeObject ).FindChild( 0 );
 357
 358   Handle(HYDROData_IAltitudeObject) anAltitudeObject =
 359     Handle(HYDROData_IAltitudeObject)::DownCast(
 360       HYDROData_Iterator::CreateObject( aChildLabel, anAltitudeObjectType ) );
 361
 362   QString anAltitudePref = GetName() + "_Altitude";
 363   DEBTRACE("anAltitudePref " << anAltitudePref.toStdString());
 364   QString anAltitudeName = HYDROData_Tool::GenerateObjectName( aDocument, anAltitudePref );
 365   anAltitudeObject->SetName( anAltitudeName );
 366
 367   SetAltitudeObject( anAltitudeObject );
 368 }
 369
 370 Handle(HYDROData_ShapesGroup) HYDROData_Object::createGroupObject()
 371 {
 372   DEBTRACE("createGroupObject");
 373   TDF_Label aNewLab = myLab.FindChild( DataTag_EdgesGroup ).NewChild();
 374
 375   Handle(HYDROData_ShapesGroup) aNewGroup =
 376     Handle(HYDROData_ShapesGroup)::DownCast( HYDROData_Iterator::CreateObject( aNewLab, KIND_SHAPES_GROUP ) );
 377   AddReferenceObject( aNewGroup, DataTag_EdgesGroup );
 378
 379   return aNewGroup;
 380 }
 381
 382 void HYDROData_Object::RemoveGroupObjects()
 383 {
 384   DEBTRACE("RemoveGroupObjects");
 385   TDF_Label aLabel = myLab.FindChild( DataTag_EdgesGroup, false );
 386   if ( !aLabel.IsNull() )
 387     aLabel.ForgetAllAttributes();
 388 }
 389
 390 void HYDROData_Object::RemoveTopShape()
 391 {
 392   DEBTRACE("RemoveTopShape");
 393   HYDROData_Entity::SetShape( DataTag_TopShape, TopoDS_Shape() );
 394 }
 395
 396 void HYDROData_Object::RemoveShape3D()
 397 {
 398   DEBTRACE("RemoveShape3D");
 399   HYDROData_Entity::SetShape( DataTag_Shape3D, TopoDS_Shape() );
 400 }
 401
 402 bool HYDROData_Object::IsSubmersible() const
 403 {
 404   //DEBTRACE("IsSubmersible");
 405   Handle(TDataStd_Integer) aSubMersibleAttr;
 406
 407   bool isSubmersible = true; //default
 408   if( myLab.FindAttribute(TDataStd_Integer::GetID(), aSubMersibleAttr ) )
 409   {
 410     int aValue = aSubMersibleAttr->Get();
 411     isSubmersible = ( aValue != 0 );
 412   }
 413   return isSubmersible;
 414 }
 415
 416 void HYDROData_Object::SetIsSubmersible( bool isSubmersible ) const
 417 {
 418   DEBTRACE("SetIsSubmersible");
 419   Handle(TDataStd_Integer) anAttr = TDataStd_Integer::Set( myLab, isSubmersible ? 1 : 0 );
 420   anAttr->SetID(TDataStd_Integer::GetID());
 421 }
 422
 423 void HYDROData_Object::GetBoundaries( QList<TopoDS_Shape>& theBoundShapes,
 424                                       QStringList& theBoundNames ) const
 425 {
 426   DEBTRACE("GetBoundaries");
 427   HYDROData_SequenceOfObjects aGroups = GetGroups();
 428     HYDROData_SequenceOfObjects::Iterator anIter( aGroups );
 429     for ( ; anIter.More(); anIter.Next() )
 430     {
 431       Handle(HYDROData_ShapesGroup) aGroup =
 432         Handle(HYDROData_ShapesGroup)::DownCast( anIter.Value() );
 433       if( aGroup.IsNull() )
 434         continue;
 435
 436       QString aName = aGroup->GetName();
 437       TopTools_SequenceOfShape aShapes;
 438       aGroup->GetShapes( aShapes );
 439       for( int i=1, n=aShapes.Length(); i<=n; i++ )
 440       {
 441         theBoundShapes.append( aShapes( i ) );
 442         theBoundNames.append( aName );
 443       }
 444     }
 445 }