X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_PolylineXY.h;h=d14212e163ab7e52694d798d7752b2236b572510;hb=c52bda48bea5753316f128f52a3be1abb5aff055;hp=943f4d8ff160647ad975074babba9b09ae6fc3d6;hpb=a23fa81dd76041264b4ddd65883ea9bfb7cc67bd;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_PolylineXY.h b/src/HYDROData/HYDROData_PolylineXY.h index 943f4d8f..d14212e1 100644 --- a/src/HYDROData/HYDROData_PolylineXY.h +++ b/src/HYDROData/HYDROData_PolylineXY.h @@ -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. @@ -30,101 +34,190 @@ 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; + + /** + * 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: - // Implementation of IPolyline interface + /** + * Returns the presentation of polyline section in CAS maner. + */ + HYDRODATA_EXPORT static TopoDS_Wire BuildWire( const SectionType& theType, + const bool& theIsClosed, + const NCollection_Sequence& thePoints ); /** - * Returns the 3D presentation of all points. + * Returns the presentation of polyline section in Qt maner. */ - HYDRODATA_EXPORT virtual ListAISObjects constructWire() const; + HYDRODATA_EXPORT static void BuildPainterPath( QPainterPath& thePath, + const SectionType& theType, + const bool& theIsClosed, + const NCollection_Sequence& thePoints ); public: - // Implementation of ICurve interface + /** + * Returns the 3D presentation of all points. + */ + HYDRODATA_EXPORT virtual TopoDS_Shape GetShape(); + /** + * 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(); - /***********************************************/ - /*** Section methods ***/ - /***********************************************/ - //! Clear the polyline (remove all sections) - HYDRODATA_EXPORT virtual bool clear(); + /** + * Returns true if polyline is closed + */ + HYDRODATA_EXPORT bool IsClosed() const; - //! Join range of sections to one section (join all sections if -1 is passed in one of arguments) - HYDRODATA_EXPORT virtual bool join( const int theISectionTo = -1, - const int theISectionFrom = -1 ); + /** + * 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; - //! Get number of sections - HYDRODATA_EXPORT virtual int getNbSections() const; - //! Add a new section. - HYDRODATA_EXPORT virtual int addSection( const std::string& theName, - const CurveCreator::SectionType theType, - const bool theIsClosed ); + /** + * Returns number of sections. + */ + HYDRODATA_EXPORT virtual int NbSections() const; - //! Removes the given section. - HYDRODATA_EXPORT virtual bool removeSection( const int theISection ); + /** + * 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 AddSection( const TCollection_AsciiString& theSectName, + const SectionType theSectionType, + const bool theIsClosed ); - //! Get "closed" flag of the specified section - HYDRODATA_EXPORT virtual bool isClosed( const int theISection ) const; + /** + * Returns name of section with given index. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual TCollection_AsciiString GetSectionName( const int theSectionIndex ) const; /** - * Set "closed" flag of the specified section (all sections if - * \a theISection is -1). + * Set name for section with given index. + * \param theSectionIndex index of section + * \param theSectionName new section name */ - HYDRODATA_EXPORT virtual bool setClosed( const int theISection, - const bool theIsClosed ); + HYDRODATA_EXPORT virtual void SetSectionName( const int theSectionIndex, + const TCollection_AsciiString& theSectionName ); - //! Returns specifyed section name - HYDRODATA_EXPORT virtual std::string getSectionName( const int theISection ) const; + /** + * Returns type of section with given index. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual SectionType GetSectionType( const int theSectionIndex ) const; - /** Set name of the specified section */ - HYDRODATA_EXPORT virtual bool setSectionName( const int theISection, - const std::string& theName ); + /** + * 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 ); - //! Get type of the specified section - HYDRODATA_EXPORT virtual CurveCreator::SectionType getSectionType( const int theISection ) const; + /** + * Returns true if section with given index is closed. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual bool IsClosedSection( const int theSectionIndex ) const; /** - * Set type of the specified section (or all sections - * if \a theISection is -1). + * Set closed flag for section with given index. + * \param theSectionIndex index of section + * \param theIsClosed new closures state */ - HYDRODATA_EXPORT virtual bool setSectionType( const int theISection, - const CurveCreator::SectionType theType ); + 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& theSectNames, + NCollection_Sequence& theSectTypes, + NCollection_Sequence& theSectClosures ) const; - /***********************************************/ - /*** Point methods ***/ - /***********************************************/ + /** + * Removes section with given index. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual void RemoveSection( const int theSectionIndex ); /** - * Insert one or several points to the specified section starting from the given theIPnt index - * (or add these at the end of section points if \a theIPnt is -1). + * Removes all sections. */ - HYDRODATA_EXPORT virtual bool addPoints( const CurveCreator::Coordinates& theCoords, - const int theISection, - const int theIPnt = -1 ); + HYDRODATA_EXPORT virtual void RemoveSections(); - //! Set coordinates of specified point - HYDRODATA_EXPORT virtual bool setPoint( const int theISection, - const int theIPnt, - const CurveCreator::Coordinates& theCoords ); - //! Set coordinates of specified points from different sections - HYDRODATA_EXPORT virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords); + /** + * Adds new point for section with index "theSectionIndex". + * \param theSectionIndex index of section + * \param thePoint point to add + * \param theBeforeIndex if not equal -1 then insert point in this pos + */ + HYDRODATA_EXPORT virtual void AddPoint( const int theSectionIndex, + const Point& thePoint, + const int thePointIndex = -1 ); + + /** + * Replaces point for section with index "theSectionIndex". + * \param theSectionIndex index of section + * \param thePoint new point + * \param thePointIndex index of point to replace + */ + HYDRODATA_EXPORT virtual void SetPoint( const int theSectionIndex, + const Point& thePoint, + const int thePointIndex ); - //! Remove point with given id - HYDRODATA_EXPORT virtual bool removePoint( const int theISection, const int theIPnt = -1 ); + /** + * Removes point from section with index "theSectionIndex". + * \param theSectionIndex index of section + * \param thePointIndex index of point + */ + HYDRODATA_EXPORT virtual void RemovePoint( const int theSectionIndex, + const int thePointIndex ); - //! Remove several points from different sections with given ids - HYDRODATA_EXPORT virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs); /** - * Get points of a section (the total points in Curve if theISection is equal to -1).. + * Returns list of points. + * \param theSectionIndex if not equal -1 then list of points returned + * only for section with this index + * \return list of points */ - HYDRODATA_EXPORT virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const; + 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: