Merge branch 'master' of ssh://git.salome-platform.org/modules/hydro

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

diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h
index 0e19876dcbfd7ea34af317416e94e731b7190253..5959a163b392bc2d702c4acec7c69733e2f9a8c8 100644 (file)
--- a/src/HYDROData/HYDROData_Object.h
+++ b/src/HYDROData/HYDROData_Object.h
@@ -1,3 +1,24 @@
+// Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  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, 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
@@ -27,11 +48,12 @@ protected:
     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
     DataTag_TopShape,
     DataTag_Shape3D,
-    DataTag_AltitudeObject,     ///< reference altitude object
-    DataTag_FillingColor,       ///< filling color of geometrical object
-    DataTag_BorderColor,        ///< border color of geometrical object
-    DataTag_Object3D,           ///< child 3D object
-    DataTag_EdgesGroup,         ///< child group objects
+    DataTag_AltitudeObject,      ///< reference altitude object
+    DataTag_FillingColor,        ///< filling color of geometrical object
+    DataTag_BorderColor,         ///< border color of geometrical object
+    DataTag_Object3D,            ///< child 3D object
+    DataTag_EdgesGroup,          ///< child group objects
+    DataTag_ChildAltitudeObject, ///< child altitude object
   };
 
 public:
@@ -87,11 +109,22 @@ public:
    */
   HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const;
 
+
   /**
    * Returns sequence of object groups.
    */
   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const;
 
+  /**
+   * Returns group data model object by it id.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) GetGroup( const int theGroupId ) const;
+
+  /**
+   * Returns group id by data model object.
+   */
+  HYDRODATA_EXPORT virtual int GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const;
+
 
   /**
    * Set reference altitude object for geometry object.
@@ -129,16 +162,6 @@ public:
    */
   HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
 
-  /**
-   * Returns default filling color for new object.
-   */
-  HYDRODATA_EXPORT static QColor DefaultFillingColor();
-
-  /**
-   * Returns default border color for new object.
-   */
-  HYDRODATA_EXPORT static QColor DefaultBorderColor();
-
 protected:
 
   /**
@@ -166,6 +189,13 @@ protected:
 
 protected:
 
+  /**
+   * 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.
    * Reimplement this function in your subclass if you 
@@ -175,15 +205,29 @@ protected:
 
 
   /**
-   * Create new one child group object.
+   * Returns the type of child altitude object.
+   * Base implementation returns KIND_UNKNOWN, it means that child altitude 
+   * object will not be created inside of checkAndSetAltitudeObject() function.
+   * Reimplement this function in your subclass an return correct altitude
+   * object type if you want to create child altitude object.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
+  HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 
   /**
-   * Create all necessary child group objects.
-   * Base implementation does nothing.
+   * Checks and if necessary create child altitude object.
    */
-  HYDRODATA_EXPORT virtual void createGroupObjects();
+  HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject();
+
+  /**
+   * Return the child altitude object.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const;
+
+
+  /**
+   * Create new one child group object.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
 
   /**
    * Remove all child group objects.