Merge branch 'BR_H2018_2' of https://codev-tuleap.cea.fr/plugins/git/salome/hydro...

[modules/hydro.git] / src / HYDROData / HYDROData_Object.h

diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h
index d59e4708578e863b336e6bd3048a4ace25aef553..e3646b21dc10311c3ca5548df119ef8a26e1944a 100644 (file)
--- a/src/HYDROData/HYDROData_Object.h
+++ b/src/HYDROData/HYDROData_Object.h
@@ -1,16 +1,30 @@
+// Copyright (C) 2014-2015  EDF-R&D
+// 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, or (at your option) any later version.
+//
+// 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
+//
 
 #ifndef HYDROData_Object_HeaderFile
 #define HYDROData_Object_HeaderFile
 
 #include <HYDROData_Entity.h>
 
-
-DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
-
 class TopoDS_Shape;
-class Handle(HYDROData_IAltitudeObject);
-class Handle(HYDROData_DummyObject3D);
-class Handle(HYDROData_ShapesGroup);
+class HYDROData_IAltitudeObject;
+class HYDROData_DummyObject3D;
+class HYDROData_ShapesGroup;
 
 /**\class HYDROData_Object
  * \brief The base class for all geometrical objects in the HYDRO module.
@@ -33,10 +47,11 @@ protected:
     DataTag_Object3D,            ///< child 3D object
     DataTag_EdgesGroup,          ///< child group objects
     DataTag_ChildAltitudeObject, ///< child altitude object
+    DataTag_IsSubmersible,       ///< the attribute "is submersible"
   };
 
 public:
-  DEFINE_STANDARD_RTTI(HYDROData_Object);
+  DEFINE_STANDARD_RTTIEXT(HYDROData_Object, HYDROData_Entity);
 
   /**
    * Updates the name of this object.
@@ -59,7 +74,7 @@ public:
    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
    * Reimplemented to update the state of child 3D object.
    */
-  HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
+  HYDRODATA_EXPORT virtual void Changed( Geometry );
 
 
   /**
@@ -70,7 +85,7 @@ public:
   /**
    * Returns the top shape of the object.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const = 0;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
 
   /**
    * Sets the 3d shape of the object.
@@ -80,9 +95,8 @@ public:
   /**
    * Returns the 3d shape of the object.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
 
-  
   /**
    * Returns reference object which represent the 3D shape of object.
    */
@@ -141,17 +155,11 @@ public:
    */
   HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
 
-protected:
-
-  /**
-   * Returns default filling color for new object.
-   */
-  HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
+  HYDRODATA_EXPORT bool IsSubmersible() const;
+  HYDRODATA_EXPORT void SetIsSubmersible( bool ) const;
 
-  /**
-   * Returns default border color for new object.
-   */
-  HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
+  HYDRODATA_EXPORT virtual void GetBoundaries( QList<TopoDS_Shape>& theBoundShapes,
+                                               QStringList& theBoundNames ) const;
 
 protected:
 
@@ -159,7 +167,7 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDRODATA_EXPORT HYDROData_Object();
+  HYDRODATA_EXPORT HYDROData_Object( Geometry );
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
@@ -167,6 +175,15 @@ protected:
   virtual HYDRODATA_EXPORT ~HYDROData_Object();
 
 protected:
+  HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
+  HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
+
+  /**
+   * Dump the initial object creation to a Python script.
+   * Reimplemented to dump the object colors.
+   */
+  HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
+
 
   /**
    * Checks and if necessary create child 3D object.
@@ -204,29 +221,17 @@ protected:
   /**
    * Remove all child group objects.
    */
-  HYDRODATA_EXPORT virtual void removeGroupObjects();
-
-
-  /**
-   * Retrieve the top shape of the object from data label.
-   */
-  HYDRODATA_EXPORT TopoDS_Shape getTopShape() const;
+  HYDRODATA_EXPORT virtual void RemoveGroupObjects();
 
   /**
    * Removes the top shape from data label of the object.
    */
-  HYDRODATA_EXPORT void removeTopShape();
-
-
-  /**
-   * Retrieve the 3d shape of the object from data label.
-   */
-  HYDRODATA_EXPORT TopoDS_Shape getShape3D() const;
+  HYDRODATA_EXPORT void RemoveTopShape();
 
   /**
    * Removes the 3d shape from data label of the object.
    */
-  HYDRODATA_EXPORT void removeShape3D();
+  HYDRODATA_EXPORT void RemoveShape3D();
 };
 
 #endif