Salome HOME
refs #430: incorrect coordinates in dump polyline
[modules/hydro.git] / src / HYDROData / HYDROData_Object.h
index 807465639b38f62d66976fa1514737d0e26c2a08..302f5580e813fe8b45b2712cc2a79fc383f47da0 100644 (file)
@@ -8,8 +8,9 @@
 DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
 
 class TopoDS_Shape;
-class Handle(HYDROData_Bathymetry);
+class Handle(HYDROData_IAltitudeObject);
 class Handle(HYDROData_DummyObject3D);
+class Handle(HYDROData_ShapesGroup);
 
 /**\class HYDROData_Object
  * \brief The base class for all geometrical objects in the HYDRO module.
@@ -26,15 +27,23 @@ protected:
     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
     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_AltitudeObject,      ///< reference altitude object
+    DataTag_FillingColor,        ///< filling color of geometrical object
+    DataTag_BorderColor,         ///< border color of geometrical object
+    DataTag_Object3D,            ///< child 3D object
+    DataTag_EdgesGroup,          ///< child group objects
+    DataTag_ChildAltitudeObject, ///< child altitude object
   };
 
 public:
   DEFINE_STANDARD_RTTI(HYDROData_Object);
 
+  /**
+   * Updates the name of this object.
+   * Reimplemented to update the names child groups.
+   */
+  HYDRODATA_EXPORT virtual void SetName( const QString& theName );
+
   /**
    * Update the geometry object.
    * Call this method whenever you made changes for object data.
@@ -76,25 +85,41 @@ public:
   
   /**
    * Returns reference object which represent the 3D shape of object.
-   * Base implementation returns NULL pointer.
    */
   HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const;
 
 
   /**
-   * Set reference bathymetry object for geometry object.
+   * Returns sequence of object groups.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const;
+
+  /**
+   * Returns group data model object by it id.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) GetGroup( const int theGroupId ) const;
+
+  /**
+   * Returns group id by data model object.
+   */
+  HYDRODATA_EXPORT virtual int GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const;
+
+
+  /**
+   * Set reference altitude object for geometry object.
    */
-  HYDRODATA_EXPORT virtual void SetBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
+  HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
 
   /**
-   * Returns reference bathymetry object of geometry object.
+   * Returns reference altitude object of geometry object.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetBathymetry() const;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const;
 
   /**
-   * Clear the reference bathymetry object for geometry object.
+   * Clear the reference altitude object for geometry object.
    */
-  HYDRODATA_EXPORT virtual void RemoveBathymetry();
+  HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
+
 
    /**
    * Sets filling color for object.
@@ -116,16 +141,6 @@ public:
    */
   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:
 
   /**
@@ -153,6 +168,13 @@ protected:
 
 protected:
 
+  /**
+   * Dump the initial object creation to a Python script.
+   * Reimplemented to dump the object colors.
+   */
+  HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
+
+
   /**
    * Checks and if necessary create child 3D object.
    * Reimplement this function in your subclass if you 
@@ -160,6 +182,38 @@ protected:
    */
   HYDRODATA_EXPORT virtual void checkAndSetObject3D();
 
+
+  /**
+   * Returns the type of child altitude object.
+   * Base implementation returns KIND_UNKNOWN, it means that child altitude 
+   * object will not be created inside of checkAndSetAltitudeObject() function.
+   * Reimplement this function in your subclass an return correct altitude
+   * object type if you want to create child altitude object.
+   */
+  HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
+
+  /**
+   * Checks and if necessary create child altitude object.
+   */
+  HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject();
+
+  /**
+   * Return the child altitude object.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const;
+
+
+  /**
+   * Create new one child group object.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
+
+  /**
+   * Remove all child group objects.
+   */
+  HYDRODATA_EXPORT virtual void removeGroupObjects();
+
+
   /**
    * Retrieve the top shape of the object from data label.
    */