]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Polyline3D.h
Salome HOME
Merge commit '9dd90968eb8ad86e7e6ae67f48bb6110bd4ffbdc' into BR_LCM_COMP
[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( const QString& thePyScriptPath,
65                                                      MapOfTreatedObjects& theTreatedObjects ) const;
66
67   /**
68    * Returns the list of all reference objects of this object.
69    */
70   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
71
72   /**
73    * Update the shape presentations of stream.
74    * Call this method whenever you made changes for stream data.
75    */
76   HYDRODATA_EXPORT virtual void Update();
77
78   /**
79    * Returns default filling color for new 3D polyline.
80    */
81   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
82
83   /**
84    * Returns default border color for new 3D polyline.
85    */
86   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
87
88
89 public:      
90   // Public methods to work with 3D polyline
91   
92   /**
93    * Sets reference x,y polyline object for 3D polyline.
94    */
95   HYDRODATA_EXPORT virtual bool SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline,
96                                                const bool                          theIsUpdateProfile = true );
97
98   /**
99    * Returns reference x,y polyline object of 3D polyline.
100    */
101   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetPolylineXY() const;
102
103   /**
104    * Remove reference x,y polyline object from 3D polyline.
105    */
106   HYDRODATA_EXPORT virtual void RemovePolylineXY();
107
108
109   /**
110    * Sets reference u,z profile object for 3D polyline.
111    */
112   HYDRODATA_EXPORT virtual bool SetProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );
113
114   /**
115    * Returns reference u,z profile object of 3D polyline.
116    */
117   HYDRODATA_EXPORT virtual Handle(HYDROData_ProfileUZ) GetProfileUZ() const;
118
119   /**
120    * Remove reference u,z profile object from 3D polyline.
121    */
122   HYDRODATA_EXPORT virtual void RemoveProfileUZ();
123
124
125   /**
126    * Set reference bathymetry object for geometry object.
127    * Reimplemented to remove reference u,z profile.
128    */
129   HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
130
131   /**
132    * Clear the reference bathymetry object for geometry object.
133    * Reimplemented to remove child u,z profile.
134    */
135   HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
136
137
138   /**
139    * Returns the child u,z profile which has been generated from bathymetry.
140    */
141   HYDRODATA_EXPORT Handle(HYDROData_ProfileUZ) GetChildProfileUZ( const bool theIsCreate = true ) const;
142
143   /**
144    * Sets the child u,z profile for polyline.
145    */
146   HYDRODATA_EXPORT void SetChildProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );
147
148   /**
149    * Returns list of polyline points.
150    * \return list of 3D points
151    */
152   HYDRODATA_EXPORT Polyline3DPoints GetPoints() const;
153
154 protected:
155   /**
156    * Checks and if necessary create child 3D object.
157    * Reimplemented to prevent creation of 3D child object.
158    */
159   HYDRODATA_EXPORT virtual void checkAndSetObject3D() {}
160
161
162 protected:
163
164
165   void updateChildProfilePoints();
166
167   void removeChildProfileUZ();
168
169
170 protected:
171
172   friend class HYDROData_Iterator;
173
174   /**
175    * Creates new object in the internal data structure. Use higher level objects 
176    * to create objects with real content.
177    */
178   HYDRODATA_EXPORT HYDROData_Polyline3D();
179
180   /**
181    * Destructs properties of the object and object itself, removes it from the document.
182    */
183   virtual HYDRODATA_EXPORT ~HYDROData_Polyline3D();
184 };
185
186 #endif