Salome HOME
refs #417: showing new objects
[modules/hydro.git] / src / HYDROData / HYDROData_PolylineXY.h
index 315fe7f1932d9988ca6ca8893b1040509df203d2..86ae8e54d2e3f836a68cf26c1d4523e0c9da5308 100644 (file)
@@ -7,6 +7,8 @@
 DEFINE_STANDARD_HANDLE(HYDROData_PolylineXY, HYDROData_IPolyline)
 
 class QPainterPath;
+class TopoDS_Wire;
+class gp_XYZ;
 
 /**\class HYDROData_PolylineXY
  * \brief Class that stores/retreives information about the 
@@ -21,6 +23,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,32 +40,101 @@ public:
    */
   HYDRODATA_EXPORT virtual QStringList DumpToPython( 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();
+
+  /**
+   * Checks that object has 2D presentation. Reimlemented to retun true.
+   */
+  HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
+
   /**
    * Returns data of object wrapped to QVariant.
    * Reimplemented to wrap and return saved path.
    */
   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
 
+  /**
+   * Returns default wire color for new polyline.
+   */
+  HYDRODATA_EXPORT static QColor DefaultWireColor();
+
+public:
+
+  /**
+   * Returns the presentation of polyline section in CAS maner.
+   */
+  HYDRODATA_EXPORT static TopoDS_Wire BuildWire( const SectionType&                  theType,
+                                                 const bool&                         theIsClosed,
+                                                 const NCollection_Sequence<gp_XYZ>& thePoints );
+
+  /**
+   * Returns the presentation of polyline section in Qt maner.
+   */
+  HYDRODATA_EXPORT static void BuildPainterPath( QPainterPath&                       thePath,
+                                                 const SectionType&                  theType,
+                                                 const bool&                         theIsClosed,
+                                                 const NCollection_Sequence<gp_XYZ>& thePoints );
+
 public:
 
+  /**
+   * Imports shape from IOR.
+   * \param theIOR the IOR of Geom object
+   * \return \c true if shape has been successfully imported
+   */
+  HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
+
+  /**
+   * Stores the study entry of the imported GEOM object.
+   * \param theEntry GEOM object entry
+   */
+  HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
+
+  /**
+   * Returns the imported GEOM object entry.
+   */
+  HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
+
+public:
+
+  /**
+   * Returns the 2D presentation of all points.
+   */
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
+
   /**
    * Returns the 3D presentation of all points.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape();
+  HYDRODATA_EXPORT virtual bool ImportShape( const TopoDS_Shape& theShape );
+
 
   /**
-   * Update the wire contour on the basis of the polyline data.
-   * Call this method whenever you made changes for polyline data.
+   * Returns flag indicating that polyline can be edited or not.
    */
-  HYDRODATA_EXPORT virtual void Update();
+  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 bool theIsSimpleCheck = true ) const;
 
    /**
-   * Returns true if polyline is closed
+   * Returns the distance beetwen first and point with index thePointIndex
+   * at the section with index theSectionIndex. -1 is returned if error is occurred.
    */
-  HYDRODATA_EXPORT bool IsClosed() const;
+  HYDRODATA_EXPORT double GetDistance( const int theSectionIndex,
+                                       const int thePointIndex ) const;
+
 
-  
   /**
    * Returns number of sections.
    */
@@ -162,6 +234,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
@@ -188,6 +268,13 @@ public:
   HYDRODATA_EXPORT virtual QPainterPath GetPainterPath() const;
 
 
+protected:
+
+  /**
+   * Sets the flag indicating that polyline can be edited or not.
+   */
+  HYDRODATA_EXPORT virtual void setEditable( const bool theIsEditable );
+
 protected:
 
   friend class HYDROData_Profile;