Salome HOME
Additional minor fix of issue 0017431: unset the MODAL behavior for the 'Basic Proper...
[modules/geom.git] / src / GEOM / GEOM_Object.cxx
index 0fbfacbc774022dcfc4af9ff757e0505b4fbd80b..4a33133336deffc91f0a7948b6e4e1d313ba6a1c 100644 (file)
@@ -1,8 +1,27 @@
-using namespace std; 
-
-#include "GEOM_Object.hxx"
-#include "GEOM_Engine.hxx"
-#include "GEOM_Solver.hxx"
+// Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
+//
+// This library is distributed in the hope that it will be useful
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+#include <Standard_Stream.hxx>
+
+#include <GEOM_Object.hxx>
+#include <GEOM_Engine.hxx>
+#include <GEOM_Solver.hxx>
 #include <TDF_Tool.hxx>
 #include <TDF_Data.hxx>
 #include <TDF_Reference.hxx>
@@ -14,14 +33,19 @@ using namespace std;
 #include <TDataStd_UAttribute.hxx>
 #include <TDataStd_Name.hxx>
 #include <TDataStd_Comment.hxx>
+#include <TDataStd_RealArray.hxx>
+#include <TColStd_HArray1OfReal.hxx>
 #include <TCollection_AsciiString.hxx>
 #include <TCollection_ExtendedString.hxx>
 #include <TopTools_IndexedMapOfShape.hxx>
 #include <TopExp.hxx>
 
-#define TYPE 2
 #define FUNCTION_LABEL(theNb) (_label.FindChild(1).FindChild((theNb)))
+#define TYPE_LABEL 2
 #define FREE_LABEL 3
+#define TIC_LABEL  4
+#define COLOR_LABEL      5
+#define AUTO_COLOR_LABEL 6
 
 //=======================================================================
 //function : GetObjectID
@@ -31,7 +55,7 @@ const Standard_GUID& GEOM_Object::GetObjectID()
 {
   static Standard_GUID anObjectID("FF1BBB01-5D14-4df2-980B-3A668264EA16");
   return anObjectID;
-}    
+}
 
 //=======================================================================
 //function : GetSubShapeID
@@ -42,7 +66,7 @@ const Standard_GUID& GEOM_Object::GetSubShapeID()
   static Standard_GUID anObjectID("FF1BBB68-5D14-4df2-980B-3A668264EA16");
   return anObjectID;
 }
-              
+
 //=============================================================================
 /*!
  *  GetObject
@@ -60,11 +84,13 @@ Handle(GEOM_Object) GEOM_Object::GetObject(TDF_Label& theLabel)
 
   Handle(TDataStd_Integer) anID;
   if(!aDoc->Main().FindAttribute(TDataStd_Integer::GetID(), anID)) return NULL;
-  
+
 
   GEOM_Engine* anEngine=  GEOM_Engine::GetEngine();
   if(anEngine == NULL) return NULL;
-  return anEngine->GetObject(anID->Get(), anEntry.ToCString());
+  return anEngine->GetObject(anID->Get(), (char*) anEntry.ToCString());
+
+
 }
 
 //=============================================================================
@@ -75,20 +101,32 @@ Handle(GEOM_Object) GEOM_Object::GetObject(TDF_Label& theLabel)
 Handle(GEOM_Object) GEOM_Object::GetReferencedObject(TDF_Label& theLabel)
 {
   Handle(TDF_Reference) aRef;
-  if (!theLabel.FindAttribute(TDF_Reference::GetID(), aRef)) return NULL;
+  if (!theLabel.FindAttribute(TDF_Reference::GetID(), aRef)) {
+    return NULL;
+  }
+  
+  if(aRef.IsNull() || aRef->Get().IsNull()) {
+    return NULL;
+  }
+
 
   // Get TreeNode of a referenced function
   Handle(TDataStd_TreeNode) aT, aFather;
-  if (!TDataStd_TreeNode::Find(aRef->Get(), aT)) return NULL;
+  if (!TDataStd_TreeNode::Find(aRef->Get(), aT)) {
+    return NULL;
+  }
+
 
   // Get TreeNode of Object of the referenced function
   aFather = aT->Father();
-  if (aFather.IsNull()) return NULL;
+  if (aFather.IsNull()) {
+    return NULL;
+  }
 
   // Get label of the referenced object
   TDF_Label aLabel = aFather->Label();
-
   
+
   return GEOM_Object::GetObject(aLabel);
 }
 
@@ -98,9 +136,9 @@ Handle(GEOM_Object) GEOM_Object::GetReferencedObject(TDF_Label& theLabel)
  */
 //=============================================================================
 GEOM_Object::GEOM_Object(TDF_Label& theEntry)
