Salome HOME
refs #430: incorrect coordinates in dump polyline
[modules/hydro.git] / src / HYDROData / HYDROData_Stream.h
index 3ebc441ab6bb2810e5d110a3bb1eac6e4d28a347..f44f2d2452e7d9302f2baf6df02c52077f16496c 100644 (file)
@@ -3,8 +3,12 @@
 #define HYDROData_Stream_HeaderFile
 
 #include "HYDROData_NaturalObject.h"
+
 #include <TopoDS_Face.hxx>
+#include <TopoDS_Edge.hxx>
+
 #include <Geom_BSplineCurve.hxx>
+
 DEFINE_STANDARD_HANDLE(HYDROData_Stream, HYDROData_NaturalObject)
 
 class Handle(HYDROData_PolylineXY);
@@ -17,6 +21,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.
@@ -30,8 +46,20 @@ protected:
   };
 
 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 );
+
+public:
+
   /**
    * Returns the kind of this object. Must be redefined in all objects of known type.
    */
@@ -58,15 +86,63 @@ public:
   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
 
   /**
-   * Update the shape presentations of stream.
+   * Update the profiles order and shape presentations of stream.
    * Call this method whenever you made changes for stream data.
    */
   HYDRODATA_EXPORT virtual void Update();
 
+  /**
+   * Checks that object has 2D presentation. Reimlemented to retun true.
+   */
+  HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
+
+  /**
+   * 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
+  // 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.
    */
@@ -82,25 +158,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 <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&                      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 <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;
+  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.
    */
@@ -130,10 +223,27 @@ protected:
    */
   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.
    */
-  Handle(Geom_BSplineCurve) buildInterpolationCurve(const   Handle(TColgp_HArray1OfPnt)& theArrayOfPnt);
+  static Handle(Geom_BSplineCurve) buildInterpolationCurve(
+    const Handle(TColgp_HArray1OfPnt)& theArrayOfPnt );
+
+  /**
+   * Returns default filling color for new object.
+   */
+  HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
+
+  /**
+   * Returns default border color for new object.
+   */
+  HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
 
 private:
   
@@ -164,3 +274,5 @@ protected:
 };
 
 #endif
+
+