Salome HOME
porting on linux
[modules/hydro.git] / src / HYDROData / HYDROData_Object.h
index 0e19876dcbfd7ea34af317416e94e731b7190253..0c217f274a6464e8e44d93c5271e4c7de578453b 100644 (file)
@@ -1,10 +1,26 @@
+// 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_Object_HeaderFile
 #define HYDROData_Object_HeaderFile
 
 #include <HYDROData_Entity.h>
 
-
 DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
 
 class TopoDS_Shape;
@@ -27,11 +43,13 @@ protected:
     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
     DataTag_TopShape,
     DataTag_Shape3D,
-    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_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
+    DataTag_IsSubmersible,       ///< the attribute "is submersible"
   };
 
 public:
@@ -58,7 +76,7 @@ public:
    * 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 );
+  HYDRODATA_EXPORT virtual void Changed( Geometry );
 
 
   /**
@@ -69,7 +87,7 @@ public:
   /**
    * Returns the top shape of the object.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const = 0;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
 
   /**
    * Sets the 3d shape of the object.
@@ -79,19 +97,29 @@ public:
   /**
    * Returns the 3d shape of the object.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0;
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
 
-  
   /**
    * 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;
 
+  /**
+   * 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.
@@ -129,27 +157,11 @@ public:
    */
   HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
 
-  /**
-   * Returns default filling color for new object.
-   */
-  HYDRODATA_EXPORT static QColor DefaultFillingColor();
+  HYDRODATA_EXPORT bool IsSubmersible() const;
+  HYDRODATA_EXPORT void SetIsSubmersible( bool ) const;
 
-  /**
-   * 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;
+  HYDRODATA_EXPORT virtual void GetBoundaries( QList<TopoDS_Shape>& theBoundShapes,
+                                               QStringList& theBoundNames ) const;
 
 protected:
 
@@ -157,7 +169,7 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDRODATA_EXPORT HYDROData_Object();
+  HYDRODATA_EXPORT HYDROData_Object( Geometry );
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
@@ -165,6 +177,15 @@ protected:
   virtual HYDRODATA_EXPORT ~HYDROData_Object();
 
 protected:
+  HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
+  HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
+
+  /**
+   * 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.
@@ -175,42 +196,44 @@ protected:
 
 
   /**
-   * Create new one child group object.
+   * 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 Handle(HYDROData_ShapesGroup) createGroupObject();
+  HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 
   /**
-   * Create all necessary child group objects.
-   * Base implementation does nothing.
+   * Checks and if necessary create child altitude object.
    */
-  HYDRODATA_EXPORT virtual void createGroupObjects();
+  HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject();
 
   /**
-   * Remove all child group objects.
+   * Return the child altitude object.
    */
-  HYDRODATA_EXPORT virtual void removeGroupObjects();
+  HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const;
 
 
   /**
-   * Retrieve the top shape of the object from data label.
+   * Create new one child group object.
    */
-  HYDRODATA_EXPORT TopoDS_Shape getTopShape() const;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
 
   /**
-   * Removes the top shape from data label of the object.
+   * Remove all child group objects.
    */
-  HYDRODATA_EXPORT void removeTopShape();
-
+  HYDRODATA_EXPORT virtual void RemoveGroupObjects();
 
   /**
-   * Retrieve the 3d shape of the object from data label.
+   * Removes the top shape from data label of the object.
    */
-  HYDRODATA_EXPORT TopoDS_Shape getShape3D() const;
+  HYDRODATA_EXPORT void RemoveTopShape();
 
   /**
    * Removes the 3d shape from data label of the object.
    */
-  HYDRODATA_EXPORT void removeShape3D();
+  HYDRODATA_EXPORT void RemoveShape3D();
 };
 
 #endif