17.12.2013. Added Partition algorithm (draft version).

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

diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h
index 59ccfedb14dfb8172025c2b9e91a9ecd0cc1688a..e20e47893a0088434f1fb2ce685d1fde88ed7fa0 100644 (file)
--- a/src/HYDROData/HYDROData_Object.h
+++ b/src/HYDROData/HYDROData_Object.h
@@ -4,11 +4,13 @@
 
 #include <HYDROData_Entity.h>
 
-class TopoDS_Shape;
 
 DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
 
+class TopoDS_Shape;
 class Handle(HYDROData_Bathymetry);
+class Handle(HYDROData_DummyObject3D);
+class Handle(HYDROData_ShapesGroup);
 
 /**\class HYDROData_Object
  * \brief The base class for all geometrical objects in the HYDRO module.
@@ -26,18 +28,32 @@ protected:
     DataTag_TopShape,
     DataTag_Shape3D,
     DataTag_Bathymetry,   ///< reference bathymetry
+    DataTag_FillingColor, ///< filling color of geometrical object
+    DataTag_BorderColor,  ///< border color of geometrical object
+    DataTag_Object3D,     ///< child 3D object
+    DataTag_EdgesGroup,   ///< child group objects
   };
 
+public:
+  DEFINE_STANDARD_RTTI(HYDROData_Object);
+
   /**
-   * Enumeration of tags corresponding to the child sub-objects of object.
+   * Update the geometry object.
+   * Call this method whenever you made changes for object data.
    */
-  enum ChildTag
-  {
-    ChildTag_First = HYDROData_Entity::ChildTag_First + 100, ///< first tag, to reserve
-  };
+  HYDRODATA_EXPORT virtual void Update();
+
+  /**
+   * Returns the list of all reference objects of this object.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+
+  /**
+   * Sets the "MustBeUpdated" flag: if object is depended on updated features.
+   * Reimplemented to update the state of child 3D object.
+   */
+  HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
 
-public:
-  DEFINE_STANDARD_RTTI(HYDROData_Object);
 
   /**
    * Sets the top(2d projection) shape of the object.
@@ -60,10 +76,21 @@ public:
   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0;
 
   
+  /**
+   * Returns reference object which represent the 3D shape of object.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const;
+
+  /**
+   * Returns sequence of object groups.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const;
+
+
   /**
    * Set reference bathymetry object for geometry object.
    */
-  HYDRODATA_EXPORT virtual void SetBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
+  HYDRODATA_EXPORT virtual bool SetBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
 
   /**
    * Returns reference bathymetry object of geometry object.
@@ -75,6 +102,47 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveBathymetry();
 
+   /**
+   * Sets filling color for object.
+   */
+  HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor );
+
+  /**
+   * Returns filling color of object.
+   */
+  HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
+
+   /**
+   * Sets border color for object.
+   */
+  HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor );
+
+  /**
+   * Returns border color of object.
+   */
+  HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
+
+  /**
+   * Returns default filling color for new object.
+   */
+  HYDRODATA_EXPORT static QColor DefaultFillingColor();
+
+  /**
+   * Returns default border color for new object.
+   */
+  HYDRODATA_EXPORT static QColor DefaultBorderColor();
+
+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;
 
 protected:
 
@@ -91,16 +159,51 @@ protected:
 
 protected:
 
+  /**
+   * Checks and if necessary create child 3D object.
+   * Reimplement this function in your subclass if you 
+   * do not want to create child 3D object.
+   */
+  HYDRODATA_EXPORT virtual void checkAndSetObject3D();
+
+
+  /**
+   * Create new one child group object.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
+
+  /**
+   * Create all necessary child group objects.
+   * Base implementation does nothing.
+   */
+  HYDRODATA_EXPORT virtual void createGroupObjects();
+
+  /**
+   * Remove all child group objects.
+   */
+  HYDRODATA_EXPORT virtual void removeGroupObjects();
+
+
   /**
    * Retrieve the top shape of the object from data label.
    */
   HYDRODATA_EXPORT TopoDS_Shape getTopShape() const;
 
+  /**
+   * Removes the top shape from data label of the object.
+   */
+  HYDRODATA_EXPORT void removeTopShape();
+
+
   /**
    * Retrieve the 3d shape of the object from data label.
    */
   HYDRODATA_EXPORT TopoDS_Shape getShape3D() const;
 
+  /**
+   * Removes the 3d shape from data label of the object.
+   */
+  HYDRODATA_EXPORT void removeShape3D();
 };
 
 #endif