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