X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_PolylineXY.h;h=e052a1c3aac0af7c39db43bff214673031e70ab0;hb=e0da09bfb6b059c2671fe4c052f8e6d7ae426050;hp=93caac614c465601c04a7be55e7988d16633d6a1;hpb=7e825ec456c9331ef0df1cb59865cc55f0d8516a;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_PolylineXY.h b/src/HYDROData/HYDROData_PolylineXY.h index 93caac61..e052a1c3 100644 --- a/src/HYDROData/HYDROData_PolylineXY.h +++ b/src/HYDROData/HYDROData_PolylineXY.h @@ -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 @@ -6,6 +23,12 @@ 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 * parametric profile points. @@ -19,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: @@ -30,95 +54,255 @@ public: */ HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_POLYLINEXY;} + /** + * Dump object to Python script representation. + */ + 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. + * Reimplemented to wrap and return saved path. + */ + 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: - // 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 + /** + * 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 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 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; + + + /** + * Returns number of sections. + */ + HYDRODATA_EXPORT virtual int NbSections() const; + + /** + * 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 ); + /** + * Returns name of section with given index. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual TCollection_AsciiString GetSectionName( const int theSectionIndex ) const; - /***********************************************/ - /*** Section methods ***/ - /***********************************************/ + /** + * 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 ); - //! Clear the polyline (remove all sections) - HYDRODATA_EXPORT virtual bool clear(); + /** + * Returns type of section with given index. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual SectionType GetSectionType( const int theSectionIndex ) 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 ); + /** + * 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 number of sections - HYDRODATA_EXPORT virtual int getNbSections() const; + /** + * Returns true if section with given index is closed. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual bool IsClosedSection( const int theSectionIndex ) const; - //! Add a new section. - HYDRODATA_EXPORT virtual int addSection( const std::string& theName, - const CurveCreator::SectionType theType, - const bool theIsClosed ); + /** + * 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 ); - //! 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 GetSections( NCollection_Sequence& theSectNames, + NCollection_Sequence& theSectTypes, + NCollection_Sequence& theSectClosures ) const; - //! Get "closed" flag of the specified section - HYDRODATA_EXPORT virtual bool isClosed( const int theISection ) const; + /** + * Removes section with given index. + * \param theSectionIndex index of section + */ + HYDRODATA_EXPORT virtual void RemoveSection( const int theSectionIndex ); /** - * Set "closed" flag of the specified section (all sections if - * \a theISection is -1). + * Removes all sections. */ - HYDRODATA_EXPORT virtual bool setClosed( const int theISection, - const bool theIsClosed ); + HYDRODATA_EXPORT virtual void RemoveSections(); - //! Returns specifyed section name - HYDRODATA_EXPORT virtual std::string getSectionName( const int theISection ) const; - /** Set name of the specified section */ - HYDRODATA_EXPORT virtual bool setSectionName( const int theISection, - const std::string& theName ); + /** + * 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 ); - //! Get type of the specified section - HYDRODATA_EXPORT virtual CurveCreator::SectionType getSectionType( const int theISection ) const; + /** + * 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 ); /** - * Set type of the specified section (or all sections - * if \a theISection is -1). + * Removes point from section with index "theSectionIndex". + * \param theSectionIndex index of section + * \param thePointIndex index of point */ - HYDRODATA_EXPORT virtual bool setSectionType( const int theISection, - const CurveCreator::SectionType theType ); + HYDRODATA_EXPORT virtual void RemovePoint( const int theSectionIndex, + const int thePointIndex ); + + /** + * 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 PointsList GetPoints( const int theSectionIndex = -1, bool IsConvertToGlobal = false ) const; - /***********************************************/ - /*** Point methods ***/ - /***********************************************/ /** - * 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). + * 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 bool addPoints( const CurveCreator::Coordinates& theCoords, - const int theISection, - const int theIPnt = -1 ); + HYDRODATA_EXPORT virtual QPainterPath GetPainterPath() const; - //! Set coordinates of specified point - HYDRODATA_EXPORT virtual bool setPoint( const int theISection, - const int theIPnt, - const CurveCreator::Coordinates& theCoords ); + /** + * Transform the polyline points. + * @param theTrsf the transformation + */ + HYDRODATA_EXPORT void Transform( const QTransform& theTrsf ); - //! Remove point with given id - HYDRODATA_EXPORT virtual bool removePoint( const int theISection, const int theIPnt = -1 ); +protected: /** - * Get points of a section (the total points in Curve if theISection is equal to -1).. + * Sets the flag indicating that polyline can be edited or not. */ - HYDRODATA_EXPORT virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const; + HYDRODATA_EXPORT virtual void setEditable( const bool theIsEditable ); + + HYDRODATA_EXPORT void Interpolate(); protected: @@ -135,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