Salome HOME
refs #417: showing new objects
[modules/hydro.git] / src / HYDROData / HYDROData_Channel.h
index fbb35f4a1d2d15a9baf5ee8af9c2683bbcfc5573..c7ed284136032d235faf640318adc1de60ef94e3 100644 (file)
@@ -4,6 +4,14 @@
 
 #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)
 
 /**\class HYDROData_Channel
@@ -12,6 +20,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.
@@ -19,11 +39,25 @@ protected:
   enum DataTag
   {
     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
+    DataTag_GuideLine, 
+    DataTag_Profile,
   };
 
 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 );
+
+public:
+
   /**
    * Returns the kind of this object. Must be redefined in all objects of known type.
    */
@@ -34,6 +68,11 @@ 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.
    */
@@ -44,6 +83,81 @@ public:
    */
   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
 
+  /**
+   * Update the shape presentations of stream.
+   * Call this method whenever you made changes for channel data.
+   */
+  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 static QColor DefaultFillingColor();
+
+  /**
+   * Returns default border color for new channel.
+   */
+  HYDRODATA_EXPORT static QColor DefaultBorderColor();
+
+
+public:      
+  // Public methods to work with Channel
+  
+  /**
+   * Sets reference guide line object for channel.
+   */
+  HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
+
+  /**
+   * Returns reference guide line object of channel.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
+
+  /**
+   * Remove reference guide line object from channel.
+   */
+  HYDRODATA_EXPORT virtual void RemoveGuideLine();
+
+
+  /**
+   * Sets reference profile object for channel.
+   */
+  HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
+
+  /**
+   * Returns reference profile object of channel.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
+
+  /**
+   * Remove reference profile object from channel.
+   */
+  HYDRODATA_EXPORT virtual void RemoveProfile();
+
+
+protected:
+
+  /**
+   * 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;
+
+  /**
+   * Returns the type of child altitude object.
+   * Reimplemented to create chanel altitude object.
+   */
+  HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
+
 protected:
 
   friend class HYDROData_Iterator;