Merge branch 'master' into BR_quadtree

[modules/hydro.git] / src / HYDROData / HYDROData_Channel.h

diff --git a/src/HYDROData/HYDROData_Channel.h b/src/HYDROData/HYDROData_Channel.h
index c1aea49c7c416158b74a188f9f2c78dc2b454ea4..3e069097a2aab3e2dd6a101eaab2e4205f2a9f48 100644 (file)
--- a/src/HYDROData/HYDROData_Channel.h
+++ b/src/HYDROData/HYDROData_Channel.h
@@ -1,11 +1,33 @@
+// 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_Channel_HeaderFile
 #define HYDROData_Channel_HeaderFile
 
 #include "HYDROData_ArtificialObject.h"
 
+#include <TopoDS_Face.hxx>
+#include <TopoDS_Wire.hxx>
+
 class Handle(HYDROData_Polyline3D);
 class Handle(HYDROData_Profile);
+class TopTools_SequenceOfShape;
+class TopTools_ListOfShape;
 
 DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
 
@@ -15,6 +37,18 @@ DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
  */
 class HYDROData_Channel : public HYDROData_ArtificialObject
 {
+public:
+
+  struct PrsDefinition
+  {
+    TopoDS_Shape myPrs3D;
+    TopoDS_Face  myPrs2D;
+    TopoDS_Wire  myLeftBank;
+    TopoDS_Wire  myRightBank;
+    TopoDS_Wire  myInlet;
+    TopoDS_Wire  myOutlet;
+  };
+
 protected:
   /**
    * Enumeration of tags corresponding to the persistent object parameters.
@@ -24,11 +58,25 @@ protected:
     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
     DataTag_GuideLine, 
     DataTag_Profile,
+    DataTag_EquiDistance,
   };
 
 public:
+
   DEFINE_STANDARD_RTTI(HYDROData_Channel);
 
+public:
+
+  /**
+   * Creates the presentations(2D and 3D) by given guide line and profile.
+   */
+  HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
+                                                    const Handle(HYDROData_Profile)&    theProfile,
+                                                    PrsDefinition&                      thePrs,
+                                                    double                              theEquiDistance );
+
+public:
+
   /**
    * Returns the kind of this object. Must be redefined in all objects of known type.
    */
@@ -37,17 +85,23 @@ 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.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 
   /**
-   * Returns the top shape of the object.
+   * Returns the left edge of the channel.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const;
 
   /**
-   * Returns the 3d shape of the object.
+   * Returns the right edge of the channel.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const;
 
   /**
    * Update the shape presentations of stream.
@@ -55,6 +109,21 @@ public:
    */
   HYDRODATA_EXPORT virtual void Update();
 
+  /**
+   * Checks that object has 2D presentation. Reimlemented to retun true.
+   */
+  HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
+
+  /**
+   * Returns default filling color for new channel.
+   */
+  HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
+
+  /**
+   * Returns default border color for new channel.
+   */
+  HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
+
 
 public:      
   // Public methods to work with Channel
@@ -90,6 +159,15 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveProfile();
 
+  HYDRODATA_EXPORT void SetEquiDistance( double );
+  HYDRODATA_EXPORT double GetEquiDistance() const;
+
+protected:
+  /**
+   * Returns the type of child altitude object.
+   * Reimplemented to create chanel altitude object.
+   */
+  HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 
 protected: