Salome HOME
Methods to work with imagw references:
[modules/hydro.git] / src / HYDROData / HYDROData_Zone.h
index 5b277a13095b3474265b17b2176acffb320674d8..aba5d5ba8c3a8b60dd349ba0558c2cd84d509f35 100644 (file)
@@ -2,35 +2,43 @@
 #ifndef HYDROData_Zone_HeaderFile
 #define HYDROData_Zone_HeaderFile
 
-#include <HYDROData_Object.h>
-
-#include <QPointF>
-#include <QPainterPath>
-#include <QList>
+#include <HYDROData_Entity.h>
 
+class Handle(HYDROData_Object);
 class Handle(HYDROData_Bathymetry);
-class Handle(HYDROData_Polyline);
+class TopoDS_Shape;
 
-DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Object)
+DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
 
 
 /**\class HYDROData_Zone
  * \brief Class that stores/retreives information about the 2d face.
  */
-class HYDROData_Zone : public HYDROData_Object
+class HYDROData_Zone : public HYDROData_Entity
 {
 
+public:
+
+  // Enumeration of mergin types for conflict bathymetries
+  enum MergeBathymetriesType
+  {
+    Merge_UNKNOWN, // Undefined
+    Merge_ZMIN,    // The minimum values
+    Merge_ZMAX,    // The maximum values
+    Merge_Object   // Only one bathymetry will be taken into account
+  };
+
 protected:
   /**
    * Enumeration of tags corresponding to the persistent object parameters.
    */
   enum DataTag
   {
-    DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
-    DataTag_Bathymetry,   ///< reference bathymetries
-    DataTag_Polyline,     ///< reference polyline
-    DataTag_FillingColor, ///< filling color of zone
-    DataTag_BorderColor,  ///< border color of zone
+    DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
+    DataTag_Shape,           ///< reference shape
+    DataTag_GeometryObject,  ///< reference geometry objects
+    DataTag_MergeType,       ///< mergin type of conflict bathymetries
+    DataTag_Bathymetry,      ///< reference bathymetry
   };
 
 public:
@@ -39,7 +47,7 @@ public:
   /**
    * Returns the kind of this object. Must be redefined in all objects of known type.
    */
-  HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_ZONE;}
+  HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; }
 
   /**
    * Dump object to Python script representation.
@@ -48,98 +56,70 @@ public:
 
 
   /**
-   * Returns default filling color for new zone.
+   * Sets the shape of the zone.
    */
-  HYDRODATA_EXPORT static QColor DefaultFillingColor();
+  HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape );
 
   /**
-   * Sets filling color for zone.
+   * Returns the shape of the zone.
    */
-  HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor );
-
-  /**
-   * Returns filling color of zone.
-   */
-  HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
 
 
   /**
-   * Returns default border color for new zone.
+   * Returns true if zone needs merge of bathymetries.
    */
-  HYDRODATA_EXPORT static QColor DefaultBorderColor();
+  HYDRODATA_EXPORT virtual bool IsMergingNeed() const;
 
-  /**
-   * Sets border color for zone.
-   */
-  HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor );
 
   /**
-   * Returns border color of zone.
+   * Sets the merging type for conflict bathymetries.
+   * By default it is set to Merge_UNKNOWN.
    */
-  HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
-
+  HYDRODATA_EXPORT virtual void SetMergeType( const MergeBathymetriesType& theType );
 
   /**
-   * Sets reference polyline object for zone.
+   * Returns the merging type for conflict bathymetries.
    */
-  HYDRODATA_EXPORT virtual void SetPolyline( const Handle(HYDROData_Polyline)& thePolyline );
+  HYDRODATA_EXPORT virtual MergeBathymetriesType GetMergeType() const;
 
-  /**
-   * Returns reference polyline object of zone.
-   */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline) GetPolyline() const;
-
-  /**
-   * Remove reference polyline object of zone.
-   */
-  HYDRODATA_EXPORT virtual void RemovePolyline();
-
-
-  /**
-   * Returns number of bathymetry objects for zone.
-   */
-  HYDRODATA_EXPORT virtual int NbBathymetries() const;
-
-  /**
-   * Add reference bathymetry object for zone.
-   */
-  HYDRODATA_EXPORT virtual void AddBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
 
   /**
-   * Change reference bathymetry object with given index for zone.
+   * Sets the reference bathymetry to resolve the conflict.
+   * This object is used only in case of "Merge_Object" merge type.
    */
-  HYDRODATA_EXPORT virtual void SetBathymetry( const int                           theIndex,
-                                               const Handle(HYDROData_Bathymetry)& theBathymetry );
+  HYDRODATA_EXPORT virtual void SetMergeBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
 
   /**
-   * Returns reference bathymetry object of zone by it index.
+   * Returns the reference bathymetry to resolve the conflict.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetBathymetry( const int theIndex ) const;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetMergeBathymetry() const;
 
   /**
-   * Returns list of all reference bathymetry objects of zone.
+   * Removes the reference bathymetry for resolving the conflict.
    */
-  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects  GetBathymetries() const;
+  HYDRODATA_EXPORT virtual void RemoveMergeBathymetry();
+  
 
   /**
-   * Clear list of bathymetry objects of zone.
+   * Add new one geometry object for zone.
    */
-  HYDRODATA_EXPORT virtual void RemoveBathymetries();
+  HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
 
   /**
-   * Returns data of object wrapped to QVariant.
-   * Reimplemented to wrap and return saved 2d polyline.
+   * Returns all geometry objects of zone.
    */
-  //HYDRODATA_EXPORT virtual QVariant GetDataVariant();
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
 
   /**
-   * Returns the painter path. The painter path is construct by polyline
+   * Removes all geometry objects from zone.
    */
-  HYDRODATA_EXPORT QPainterPath GetPainterPath() const;
+  HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
 
 
 protected:
 
+  friend class HYDROData_Region;
   friend class HYDROData_Iterator;
 
   /**
@@ -152,6 +132,7 @@ protected:
    * Destructs properties of the object and object itself, removes it from the document.
    */
   ~HYDROData_Zone();
+
 };
 
 #endif