]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_PolylineXY.h
Salome HOME
Merge branch 'BR_LAND_COVER_MAP' of ssh://git.salome-platform.org/modules/hydro into...
[modules/hydro.git] / src / HYDROData / HYDROData_PolylineXY.h
1 // Copyright (C) 2014-2015  EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
6 //
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
10 // Lesser General Public License for more details.
11 //
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 #ifndef HYDROData_PolylineXY_HeaderFile
20 #define HYDROData_PolylineXY_HeaderFile
21
22 #include "HYDROData_IPolyline.h"
23
24 DEFINE_STANDARD_HANDLE(HYDROData_PolylineXY, HYDROData_IPolyline)
25
26 class QPainterPath;
27 class QTransform;
28 class TopoDS_Wire;
29 class gp_XYZ;
30 class gp_Pnt;
31
32 /**\class HYDROData_PolylineXY
33  * \brief Class that stores/retreives information about the 
34  *        parametric profile points.
35  */
36 class HYDROData_PolylineXY : public HYDROData_IPolyline
37 {
38 protected:
39   /**
40    * Enumeration of tags corresponding to the persistent object parameters.
41    */
42   enum DataTag
43   {
44     DataTag_First = HYDROData_IPolyline::DataTag_First + 100, ///< first tag, to reserve
45     DataTag_GeomObjectEntry,  ///< study entry of the imported GEOM object
46   };
47
48 public:
49   DEFINE_STANDARD_RTTI(HYDROData_PolylineXY);
50
51
52   /**
53    * Returns the kind of this object. Must be redefined in all objects of known type.
54    */
55   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_POLYLINEXY;}
56
57   /**
58    * Dump object to Python script representation.
59    */
60   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
61
62   /**
63    * Update the wire contour on the basis of the polyline data.
64    * Call this method whenever you made changes for polyline data.
65    */
66   HYDRODATA_EXPORT virtual void Update();
67
68   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
69
70   /**
71    * Checks that object has 2D presentation. Reimlemented to retun true.
72    */
73   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
74
75   /**
76    * Returns data of object wrapped to QVariant.
77    * Reimplemented to wrap and return saved path.
78    */
79   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
80
81   /**
82    * Returns default wire color for new polyline.
83    */
84   HYDRODATA_EXPORT static QColor DefaultWireColor();
85
86   HYDRODATA_EXPORT bool IsCustom() const;
87
88 public:
89
90   /**
91    * Returns the presentation of polyline section in CAS maner.
92    */
93   HYDRODATA_EXPORT static TopoDS_Wire BuildWire( const SectionType&                  theType,
94                                                  const bool&                         theIsClosed,
95                                                  const NCollection_Sequence<gp_XYZ>& thePoints );
96
97   /**
98    * Returns the presentation of polyline section in Qt maner.
99    */
100   HYDRODATA_EXPORT static void BuildPainterPath( QPainterPath&                       thePath,
101                                                  const SectionType&                  theType,
102                                                  const bool&                         theIsClosed,
103                                                  const NCollection_Sequence<gp_XYZ>& thePoints );
104
105 public:
106
107   /**
108    * Imports shape from IOR.
109    * \param theIOR the IOR of Geom object
110    * \return \c true if shape has been successfully imported
111    */
112   HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
113
114   /**
115    * Stores the study entry of the imported GEOM object.
116    * \param theEntry GEOM object entry
117    */
118   HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
119
120   /**
121    * Returns the imported GEOM object entry.
122    */
123   HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
124
125 public:
126
127   /**
128    * Returns the 3D presentation of all points.
129    */
130   HYDRODATA_EXPORT virtual bool ImportShape( const TopoDS_Shape& theShape );
131
132   /**
133    * Returns flag indicating that polyline can be edited or not.
134    */
135   HYDRODATA_EXPORT virtual bool IsEditable() const;
136
137   
138   /**
139    * Returns true if polyline is closed
140    * \param theIsSimpleCheck flag indicating the type of checking
141    *        - if true then all wires checked on closures
142    *        - if false then for positive result polyline should consist of
143    *          only one wire and which must be closed
144    */
145   HYDRODATA_EXPORT bool IsClosed( const bool theIsSimpleCheck = true ) const;
146
147    /**
148    * Returns the distance beetwen first and point with index thePointIndex
149    * at the section with index theSectionIndex. -1 is returned if error is occurred.
150    */
151   HYDRODATA_EXPORT double GetDistance( const int theSectionIndex,
152                                        const int thePointIndex ) const;
153
154
155   /**
156    * Returns number of sections.
157    */
158   HYDRODATA_EXPORT virtual int NbSections() const;
159
160   /**
161    * Adds new one section.
162    * \param theSectName name of the section
163    * \param theSectionType type of section
164    * \param theIsClosed flag indicates closures of section
165    */
166   HYDRODATA_EXPORT virtual void AddSection( const TCollection_AsciiString& theSectName,
167                                             const SectionType              theSectionType,
168                                             const bool                     theIsClosed );
169
170   /**
171    * Returns name of section with given index.
172    * \param theSectionIndex index of section
173    */
174   HYDRODATA_EXPORT virtual TCollection_AsciiString GetSectionName( const int theSectionIndex ) const;
175
176   /**
177    * Set name for section with given index.
178    * \param theSectionIndex index of section
179    * \param theSectionName new section name
180    */
181   HYDRODATA_EXPORT virtual void SetSectionName( const int                      theSectionIndex, 
182                                                 const TCollection_AsciiString& theSectionName );
183
184   /**
185    * Returns type of section with given index.
186    * \param theSectionIndex index of section
187    */
188   HYDRODATA_EXPORT virtual SectionType GetSectionType( const int theSectionIndex ) const;
189
190   /**
191    * Set type for section with given index.
192    * \param theSectionIndex index of section
193    * \param theSectionType new section type
194    */
195   HYDRODATA_EXPORT virtual void SetSectionType( const int         theSectionIndex, 
196                                                 const SectionType theSectionType );
197
198   /**
199    * Returns true if section with given index is closed.
200    * \param theSectionIndex index of section
201    */
202   HYDRODATA_EXPORT virtual bool IsClosedSection( const int theSectionIndex ) const;
203
204   /**
205    * Set closed flag for section with given index.
206    * \param theSectionIndex index of section
207    * \param theIsClosed new closures state
208    */
209   HYDRODATA_EXPORT virtual void SetSectionClosed( const int  theSectionIndex, 
210                                                   const bool theIsClosed );
211
212   /**
213    * Adds new one section.
214    * \param theSectName name of the section
215    * \param theSectionType type of section
216    * \param theIsClosed flag indicates closures of section
217    */
218   HYDRODATA_EXPORT virtual void GetSections( NCollection_Sequence<TCollection_AsciiString>& theSectNames,
219                                              NCollection_Sequence<SectionType>&             theSectTypes,
220                                              NCollection_Sequence<bool>&                    theSectClosures ) const;
221
222   /**
223    * Removes section with given index.
224    * \param theSectionIndex index of section
225    */
226   HYDRODATA_EXPORT virtual void RemoveSection( const int theSectionIndex );
227
228   /**
229    * Removes all sections.
230    */
231   HYDRODATA_EXPORT virtual void RemoveSections();
232
233
234   /**
235    * Adds new point for section with index "theSectionIndex".
236    * \param theSectionIndex index of section
237    * \param thePoint point to add
238    * \param theBeforeIndex if not equal -1 then insert point in this pos
239    */
240   HYDRODATA_EXPORT virtual void AddPoint( const int    theSectionIndex,
241                                           const Point& thePoint,
242                                           const int    thePointIndex = -1 );
243
244   /**
245    * Replaces point for section with index "theSectionIndex".
246    * \param theSectionIndex index of section
247    * \param thePoint new point
248    * \param thePointIndex index of point to replace
249    */
250   HYDRODATA_EXPORT virtual void SetPoint( const int    theSectionIndex,
251                                           const Point& thePoint,
252                                           const int    thePointIndex );
253
254   /**
255    * Replaces point for section with index "theSectionIndex".
256    * \param theSectionIndex index of section
257    * \param thePoints new points
258    */
259   HYDRODATA_EXPORT virtual void SetPoints( const int         theSectionIndex,
260                                            const PointsList& thePoints );
261
262   /**
263    * Removes point from section with index "theSectionIndex".
264    * \param theSectionIndex index of section
265    * \param thePointIndex index of point
266    */
267   HYDRODATA_EXPORT virtual void RemovePoint( const int theSectionIndex,
268                                              const int thePointIndex );
269
270
271   /**
272    * Returns list of points.
273    * \param theSectionIndex if not equal -1 then list of points returned
274    *                        only for section with this index
275    * \return list of points
276    */
277   HYDRODATA_EXPORT virtual PointsList GetPoints( const int theSectionIndex = -1, bool IsConvertToGlobal = false ) const;
278
279
280   /**
281    * Returns the painter path.
282    * Note: currently only the first section of the polyline data is taken into account.
283    * \return polyline painter path.
284    */
285   HYDRODATA_EXPORT virtual QPainterPath GetPainterPath() const;
286
287   /**
288    * Transform the polyline points.
289    * @param theTrsf the transformation
290    */
291   HYDRODATA_EXPORT void Transform( const QTransform& theTrsf );
292
293 protected:
294
295   /**
296    * Sets the flag indicating that polyline can be edited or not.
297    */
298   HYDRODATA_EXPORT virtual void setEditable( const bool theIsEditable );
299
300 protected:
301
302   friend class HYDROData_Profile;
303   friend class HYDROData_Iterator;
304
305   /**
306    * Creates new object in the internal data structure. Use higher level objects 
307    * to create objects with real content.
308    */
309   HYDRODATA_EXPORT HYDROData_PolylineXY();
310
311   /**
312    * Destructs properties of the object and object itself, removes it from the document.
313    */
314   HYDRODATA_EXPORT ~HYDROData_PolylineXY();
315 };
316
317 #endif