-: _label(theEntry), _ior("") 
+: _label(theEntry), _ior("")
 {
-  if(!theEntry.FindAttribute(TDataStd_TreeNode::GetDefaultTreeID(), _root)) 
+  if(!theEntry.FindAttribute(TDataStd_TreeNode::GetDefaultTreeID(), _root))
     _root = TDataStd_TreeNode::Set(theEntry);
 }
 
@@ -110,14 +148,14 @@ GEOM_Object::GEOM_Object(TDF_Label& theEntry)
  */
 //=============================================================================
 GEOM_Object::GEOM_Object(TDF_Label& theEntry, int theType)
-: _label(theEntry), _ior("") 
+: _label(theEntry), _ior("")
 {
   theEntry.ForgetAllAttributes(Standard_True);
 
-  if(!theEntry.FindAttribute(TDataStd_TreeNode::GetDefaultTreeID(), _root)) 
+  if(!theEntry.FindAttribute(TDataStd_TreeNode::GetDefaultTreeID(), _root))
     _root = TDataStd_TreeNode::Set(theEntry);
 
-  TDataStd_Integer::Set(theEntry.FindChild(TYPE), theType);
+  TDataStd_Integer::Set(theEntry.FindChild(TYPE_LABEL), theType);
 
   TDataStd_UAttribute::Set(theEntry, GetObjectID());
 }
@@ -130,8 +168,8 @@ GEOM_Object::GEOM_Object(TDF_Label& theEntry, int theType)
 int GEOM_Object::GetType()
 {
   Handle(TDataStd_Integer) aType;
-  if(!_label.FindChild(TYPE).FindAttribute(TDataStd_Integer::GetID(), aType)) return -1;
-  
+  if(!_label.FindChild(TYPE_LABEL).FindAttribute(TDataStd_Integer::GetID(), aType)) return -1;
+
   return aType->Get();
 }
 
@@ -142,8 +180,57 @@ int GEOM_Object::GetType()
 //=============================================================================
 void GEOM_Object::SetType(int theType)
 {
-  TDataStd_Integer::Set(_label.FindChild(TYPE), theType);
-  return;
+  TDataStd_Integer::Set(_label.FindChild(TYPE_LABEL), theType);
+}
+
+
+//=============================================================================
+/*!
+ *  Returns modifications counter of this object.
+ *  Comparing this value with modifications counters of argument objects
+ *  (on which this object depends) we decide whether this object needs to be updated.
+ */
+//=============================================================================
+int GEOM_Object::GetTic()
+{
+  Handle(TDataStd_Integer) aTicAttr;
+  if (!_label.FindChild(TIC_LABEL).FindAttribute(TDataStd_Integer::GetID(), aTicAttr))
+    return 0;
+
+  return aTicAttr->Get();
+}
+
+//=============================================================================
+/*!
+ *  Set another value of modifications counter.
+ *
+ *  Use this method to update modifications counter of dependent object
+ *  to be equal to modifications counter of its argument.
+ *  This is commonly done in GEOM_Function::GetValue()
+ */
+//=============================================================================
+void GEOM_Object::SetTic(int theTic)
+{
+  TDataStd_Integer::Set(_label.FindChild(TIC_LABEL), theTic);
+}
+
+//=============================================================================
+/*!
+ *  Increment modifications counter to mark this object as modified.
+ *
+ *  Commonly called from GEOM_Function::SetValue()
+ */
+//=============================================================================
+void GEOM_Object::IncrementTic()
+{
+  TDF_Label aTicLabel = _label.FindChild(TIC_LABEL);
+
+  Standard_Integer aTic = 0;
+  Handle(TDataStd_Integer) aTicAttr;
+  if (aTicLabel.FindAttribute(TDataStd_Integer::GetID(), aTicAttr))
+    aTic = aTicAttr->Get();
+
+  TDataStd_Integer::Set(aTicLabel, aTic + 1);
 }
 
 
@@ -159,7 +246,7 @@ int GEOM_Object::GetDocID()
 
   Handle(TDataStd_Integer) anID;
   if(!aDoc->Main().FindAttribute(TDataStd_Integer::GetID(), anID)) return -1;
-  
+
   return anID->Get();
 }
 
@@ -177,7 +264,7 @@ TopoDS_Shape GEOM_Object::GetValue()
 
   if (!aFunction.IsNull())
     aShape = aFunction->GetValue();
-  
+
   return aShape;
 }
 
@@ -200,9 +287,71 @@ char* GEOM_Object::GetName()
 {
   Handle(TDataStd_Name) aNameAttr;
   if(!_label.FindAttribute(TDataStd_Name::GetID(), aNameAttr)) return NULL;
-  
+
   TCollection_AsciiString aName(aNameAttr->Get());
-  return aName.ToCString();
+  // do not return pointer of local variable
+  // return aName.ToCString();
+  // the following code could lead to memory leak, so take care about recieved pointer
+  return strdup(aName.ToCString());
+}
+
+//=============================================================================
+/*!
+ *  SetColor
+ */
+//=============================================================================
+void GEOM_Object::SetColor(const SALOMEDS::Color& theColor)
+{
+  Handle(TDataStd_RealArray) anArray = new TDataStd_RealArray();
+  anArray->Init( 1, 3 );
+  anArray->SetValue( 1, theColor.R );
+  anArray->SetValue( 2, theColor.G );
+  anArray->SetValue( 3, theColor.B );
+
+  Handle(TDataStd_RealArray) anAttr =
+    TDataStd_RealArray::Set(_label.FindChild(COLOR_LABEL), anArray->Lower(), anArray->Upper());
+  anAttr->ChangeArray(anArray->Array());
+}
+
+//=============================================================================
+/*!
+ *  GetColor
+ */
+//=============================================================================
+SALOMEDS::Color GEOM_Object::GetColor()
+{
+  Handle(TDataStd_RealArray) anArray;
+  bool isFound = _label.FindChild(COLOR_LABEL).FindAttribute(TDataStd_RealArray::GetID(), anArray);
+
+  SALOMEDS::Color aColor;
+  aColor.R = isFound ? anArray->Value( 1 ) : 0.f;
+  aColor.G = isFound ? anArray->Value( 2 ) : 0.f;
+  aColor.B = isFound ? anArray->Value( 3 ) : 0.f;
+
+  return aColor;
+}
+
+//=============================================================================
+/*!
+ *  SetAutoColor
+ */
+//=============================================================================
+void GEOM_Object::SetAutoColor(CORBA::Boolean theAutoColor)
+{
+  TDataStd_Integer::Set(_label.FindChild(AUTO_COLOR_LABEL), (int)theAutoColor);
+}
+
+//=============================================================================
+/*!
+ *  GetAutoColor
+ */
+//=============================================================================
+CORBA::Boolean GEOM_Object::GetAutoColor()
+{
+  Handle(TDataStd_Integer) anAutoColor;
+  if(!_label.FindChild(AUTO_COLOR_LABEL).FindAttribute(TDataStd_Integer::GetID(), anAutoColor)) return false;
+
+  return anAutoColor->Get();
 }
 
 //=============================================================================
@@ -220,13 +369,15 @@ void GEOM_Object::SetAuxData(const char* theData)
  *  GetAuxData
  */
 //=============================================================================
-char* GEOM_Object::GetAuxData()
+TCollection_AsciiString GEOM_Object::GetAuxData()
 {
+  TCollection_AsciiString aData;
+
   Handle(TDataStd_Comment) aCommentAttr;
-  if(!_label.FindAttribute(TDataStd_Comment::GetID(), aCommentAttr)) return NULL;
-  
-  TCollection_AsciiString aData(aCommentAttr->Get());
-  return aData.ToCString();
+  if (_label.FindAttribute(TDataStd_Comment::GetID(), aCommentAttr))
+    aData = aCommentAttr->Get();
+
+  return aData;
 }
 
 
@@ -234,11 +385,11 @@ char* GEOM_Object::GetAuxData()
 /*!
  *  IsSubShape
  */
-//============================================================================= 
+//=============================================================================
 bool GEOM_Object::IsMainShape()
 {
   Handle(GEOM_Function) aFunction = GetFunction(1);
-  if(aFunction == NULL || aFunction->GetDriverGUID() != GetSubShapeID()) return true;
+  if(aFunction.IsNull() || aFunction->GetDriverGUID() != GetSubShapeID()) return true; // mkr : IPAL9921
   return false;
 }
 
@@ -296,7 +447,7 @@ Handle(GEOM_Function) GEOM_Object::GetLastFunction()
 {
   Standard_Integer nb = GetNbFunctions();
   if(nb) return GetFunction(nb);
+
   return NULL;
 }
 
@@ -319,12 +470,14 @@ Handle(TColStd_HSequenceOfTransient) GEOM_Object::GetAllDependency()
   }
 
   Standard_Integer aLength = aSeq.Length();
-  if(aLength > 0) {    
+  if(aLength > 0) {
     anArray = new TColStd_HSequenceOfTransient;
-    for(Standard_Integer j =1; j<=aLength; j++)
-      anArray->Append(GetReferencedObject(aSeq(j)));
+    for(Standard_Integer j =1; j<=aLength; j++) {
+      Handle(GEOM_Object) aRefObj = GetReferencedObject(aSeq(j));
+      if(!aRefObj.IsNull()) anArray->Append(aRefObj);
+    }
   }
-  
+
   return anArray;
 }
 
@@ -364,15 +517,15 @@ TDF_Label GEOM_Object::GetFreeLabel()
 //=======================================================================
 //function :  GEOM_Object_Type_
 //purpose  :
-//======================================================================= 
+//=======================================================================
 Standard_EXPORT Handle_Standard_Type& GEOM_Object_Type_()
 {
 
   static Handle_Standard_Type aType1 = STANDARD_TYPE(MMgt_TShared);
-  if ( aType1.IsNull()) aType1 = STANDARD_TYPE(MMgt_TShared); 
+  if ( aType1.IsNull()) aType1 = STANDARD_TYPE(MMgt_TShared);
   static Handle_Standard_Type aType2 = STANDARD_TYPE(Standard_Transient);
   if ( aType2.IsNull()) aType2 = STANDARD_TYPE(Standard_Transient);
+
 
   static Handle_Standard_Transient _Ancestors[]= {aType1,aType2,NULL};
   static Handle_Standard_Type _aType = new Standard_Type("GEOM_Object",
@@ -386,7 +539,7 @@ Standard_EXPORT Handle_Standard_Type& GEOM_Object_Type_()
 //=======================================================================
 //function : DownCast
 //purpose  :
-//======================================================================= 
+//=======================================================================
 
 const Handle(GEOM_Object) Handle(GEOM_Object)::DownCast(const Handle(Standard_Transient)& AnObject)
 {