]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Profile.h
Salome HOME
merge master 2015/06/04
[modules/hydro.git] / src / HYDROData / HYDROData_Profile.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_Profile_HeaderFile
20 #define HYDROData_Profile_HeaderFile
21
22 #include "HYDROData_Object.h"
23
24 #include "HYDROData_ProfileUZ.h"
25
26 DEFINE_STANDARD_HANDLE(HYDROData_Profile, HYDROData_Object)
27
28 class gp_XYZ;
29 class OSD_File;
30 class Handle(HYDROData_Document);
31
32 /**\class HYDROData_Profile
33  * \brief Class that stores/retreives information about the profile.
34  */
35 class HYDROData_Profile : public HYDROData_Object
36 {
37 public:
38
39   typedef gp_XYZ                             ProfilePoint;
40   typedef NCollection_Sequence<ProfilePoint> ProfilePoints;
41
42 protected:
43   /**
44    * Enumeration of tags corresponding to the persistent object parameters.
45    */
46   enum DataTag
47   {
48     DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
49     DataTag_FirstPoint,       ///< first(left) point
50     DataTag_LastPoint,        ///< last(right) point
51     DataTag_ChildProfileUZ,   ///< child parametric profile
52     DataTag_FilePath          ///< profile imported file path
53   };
54
55 public:
56   DEFINE_STANDARD_RTTI(HYDROData_Profile);
57
58   /**
59    * Returns the kind of this object. Must be redefined in all objects of known type.
60    */
61   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_PROFILE; }
62
63   /**
64    * Dump object to Python script representation.
65    */
66   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
67
68   /**
69    * Returns the top shape of the object.
70    */
71   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
72
73   /**
74    * Returns the 3d shape of the object.
75    */
76   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
77
78   /**
79    * Updates profile 3D presentation.
80    * Call this method whenever you made changes in data structure.
81    * This method does not called automatically since it may take a very long time.
82    */
83   HYDRODATA_EXPORT virtual void Update();
84
85   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
86
87   /**
88    * Returns default filling color for new profile.
89    */
90   HYDRODATA_EXPORT static QColor DefaultFillingColor();
91
92   /**
93    * Returns default border color for new profile.
94    */
95   HYDRODATA_EXPORT static QColor DefaultBorderColor();
96
97
98 public:
99
100   /**
101    * Check profile data and returns true if profile is valid.
102    * Validity is determined by:
103    *   - First(left) and Last(right) point was set
104    *   - Parametric points size is more than 1
105    */
106   HYDRODATA_EXPORT bool IsValid() const;
107
108   /**
109    * Invalidate profile first and last points.
110    */
111   HYDRODATA_EXPORT void Invalidate();
112   
113 public:
114
115   // Public methods to work with profile points.
116
117   /**
118    * Set first(left) point for profile.
119    * \param thePoint the point
120    */
121   HYDRODATA_EXPORT void SetLeftPoint( const gp_XY& thePoint, bool IsConvertFromGlobal = false );
122
123   /**
124    * Returns first(left) point of profile.
125    * \param thePoint[out] profile first point
126    * \return true if point has been set
127    */
128   HYDRODATA_EXPORT bool GetLeftPoint( gp_XY& thePoint, bool IsConvertToGlobal = false ) const;
129
130   /**
131    * Set last(right) point for profile.
132    * \param thePoint the point
133    */
134   HYDRODATA_EXPORT void SetRightPoint( const gp_XY& thePoint, bool IsConvertFromGlobal = false );
135
136   /**
137    * Returns last(right) point of profile.
138    * \param thePoint[out] profile last point
139    * \return true if point has been set
140    */
141   HYDRODATA_EXPORT bool GetRightPoint( gp_XY& thePoint, bool IsConvertToGlobal = false ) const;
142
143
144   /**
145    * Returns object which store parametric presentation of profile points.
146    * \return profile U,Z
147    */
148   HYDRODATA_EXPORT Handle(HYDROData_ProfileUZ) GetProfileUZ( const bool theIsCreate = true ) const;
149
150
151   /**
152    * Return number of profile points.
153    * \return number of points
154    */
155   HYDRODATA_EXPORT int NbPoints() const;
156
157   /**
158    * Remove all profile points.
159    */
160   HYDRODATA_EXPORT void RemovePoints();
161
162
163   /**
164    * Replace current profile parametric points by new one.
165    * \param thePoints the list with new points in parametric form
166    */
167   HYDRODATA_EXPORT void SetParametricPoints( const HYDROData_ProfileUZ::PointsList& thePoints );
168
169   /**
170    * Returns profile points in parametric form.
171    * \return points list
172    */
173   HYDRODATA_EXPORT HYDROData_ProfileUZ::PointsList GetParametricPoints() const;
174
175
176   /**
177    * Replace current profile points by new one.
178    * First and last points will be automatically updated.
179    * \param thePoints the list with new profile points
180    */
181   HYDRODATA_EXPORT void SetProfilePoints( const ProfilePoints& thePoints, bool IsConvertFromGlobal = true );
182
183   /**
184    * Returns profile points.
185    * Empty sequence is returned if first or last point was not set.
186    * \return profile points list
187    */
188   HYDRODATA_EXPORT ProfilePoints GetProfilePoints( bool IsConvertToGlobal = false ) const;
189
190
191   /**
192    * Return profile point with minimal Z value.
193    * \return non-parametric profile point
194    */
195   HYDRODATA_EXPORT ProfilePoint GetBottomPoint() const;
196
197 public:
198   // Public methods to work with files.
199
200   /**
201    * Stores the profile file path
202    * \param theFilePath profile file path
203    */
204   HYDRODATA_EXPORT void SetFilePath( const TCollection_AsciiString& theFilePath );
205
206   /**
207    * Returns uploaded profile file path
208    */
209   HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
210
211   /**
212    * Imports Profile data from file. The supported file types:
213    *  - parametric presentation of profile (2 points in line U,Z)
214    *  - georeferenced presentation of profile (3 points in line X,Y,Z)
215    * Create as many objects as many profiles in the file are defined.
216    * \param theFileName the path to file
217    * \return \c number of successfully imported profiles
218    */
219   HYDRODATA_EXPORT static int ImportFromFile( const Handle(HYDROData_Document)& theDoc,
220                                                const TCollection_AsciiString&    theFileName,
221                                                NCollection_Sequence<int>&        theBadProfilesIds );
222
223   /**
224    * Imports Profile data from file.
225    * \param theFileName the path to file
226    * \param theIsRead set to true if at least one non empty string was read from file
227    * \return \c true if file has been successfully read
228    */
229   HYDRODATA_EXPORT virtual bool ImportFromFile( const TCollection_AsciiString& theFileName,
230                                                 bool*                          theIsRead = 0 );
231
232   /**
233    * Imports Profile data from file. 
234    * \param theFile file to read
235    * \param theIsRead set to true if at least one non empty string was read from file
236    * \return \c true if file has been successfully read
237    */
238   HYDRODATA_EXPORT virtual bool ImportFromFile( OSD_File& theFile,
239                                                 bool*      theIsRead = 0 );
240
241 protected:
242
243   /**
244    * Returns default filling color for new object.
245    */
246   HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
247
248   /**
249    * Returns default border color for new object.
250    */
251   HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
252
253   /**
254    * Checks and if necessary create child 3D object.
255    * Reimplemented to prevent creation of 3D child object.
256    */
257   HYDRODATA_EXPORT virtual void checkAndSetObject3D() {}
258
259
260 protected:
261
262   friend class HYDROData_Iterator;
263
264   /**
265    * Creates new object in the internal data structure. Use higher level objects 
266    * to create objects with real content.
267    */
268   HYDRODATA_EXPORT HYDROData_Profile();
269
270   /**
271    * Destructs properties of the object and object itself, removes it from the document.
272    */
273   HYDRODATA_EXPORT ~HYDROData_Profile();
274 };
275
276 #endif