X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Stream.h;h=73691575c13f3d943568859068000ad378c15d29;hb=cde2ec476486fcd7c9b7b38ce814c648d73e7fd3;hp=d0f6202894ccdaaed6bc2eab19bd4ad190603b58;hpb=f69c6f07782392fb5e8c95aa917b1bfaa8f4b012;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Stream.h b/src/HYDROData/HYDROData_Stream.h index d0f62028..73691575 100644 --- a/src/HYDROData/HYDROData_Stream.h +++ b/src/HYDROData/HYDROData_Stream.h @@ -1,14 +1,40 @@ +// Copyright (C) 2014-2015 EDF-R&D +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef HYDROData_Stream_HeaderFile #define HYDROData_Stream_HeaderFile #include "HYDROData_NaturalObject.h" + #include +#include + +#include + DEFINE_STANDARD_HANDLE(HYDROData_Stream, HYDROData_NaturalObject) class Handle(HYDROData_PolylineXY); +class Handle(HYDROData_Polyline3D); class Handle(HYDROData_Profile); +class HYDROData_IProfilesInterpolator; class TColStd_Array1OfReal; +class Handle(TopTools_HArray1OfShape); + /**\class HYDROData_Stream * \brief @@ -16,6 +42,18 @@ class TColStd_Array1OfReal; */ class HYDROData_Stream : public HYDROData_NaturalObject { +public: + + struct PrsDefinition + { + TopoDS_Shape myPrs3D; + TopoDS_Shape myPrs2D; + TopoDS_Edge myLeftBank; + TopoDS_Edge myRightBank; + TopoDS_Edge myInlet; + TopoDS_Edge myOutlet; + }; + protected: /** * Enumeration of tags corresponding to the persistent object parameters. @@ -25,12 +63,35 @@ protected: DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve DataTag_HydraulicAxis, ///< reference hydraulic axis DataTag_Profile, ///< reference profiles - DataTag_ParamsArray ///< parameters array + DataTag_ParamsArray, ///< parameters array + DataTag_BottomPolyline ///< reference bottom polyline }; public: + DEFINE_STANDARD_RTTI(HYDROData_Stream); +public: + + /** + * Creates the presentations(2D and 3D) by given hydraulic axis and profiles. + */ + HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_PolylineXY)& theHydAxis, + const HYDROData_SequenceOfObjects& theProfiles, + PrsDefinition& thePrs ); + + /** + * Creates the presentations(2D and 3D) by given first points, last points and profiles. + * If 2D profiles is null - they will not used in the presentation. + */ + HYDRODATA_EXPORT static bool CreatePresentations( const Handle(TColgp_HArray1OfPnt) theArrayOfFPnt, + const Handle(TColgp_HArray1OfPnt) theArrayOfLPnt, + const Handle(TopTools_HArray1OfShape) theArrOfProfiles, + const Handle(TopTools_HArray1OfShape) theArrOf2DProfiles, + PrsDefinition& thePrs ); + +public: + /** * Returns the kind of this object. Must be redefined in all objects of known type. */ @@ -39,7 +100,8 @@ public: /** * Dump object to Python script representation. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath, + MapOfTreatedObjects& theTreatedObjects ) const; /** * Returns the list of all reference objects of this object. @@ -47,25 +109,70 @@ public: HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; /** - * Returns the top shape of the object. + * Update the profiles order and shape presentations of stream. + * Call this method whenever you made changes for stream data. */ - HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const; + HYDRODATA_EXPORT virtual void Update(); /** - * Returns the 3d shape of the object. + * Checks that object has 2D presentation. Reimlemented to retun true. */ - HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const; + HYDRODATA_EXPORT virtual bool IsHas2dPrs() const; /** * Update the shape presentations of stream. - * Call this method whenever you made changes for stream data. */ - HYDRODATA_EXPORT virtual void Update(); + HYDRODATA_EXPORT virtual void UpdatePrs(); + + /** + * + */ + HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination, + bool isGenerateNewName ) const; + + + /** + * Returns default filling color for new stream. + */ + HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const; + /** + * Returns default border color for new stream. + */ + HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const; + + /** + * Returns true if given polyline can be used as stream axis. + */ + HYDRODATA_EXPORT static bool IsValidAsAxis( const Handle(HYDROData_PolylineXY)& theAxis ); public: - // Public methods to work with Stream + // Public methods to work with Stream presentation + /** + * Returns the left edge of the stream. + */ + HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const; + + /** + * Returns the right edge of the stream. + */ + HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const; + + /** + * Returns the inlet edge of the stream. + */ + HYDRODATA_EXPORT virtual TopoDS_Shape GetInletShape() const; + + /** + * Returns the outlet edge of the stream. + */ + HYDRODATA_EXPORT virtual TopoDS_Shape GetOutletShape() const; + + +public: + // Public methods to work with Stream data fields + /** * Sets reference hydraulic axis object for stream. */ @@ -81,25 +188,42 @@ public: */ HYDRODATA_EXPORT virtual void RemoveHydraulicAxis(); + /** + * Returns true if profile has the intersection with the given hydraulic axis. + * Returns the parameter of inresection point on axis if axis is presented by one curve, + * if axis presented by set of edges the returns a common length of segments till the intersection point. + */ + HYDRODATA_EXPORT static bool HasIntersection( const Handle(HYDROData_PolylineXY)& theHydAxis, + const Handle(HYDROData_Profile)& theProfile, + const TopoDS_Face& thePlane, + Standard_Real& theOutPar ); /** * Returns true if profile has the intersection with reference hydraulic axis. * Returns the parameter of inresection point on axis if axis is presented by one curve, * if axis presented by set of edges the returns a common length of segments till the intersection point. */ - HYDRODATA_EXPORT virtual bool HasIntersection( const Handle(HYDROData_Profile)& theProfile, const TopoDS_Face& thePlane, - Standard_Real& outPar) const; + HYDRODATA_EXPORT virtual bool HasIntersection( const Handle(HYDROData_Profile)& theProfile, + const TopoDS_Face& thePlane, + Standard_Real& theOutPar ) const; - /** - * Builds a planar face - */ - HYDRODATA_EXPORT virtual bool BuildFace( const Handle(HYDROData_PolylineXY)& theHydAxis, TopoDS_Face& thePlane) const; + /** + * Builds a planar face + */ + HYDRODATA_EXPORT static bool BuildFace( const Handle(HYDROData_PolylineXY)& theHydAxis, + TopoDS_Face& thePlane ); /** * Add new one reference profile object for stream. */ HYDRODATA_EXPORT virtual bool AddProfile( const Handle(HYDROData_Profile)& theProfile ); + /** + * Add new one reference profile object for stream. + */ + HYDRODATA_EXPORT virtual bool SetProfiles( const HYDROData_SequenceOfObjects& theProfiles, + const bool& theIsToOrder = true ); + /** * Returns all reference profile objects of stream. */ @@ -115,7 +239,31 @@ public: */ HYDRODATA_EXPORT virtual void RemoveProfiles(); + /** + * Generates bottom polyline for stream or update the existing bottom polyline. + * \return true in case of success + */ + HYDRODATA_EXPORT virtual bool GenerateBottomPolyline(); + + /** + * Returns reference bottom polyline object of stream. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetBottomPolyline() const; + + /** + * Sets reference bottom polyline object for stream. + * \param theBottom the polyline 3D + * \return true in case of success + */ + HYDRODATA_EXPORT virtual bool SetBottomPolyline( const Handle(HYDROData_Polyline3D)& theBottom ); + /** + * Add interpolated profiles into the stream. + * \param theInterpolator the interpolator + * \return true in case of success + */ + HYDRODATA_EXPORT virtual bool Interpolate( HYDROData_IProfilesInterpolator* theInterpolator ); + protected: /** @@ -129,6 +277,18 @@ protected: * If hydraulic axis is not set all profiles will be removed from order. */ void updateProfilesOrder(); + + /** + * Returns the type of child altitude object. + * Reimplemented to create stream altitude object. + */ + HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const; + + /** + * Builds b-spline using interpolation algorithm. + */ + static Handle(Geom_BSplineCurve) buildInterpolationCurve( + const Handle(TColgp_HArray1OfPnt)& theArrayOfPnt ); private: @@ -159,3 +319,5 @@ protected: }; #endif + +