1 // Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef HYDROData_Stream_HeaderFile
24 #define HYDROData_Stream_HeaderFile
26 #include "HYDROData_NaturalObject.h"
28 #include <TopoDS_Face.hxx>
29 #include <TopoDS_Edge.hxx>
31 #include <Geom_BSplineCurve.hxx>
33 DEFINE_STANDARD_HANDLE(HYDROData_Stream, HYDROData_NaturalObject)
35 class Handle(HYDROData_PolylineXY);
36 class Handle(HYDROData_Profile);
37 class TColStd_Array1OfReal;
39 /**\class HYDROData_Stream
43 class HYDROData_Stream : public HYDROData_NaturalObject
51 TopoDS_Edge myLeftBank;
52 TopoDS_Edge myRightBank;
59 * Enumeration of tags corresponding to the persistent object parameters.
63 DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
64 DataTag_HydraulicAxis, ///< reference hydraulic axis
65 DataTag_Profile, ///< reference profiles
66 DataTag_ParamsArray ///< parameters array
71 DEFINE_STANDARD_RTTI(HYDROData_Stream);
76 * Creates the presentations(2D and 3D) by given hydraulic axis and profiles.
78 HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_PolylineXY)& theHydAxis,
79 const HYDROData_SequenceOfObjects& theProfiles,
80 PrsDefinition& thePrs );
85 * Returns the kind of this object. Must be redefined in all objects of known type.
87 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_STREAM;}
90 * Dump object to Python script representation.
92 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
95 * Returns the list of all reference objects of this object.
97 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
100 * Returns the top shape of the object.
102 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
105 * Returns the 3d shape of the object.
107 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
110 * Update the profiles order and shape presentations of stream.
111 * Call this method whenever you made changes for stream data.
113 HYDRODATA_EXPORT virtual void Update();
116 * Checks that object has 2D presentation. Reimlemented to retun true.
118 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
121 * Update the shape presentations of stream.
123 HYDRODATA_EXPORT virtual void UpdatePrs();
126 * Returns default filling color for new stream.
128 HYDRODATA_EXPORT static QColor DefaultFillingColor();
131 * Returns default border color for new stream.
133 HYDRODATA_EXPORT static QColor DefaultBorderColor();
136 * Returns true if given polyline can be used as stream axis.
138 HYDRODATA_EXPORT static bool IsValidAsAxis( const Handle(HYDROData_PolylineXY)& theAxis );
141 // Public methods to work with Stream presentation
144 * Returns the left edge of the stream.
146 HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const;
149 * Returns the right edge of the stream.
151 HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const;
154 * Returns the inlet edge of the stream.
156 HYDRODATA_EXPORT virtual TopoDS_Shape GetInletShape() const;
159 * Returns the outlet edge of the stream.
161 HYDRODATA_EXPORT virtual TopoDS_Shape GetOutletShape() const;
165 // Public methods to work with Stream data fields
168 * Sets reference hydraulic axis object for stream.
170 HYDRODATA_EXPORT virtual bool SetHydraulicAxis( const Handle(HYDROData_PolylineXY)& theAxis );
173 * Returns reference hydraulic axis object of stream.
175 HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetHydraulicAxis() const;
178 * Remove reference hydraulic axis object from stream.
180 HYDRODATA_EXPORT virtual void RemoveHydraulicAxis();
183 * Returns true if profile has the intersection with the given hydraulic axis.
184 * Returns the parameter of inresection point on axis if axis is presented by one curve,
185 * if axis presented by set of edges the <outPar> returns a common length of segments till the intersection point.
187 HYDRODATA_EXPORT static bool HasIntersection( const Handle(HYDROData_PolylineXY)& theHydAxis,
188 const Handle(HYDROData_Profile)& theProfile,
189 const TopoDS_Face& thePlane,
190 Standard_Real& theOutPar );
193 * Returns true if profile has the intersection with reference hydraulic axis.
194 * Returns the parameter of inresection point on axis if axis is presented by one curve,
195 * if axis presented by set of edges the <outPar> returns a common length of segments till the intersection point.
197 HYDRODATA_EXPORT virtual bool HasIntersection( const Handle(HYDROData_Profile)& theProfile,
198 const TopoDS_Face& thePlane,
199 Standard_Real& theOutPar ) const;
202 * Builds a planar face
204 HYDRODATA_EXPORT static bool BuildFace( const Handle(HYDROData_PolylineXY)& theHydAxis,
205 TopoDS_Face& thePlane );
208 * Add new one reference profile object for stream.
210 HYDRODATA_EXPORT virtual bool AddProfile( const Handle(HYDROData_Profile)& theProfile );
213 * Add new one reference profile object for stream.
215 HYDRODATA_EXPORT virtual bool SetProfiles( const HYDROData_SequenceOfObjects& theProfiles,
216 const bool& theIsToOrder = true );
219 * Returns all reference profile objects of stream.
221 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetProfiles() const;
224 * Removes reference profile object from stream.
226 HYDRODATA_EXPORT virtual bool RemoveProfile( const Handle(HYDROData_Profile)& theProfile );
229 * Removes all reference profile objects from stream.
231 HYDRODATA_EXPORT virtual void RemoveProfiles();
236 * Insert one profile in to the stream profiles order.
238 void insertProfileInToOrder( const Handle(HYDROData_Profile)& theProfile,
239 const int theBeforeIndex = -1 );
242 * Fully recompute the order of all profiles in accordance with reference hydraulic axis.
243 * If hydraulic axis is not set all profiles will be removed from order.
245 void updateProfilesOrder();
248 * Returns the type of child altitude object.
249 * Reimplemented to create stream altitude object.
251 HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
254 * Builds b-spline using interpolation algorithm.
256 static Handle(Geom_BSplineCurve) buildInterpolationCurve(
257 const Handle(TColgp_HArray1OfPnt)& theArrayOfPnt );
260 * Returns default filling color for new object.
262 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
265 * Returns default border color for new object.
267 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
271 void setParametersArray( const TColStd_Array1OfReal& theArray );
273 TColStd_Array1OfReal* getParametersArray() const;
275 void removeParametersArray();
277 int insertParameter( const Standard_Real& theParam );
279 void removeParameter( const int& theIndex );
283 friend class HYDROData_Iterator;
286 * Creates new object in the internal data structure. Use higher level objects
287 * to create objects with real content.
289 HYDRODATA_EXPORT HYDROData_Stream();
292 * Destructs properties of the object and object itself, removes it from the document.
294 virtual HYDRODATA_EXPORT ~HYDROData_Stream();