refs #561: the draft data model for Strickler table

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

diff --git a/src/HYDROData/HYDROData_Polyline3D.h b/src/HYDROData/HYDROData_Polyline3D.h
index 73f21cbb8edc2ffced754e977156fdb7e432d881..77bd4d5d4710a85cf0eda5362fa27294d6702cf5 100644 (file)
--- a/src/HYDROData/HYDROData_Polyline3D.h
+++ b/src/HYDROData/HYDROData_Polyline3D.h
@@ -1,3 +1,36 @@
+// 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
+//
+
+// 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_Polyline3D_HeaderFile
 #define HYDROData_Polyline3D_HeaderFile
@@ -28,8 +61,9 @@ protected:
   enum DataTag
   {
     DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
-    DataTag_PolylineXY,     ///< reference hydraulic axis
-    DataTag_ProfileUZ,      ///< reference profiles
+    DataTag_PolylineXY,          ///< reference hydraulic axis
+    DataTag_ProfileUZ,           ///< reference profile
+    DataTag_ChildProfileUZ,      ///< reference profile
   };
 
 public:
@@ -45,6 +79,11 @@ public:
    */
   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
 
+  /**
+   * Returns the list of all reference objects of this object.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+
   /**
    * Returns the top shape of the object.
    */
@@ -61,6 +100,16 @@ public:
    */
   HYDRODATA_EXPORT virtual void Update();
 
+  /**
+   * Returns default filling color for new 3D polyline.
+   */
+  HYDRODATA_EXPORT static QColor DefaultFillingColor();
+
+  /**
+   * Returns default border color for new 3D polyline.
+   */
+  HYDRODATA_EXPORT static QColor DefaultBorderColor();
+
 
 public:      
   // Public methods to work with 3D polyline
@@ -68,7 +117,8 @@ public:
   /**
    * Sets reference x,y polyline object for 3D polyline.
    */
-  HYDRODATA_EXPORT virtual bool SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline );
+  HYDRODATA_EXPORT virtual bool SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline,
+                                               const bool                          theIsUpdateProfile = true );
 
   /**
    * Returns reference x,y polyline object of 3D polyline.
@@ -97,6 +147,57 @@ public:
   HYDRODATA_EXPORT virtual void RemoveProfileUZ();
 
 
+  /**
+   * Set reference bathymetry object for geometry object.
+   * Reimplemented to remove reference u,z profile.
+   */
+  HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
+
+  /**
+   * Clear the reference bathymetry object for geometry object.
+   * Reimplemented to remove child u,z profile.
+   */
+  HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
+
+
+  /**
+   * Returns the child u,z profile which has been generated from bathymetry.
+   */
+  HYDRODATA_EXPORT Handle(HYDROData_ProfileUZ) GetChildProfileUZ( const bool theIsCreate = true ) const;
+
+  /**
+   * Sets the child u,z profile for polyline.
+   */
+  HYDRODATA_EXPORT void SetChildProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );
+
+
+protected:
+
+  /**
+   * Returns default filling color for new object.
+   */
+  HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
+
+  /**
+   * Returns default border color for new object.
+   */
+  HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
+
+  /**
+   * Checks and if necessary create child 3D object.
+   * Reimplemented to prevent creation of 3D child object.
+   */
+  HYDRODATA_EXPORT virtual void checkAndSetObject3D() {}
+
+
+protected:
+
+
+  void updateChildProfilePoints();
+
+  void removeChildProfileUZ();
+
+
 protected:
 
   friend class HYDROData_Iterator;