]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Polyline3D.h
Salome HOME
Merge branch 'BR_LAND_COVER_MAP' into BR_DBF_SUPPORT
[modules/hydro.git] / src / HYDROData / HYDROData_Polyline3D.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_Polyline3D_HeaderFile
20 #define HYDROData_Polyline3D_HeaderFile
21
22 #include "HYDROData_Object.h"
23
24 DEFINE_STANDARD_HANDLE(HYDROData_Polyline3D, HYDROData_Object)
25
26 class Handle(HYDROData_PolylineXY);
27 class Handle(HYDROData_ProfileUZ);
28 class gp_XYZ;
29
30 /**\class HYDROData_Polyline3D
31  * \brief 
32  *
33  */
34 class HYDROData_Polyline3D : public HYDROData_Object
35 {
36 public:
37
38   typedef gp_XYZ                                Polyline3DPoint;
39   typedef NCollection_Sequence<Polyline3DPoint> Polyline3DPoints;
40
41 protected:
42   /**
43    * Enumeration of tags corresponding to the persistent object parameters.
44    */
45   enum DataTag
46   {
47     DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
48     DataTag_PolylineXY,          ///< reference hydraulic axis
49     DataTag_ProfileUZ,           ///< reference profile
50     DataTag_ChildProfileUZ,      ///< reference profile
51   };
52
53 public:
54   DEFINE_STANDARD_RTTI(HYDROData_Polyline3D);
55
56   /**
57    * Returns the kind of this object. Must be redefined in all objects of known type.
58    */
59   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_POLYLINE;}
60
61   /**
62    * Dump object to Python script representation.
63    */
64   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
65
66   /**
67    * Returns the list of all reference objects of this object.
68    */
69   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
70
71   /**
72    * Update the shape presentations of stream.
73    * Call this method whenever you made changes for stream data.
74    */
75   HYDRODATA_EXPORT virtual void Update();
76
77   /**
78    * Returns default filling color for new 3D polyline.
79    */
80   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
81
82   /**
83    * Returns default border color for new 3D polyline.
84    */
85   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
86
87
88 public:      
89   // Public methods to work with 3D polyline
90   
91   /**
92    * Sets reference x,y polyline object for 3D polyline.
93    */
94   HYDRODATA_EXPORT virtual bool SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline,
95                                                const bool                          theIsUpdateProfile = true );
96
97   /**
98    * Returns reference x,y polyline object of 3D polyline.
99    */
100   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetPolylineXY() const;
101
102   /**
103    * Remove reference x,y polyline object from 3D polyline.
104    */
105   HYDRODATA_EXPORT virtual void RemovePolylineXY();
106
107
108   /**
109    * Sets reference u,z profile object for 3D polyline.
110    */
111   HYDRODATA_EXPORT virtual bool SetProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );
112
113   /**
114    * Returns reference u,z profile object of 3D polyline.
115    */
116   HYDRODATA_EXPORT virtual Handle(HYDROData_ProfileUZ) GetProfileUZ() const;
117
118   /**
119    * Remove reference u,z profile object from 3D polyline.
120    */
121   HYDRODATA_EXPORT virtual void RemoveProfileUZ();
122
123
124   /**
125    * Set reference bathymetry object for geometry object.
126    * Reimplemented to remove reference u,z profile.
127    */
128   HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
129
130   /**
131    * Clear the reference bathymetry object for geometry object.
132    * Reimplemented to remove child u,z profile.
133    */
134   HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
135
136
137   /**
138    * Returns the child u,z profile which has been generated from bathymetry.
139    */
140   HYDRODATA_EXPORT Handle(HYDROData_ProfileUZ) GetChildProfileUZ( const bool theIsCreate = true ) const;
141
142   /**
143    * Sets the child u,z profile for polyline.
144    */
145   HYDRODATA_EXPORT void SetChildProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );
146
147   /**
148    * Returns list of polyline points.
149    * \return list of 3D points
150    */
151   HYDRODATA_EXPORT Polyline3DPoints GetPoints() const;
152
153 protected:
154   /**
155    * Checks and if necessary create child 3D object.
156    * Reimplemented to prevent creation of 3D child object.
157    */
158   HYDRODATA_EXPORT virtual void checkAndSetObject3D() {}
159
160
161 protected:
162
163
164   void updateChildProfilePoints();
165
166   void removeChildProfileUZ();
167
168
169 protected:
170
171   friend class HYDROData_Iterator;
172
173   /**
174    * Creates new object in the internal data structure. Use higher level objects 
175    * to create objects with real content.
176    */
177   HYDRODATA_EXPORT HYDROData_Polyline3D();
178
179   /**
180    * Destructs properties of the object and object itself, removes it from the document.
181    */
182   virtual HYDRODATA_EXPORT ~HYDROData_Polyline3D();
183 };
184
185 #endif