#define HYDROData_Stream_HeaderFile
#include "HYDROData_NaturalObject.h"
-
+#include <TopoDS_Face.hxx>
+#include <Geom_BSplineCurve.hxx>
DEFINE_STANDARD_HANDLE(HYDROData_Stream, HYDROData_NaturalObject)
+class Handle(HYDROData_PolylineXY);
+class Handle(HYDROData_Profile);
+class TColStd_Array1OfReal;
+
/**\class HYDROData_Stream
* \brief
*
enum DataTag
{
DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
+ DataTag_HydraulicAxis, ///< reference hydraulic axis
+ DataTag_Profile, ///< reference profiles
+ DataTag_ParamsArray ///< parameters array
};
public:
*/
HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+ /**
+ * Returns the list of all reference objects of this object.
+ */
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+
/**
* Returns the top shape of the object.
*/
*/
HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
+ /**
+ * Update the profiles order and shape presentations of stream.
+ * Call this method whenever you made changes for stream data.
+ */
+ HYDRODATA_EXPORT virtual void Update();
+
+ /**
+ * Update the shape presentations of stream.
+ */
+ HYDRODATA_EXPORT virtual void UpdatePrs();
+
+ /**
+ * Returns default filling color for new stream.
+ */
+ HYDRODATA_EXPORT static QColor DefaultFillingColor();
+
+ /**
+ * Returns default border color for new stream.
+ */
+ HYDRODATA_EXPORT static QColor DefaultBorderColor();
+
+ /**
+ * 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 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.
+ */
+ HYDRODATA_EXPORT virtual bool SetHydraulicAxis( const Handle(HYDROData_PolylineXY)& theAxis );
+
+ /**
+ * Returns reference hydraulic axis object of stream.
+ */
+ HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetHydraulicAxis() const;
+
+ /**
+ * Remove reference hydraulic axis object from stream.
+ */
+ 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 <outPar> 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& outPar);
+
+ /**
+ * 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 <outPar> 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;
+
+ /**
+ * Builds a planar face
+ */
+ HYDRODATA_EXPORT virtual bool BuildFace( const Handle(HYDROData_PolylineXY)& theHydAxis, TopoDS_Face& thePlane) const;
+
+ /**
+ * Add new one reference profile object for stream.
+ */
+ HYDRODATA_EXPORT virtual bool AddProfile( const Handle(HYDROData_Profile)& theProfile );
+
+ /**
+ * Returns all reference profile objects of stream.
+ */
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetProfiles() const;
+
+ /**
+ * Removes reference profile object from stream.
+ */
+ HYDRODATA_EXPORT virtual bool RemoveProfile( const Handle(HYDROData_Profile)& theProfile );
+
+ /**
+ * Removes all reference profile objects from stream.
+ */
+ HYDRODATA_EXPORT virtual void RemoveProfiles();
+
+protected:
+
+ /**
+ * Insert one profile in to the stream profiles order.
+ */
+ void insertProfileInToOrder( const Handle(HYDROData_Profile)& theProfile,
+ const int theBeforeIndex = -1 );
+
+ /**
+ * Fully recompute the order of all profiles in accordance with reference hydraulic axis.
+ * If hydraulic axis is not set all profiles will be removed from order.
+ */
+ void updateProfilesOrder();
+
+ /**
+ * Create all necessary child group objects.
+ */
+ virtual void createGroupObjects();
+
+ /**
+ * Returns the type of child altitude object.
+ * Reimplemented to create stream altitude object.
+ */
+ virtual ObjectKind getAltitudeObjectType() const;
+
+ /**
+ * Builds b-spline using interpolation algorithm.
+ */
+ Handle(Geom_BSplineCurve) buildInterpolationCurve(const Handle(TColgp_HArray1OfPnt)& theArrayOfPnt);
+
+ /**
+ * Returns default filling color for new object.
+ */
+ virtual QColor getDefaultFillingColor() const;
+
+ /**
+ * Returns default border color for new object.
+ */
+ virtual QColor getDefaultBorderColor() const;
+
+private:
+
+ void setParametersArray( const TColStd_Array1OfReal& theArray );
+
+ TColStd_Array1OfReal* getParametersArray() const;
+
+ void removeParametersArray();
+
+ int insertParameter( const Standard_Real& theParam );
+
+ void removeParameter( const int& theIndex );
+
protected:
friend class HYDROData_Iterator;
