Merge remote-tracking branch 'origin/BR_SHP_FORMAT' into BR_v14_rc

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

diff --git a/src/HYDROData/HYDROData_Polyline.h b/src/HYDROData/HYDROData_Polyline.h
index 3906ac5321178f2b6b58676ff6162be212056750..ca7475c37c7cc1bb7dd0f379753e239a0af7ee6a 100755 (executable)
--- a/src/HYDROData/HYDROData_Polyline.h
+++ b/src/HYDROData/HYDROData_Polyline.h
@@ -1,3 +1,21 @@
+// 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_Polyline_HeaderFile
 #define HYDROData_Polyline_HeaderFile
 
@@ -9,9 +27,11 @@
 #include <QPainterPath>
 #include <QList>
 
+class TopoDS_Wire;
+
 DEFINE_STANDARD_HANDLE(HYDROData_Polyline, HYDROData_Object)
 
-struct PolylineSection
+struct HYDRODATA_EXPORT PolylineSection
 {
 public:
   enum SectionType{ SECTION_POLYLINE=0, SECTION_SPLINE=1 };
@@ -45,7 +65,8 @@ protected:
     DataTag_SectionsName,
     DataTag_SectionsClosed,
     DataTag_SectionsSize,
-    DataTag_SectionsType
+    DataTag_SectionsType,
+    DataTag_ZValue
   };
 
 public:
@@ -56,6 +77,16 @@ public:
    */
   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_POLYLINE;}
 
+  /**
+   * Returns the top shape of the object.
+   */
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
+
+  /**
+   * Returns the 3d shape of the object.
+   */
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
+
   /**
    * Dump object to Python script representation.
    */
@@ -71,42 +102,51 @@ public:
    * Replace current polyline data by new sections list
    * \param theSections the sections list
    */
-  HYDRODATA_EXPORT void setPolylineData( const PolylineData& theSections );
+  HYDRODATA_EXPORT void SetPolylineData( const PolylineData& theSections );
 
   /**
    * Return polyline data
    * \return polyline section list
    */
-  HYDRODATA_EXPORT PolylineData getPolylineData() const;
+  HYDRODATA_EXPORT PolylineData GetPolylineData() const;
    
   /**
    * Returns true if polyline is closed
    */
-  HYDRODATA_EXPORT bool isClosed() const;
+  HYDRODATA_EXPORT bool IsClosed() const;
 
   /**
    * Return polyline dimension
    * \return polyline dimension (2 or 3)
    */
-  HYDRODATA_EXPORT int getDimension() const;
+  HYDRODATA_EXPORT int GetDimension() const;
 
   /**
    * Set polyline dimension (2 or 3)
    * \param theDimension the polyline dimension
    */
-  HYDRODATA_EXPORT void setDimension( int theDimension );
+  HYDRODATA_EXPORT void SetDimension( int theDimension );
 
   /**
    * Remove all sections from polyline
    */
-  HYDRODATA_EXPORT void removeAll();
-
+  HYDRODATA_EXPORT void RemoveAll();
 
   /**
-   * Returns the painter path. The painter path is construct by lines
+   * Returns the painter path.
+   * Note: currently only the first section of the polyline data is taken into account.
    */
-  HYDRODATA_EXPORT QPainterPath painterPath() const;
+  HYDRODATA_EXPORT QPainterPath GetPainterPath() const;
 
+  HYDRODATA_EXPORT void   SetZValue( const double theZValue );
+  HYDRODATA_EXPORT double ZValue() const;
+
+protected:
+
+  /**
+   * Update the wire contour on the basis of the polyline data.
+   */
+  void UpdateWire( const PolylineData& theSections );
 
 protected:
 
@@ -116,12 +156,12 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDROData_Polyline();
+  HYDRODATA_EXPORT HYDROData_Polyline();
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
    */
-  ~HYDROData_Polyline();
+  HYDRODATA_EXPORT ~HYDROData_Polyline();
 };
 
 #endif