Salome HOME
Merge branch 'master' of https://git.salome-platform.org/git/modules/hydro
[modules/hydro.git] / src / HYDROData / HYDROData_PolylineXY.h
index 45ea7459654e8800e7663b331f880341c2389481..e052a1c3aac0af7c39db43bff214673031e70ab0 100644 (file)
@@ -1,3 +1,20 @@
+// 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_PolylineXY_HeaderFile
 #define HYDROData_PolylineXY_HeaderFile
@@ -7,8 +24,10 @@
 DEFINE_STANDARD_HANDLE(HYDROData_PolylineXY, HYDROData_IPolyline)
 
 class QPainterPath;
+class QTransform;
 class TopoDS_Wire;
 class gp_XYZ;
+class gp_Pnt;
 
 /**\class HYDROData_PolylineXY
  * \brief Class that stores/retreives information about the 
@@ -23,6 +42,7 @@ protected:
   enum DataTag
   {
     DataTag_First = HYDROData_IPolyline::DataTag_First + 100, ///< first tag, to reserve
+    DataTag_GeomObjectEntry,  ///< study entry of the imported GEOM object
   };
 
 public:
@@ -37,7 +57,21 @@ public:
   /**
    * Dump object to Python script representation.
    */
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
+                                                     MapOfTreatedObjects& theTreatedObjects ) const;
+
+  /**
+   * Update the wire contour on the basis of the polyline data.
+   * Call this method whenever you made changes for polyline data.
+   */
+  HYDRODATA_EXPORT virtual void Update();
+
+  HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
+
+  /**
+   * Checks that object has 2D presentation. Reimlemented to retun true.
+   */
+  HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 
   /**
    * Returns data of object wrapped to QVariant.
@@ -45,6 +79,15 @@ public:
    */
   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
 
+  /**
+   * Returns default wire color for new polyline.
+   */
+  HYDRODATA_EXPORT static QColor DefaultWireColor();
+
+  HYDRODATA_EXPORT bool IsCustom() const;
+  HYDRODATA_EXPORT bool GetIsInCustomFlag() const;
+  HYDRODATA_EXPORT void SetIsInCustomFlag( bool theValue );
+
 public:
 
   /**
@@ -57,28 +100,54 @@ public:
   /**
    * Returns the presentation of polyline section in Qt maner.
    */
-  HYDRODATA_EXPORT static QPainterPath BuildPainterPath( const SectionType&                  theType,
-                                                         const bool&                         theIsClosed,
-                                                         const NCollection_Sequence<gp_XYZ>& thePoints );
+  HYDRODATA_EXPORT static void BuildPainterPath( QPainterPath&                       thePath,
+                                                 const SectionType&                  theType,
+                                                 const bool&                         theIsClosed,
+                                                 const NCollection_Sequence<gp_XYZ>& thePoints );
 
 public:
 
   /**
-   * Returns the 3D presentation of all points.
+   * Imports shape from IOR.
+   * \param theIOR the IOR of Geom object
+   * \return \c true if shape has been successfully imported
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape();
+  HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
 
   /**
-   * Update the wire contour on the basis of the polyline data.
-   * Call this method whenever you made changes for polyline data.
+   * Stores the study entry of the imported GEOM object.
+   * \param theEntry GEOM object entry
    */
-  HYDRODATA_EXPORT virtual void Update();
+  HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
 
+  /**
+   * Returns the imported GEOM object entry.
+   */
+  HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
 
-   /**
+public:
+
+  /**
+   * Returns the 3D presentation of all points.
+   */
+  HYDRODATA_EXPORT virtual bool ImportShape( const TopoDS_Shape& theShape,
+                                             bool IsInterpolationAllowed = false,
+                                             double theDeviation = 1E-3 );
+
+  /**
+   * Returns flag indicating that polyline can be edited or not.
+   */
+  HYDRODATA_EXPORT virtual bool IsEditable() const;
+
+  
+  /**
    * Returns true if polyline is closed
+   * \param theIsSimpleCheck flag indicating the type of checking
+   *        - if true then all wires checked on closures
+   *        - if false then for positive result polyline should consist of
+   *          only one wire and which must be closed
    */
-  HYDRODATA_EXPORT bool IsClosed() const;
+  HYDRODATA_EXPORT bool IsClosed( const bool theIsSimpleCheck = true ) const;
 
    /**
    * Returns the distance beetwen first and point with index thePointIndex
@@ -187,6 +256,14 @@ public:
                                           const Point& thePoint,
                                           const int    thePointIndex );
 
+  /**
+   * Replaces point for section with index "theSectionIndex".
+   * \param theSectionIndex index of section
+   * \param thePoints new points
+   */
+  HYDRODATA_EXPORT virtual void SetPoints( const int         theSectionIndex,
+                                           const PointsList& thePoints );
+
   /**
    * Removes point from section with index "theSectionIndex".
    * \param theSectionIndex index of section
@@ -202,7 +279,7 @@ public:
    *                        only for section with this index
    * \return list of points
    */
-  HYDRODATA_EXPORT virtual PointsList GetPoints( const int theSectionIndex = -1 ) const;
+  HYDRODATA_EXPORT virtual PointsList GetPoints( const int theSectionIndex = -1, bool IsConvertToGlobal = false ) const;
 
 
   /**
@@ -212,6 +289,20 @@ public:
    */
   HYDRODATA_EXPORT virtual QPainterPath GetPainterPath() const;
 
+  /**
+   * Transform the polyline points.
+   * @param theTrsf the transformation
+   */
+  HYDRODATA_EXPORT void Transform( const QTransform& theTrsf );
+
+protected:
+
+  /**
+   * Sets the flag indicating that polyline can be edited or not.
+   */
+  HYDRODATA_EXPORT virtual void setEditable( const bool theIsEditable );
+
+  HYDRODATA_EXPORT void Interpolate();
 
 protected:
 
@@ -228,6 +319,9 @@ protected:
    * Destructs properties of the object and object itself, removes it from the document.
    */
   HYDRODATA_EXPORT ~HYDROData_PolylineXY();
+
+private:
+  bool myIsInCustomFlag;
 };
 
 #endif