Salome HOME
refs #417: showing new objects
[modules/hydro.git] / src / HYDROData / HYDROData_PolylineXY.h
index ae8c848f3737408a01ed1253d0e1056bd34503cd..86ae8e54d2e3f836a68cf26c1d4523e0c9da5308 100644 (file)
@@ -6,6 +6,10 @@
 
 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 
  *        parametric profile points.
@@ -19,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:
@@ -30,13 +35,104 @@ public:
    */
   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_POLYLINEXY;}
 
+  /**
+   * Dump object to Python script representation.
+   */
+  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_Wire GetWire() const;
+  HYDRODATA_EXPORT virtual bool ImportShape( const TopoDS_Shape& theShape );
+
+
+  /**
+   * 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 bool theIsSimpleCheck = true ) const;
+
+   /**
+   * 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 double GetDistance( const int theSectionIndex,
+                                       const int thePointIndex ) const;
 
 
   /**
@@ -46,9 +142,41 @@ public:
 
   /**
    * Adds new one section.
-   * \param theIsClosed flag indicates type of polyline
+   * \param theSectName name of the section
+   * \param theSectionType type of section
+   * \param theIsClosed flag indicates closures of section
+   */
+  HYDRODATA_EXPORT virtual void AddSection( const TCollection_AsciiString& theSectName,
+                                            const SectionType              theSectionType,
+                                            const bool                     theIsClosed );
+
+  /**
+   * Returns name of section with given index.
+   * \param theSectionIndex index of section
+   */
+  HYDRODATA_EXPORT virtual TCollection_AsciiString GetSectionName( const int theSectionIndex ) const;
+
+  /**
+   * Set name for section with given index.
+   * \param theSectionIndex index of section
+   * \param theSectionName new section name
+   */
+  HYDRODATA_EXPORT virtual void SetSectionName( const int                      theSectionIndex, 
+                                                const TCollection_AsciiString& theSectionName );
+
+  /**
+   * Returns type of section with given index.
+   * \param theSectionIndex index of section
    */
-  HYDRODATA_EXPORT virtual void AddSection( const bool theIsClosed );
+  HYDRODATA_EXPORT virtual SectionType GetSectionType( const int theSectionIndex ) const;
+
+  /**
+   * Set type for section with given index.
+   * \param theSectionIndex index of section
+   * \param theSectionType new section type
+   */
+  HYDRODATA_EXPORT virtual void SetSectionType( const int         theSectionIndex, 
+                                                const SectionType theSectionType );
 
   /**
    * Returns true if section with given index is closed.
@@ -56,6 +184,24 @@ public:
    */
   HYDRODATA_EXPORT virtual bool IsClosedSection( const int theSectionIndex ) const;
 
+  /**
+   * Set closed flag for section with given index.
+   * \param theSectionIndex index of section
+   * \param theIsClosed new closures state
+   */
+  HYDRODATA_EXPORT virtual void SetSectionClosed( const int  theSectionIndex, 
+                                                  const bool theIsClosed );
+
+  /**
+   * Adds new one section.
+   * \param theSectName name of the section
+   * \param theSectionType type of section
+   * \param theIsClosed flag indicates closures of section
+   */
+  HYDRODATA_EXPORT virtual void GetSections( NCollection_Sequence<TCollection_AsciiString>& theSectNames,
+                                             NCollection_Sequence<SectionType>&             theSectTypes,
+                                             NCollection_Sequence<bool>&                    theSectClosures ) const;
+
   /**
    * Removes section with given index.
    * \param theSectionIndex index of section
@@ -81,12 +227,20 @@ public:
   /**
    * Replaces point for section with index "theSectionIndex".
    * \param theSectionIndex index of section
-   * \param thePointIndex index of point to replace
    * \param thePoint new point
+   * \param thePointIndex index of point to replace
    */
   HYDRODATA_EXPORT virtual void SetPoint( const int    theSectionIndex,
-                                          const int    thePointIndex,
-                                          const Point& thePoint );
+                                          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".
@@ -105,6 +259,22 @@ public:
    */
   HYDRODATA_EXPORT virtual PointsList GetPoints( const int theSectionIndex = -1 ) const;
 
+
+  /**
+   * Returns the painter path.
+   * Note: currently only the first section of the polyline data is taken into account.
+   * \return polyline painter path.
+   */
+  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;