Feature #86: The hierarchy in the Object Browser (T 19).

[modules/hydro.git] / src / HYDROGUI / HYDROGUI_Tool.h

diff --git a/src/HYDROGUI/HYDROGUI_Tool.h b/src/HYDROGUI/HYDROGUI_Tool.h
index fc60e3b52d45820cd8d3a7de382f1bd77104eb6e..7a77b3af51efe00c0ca0c58a53ade409b7e6b32b 100644 (file)
--- a/src/HYDROGUI/HYDROGUI_Tool.h
+++ b/src/HYDROGUI/HYDROGUI_Tool.h
@@ -40,6 +40,7 @@ class HYDROGUI_Module;
 class HYDROGUI_Prs;
 
 class QDockWidget;
+class Handle(HYDROData_Document);
 
 /**
  * \class HYDROGUI_Tool
@@ -89,12 +90,17 @@ public:
   static Handle(TCollection_HExtendedString)      ToHExtString( const QString& );
 
   /**
-   * \brief Check that the specified objects are equal.
-   * \param theObj1 first object
-   * \param theObj2 second object
+   * \brief Get the active study id.
+   * \return active study id
    */
-  static bool                     IsEqual( const Handle(HYDROData_Object)& theObj1,
-                                           const Handle(HYDROData_Object)& theObj2 );
+  static int                      GetActiveStudyId();
+
+  /**
+   * \brief Get path to the temporary directory.
+   * \param theToCreate flag used to create a directory if it doesn't exist
+   * \return path
+   */
+  static QString                  GetTempDir( const bool theToCreate );
 
   /**
    * \brief Set the specified view manager to be active on the desktop.
@@ -118,7 +124,7 @@ public:
    * \param theObjects list of existing presentations
    * \return presentation
    */
-  static HYDROGUI_Prs*            GetPresentation( const Handle(HYDROData_Object)& theObj,
+  static HYDROGUI_Prs*            GetPresentation( const Handle(HYDROData_Entity)& theObj,
                                                    const GraphicsView_ObjectList& theObjects );
 
   /**
@@ -140,7 +146,14 @@ public:
    * \param theModule module
    * \return selected data object
    */
-  static Handle(HYDROData_Object) GetSelectedObject( HYDROGUI_Module* theModule );
+  static Handle(HYDROData_Entity) GetSelectedObject( HYDROGUI_Module* theModule );
+
+  /**
+   * \brief Get the geometry data objects from document.
+   * \param theModule module
+   * \return sequence of data objects
+   */
+  static HYDROData_SequenceOfObjects GetGeometryObjects( HYDROGUI_Module* theModule );
 
   /**
    * \brief Get kind of objects the selected partition contains.
@@ -149,6 +162,13 @@ public:
    */
   static ObjectKind GetSelectedPartition( HYDROGUI_Module* theModule );
 
+  /**
+   * \brief Get the selected GEOM objects.
+   * \param theModule module
+   * \return list of GEOM objects entries
+   */
+  static QStringList GetSelectedGeomObjects( HYDROGUI_Module* theModule );
+
   /**
    * \brief Find the data object with the specified name.
    * \param theModule module
@@ -156,7 +176,7 @@ public:
    * \param theObjectKind kind of object
    * \return data object
    */
-  static Handle(HYDROData_Object) FindObjectByName( HYDROGUI_Module* theModule,
+  static Handle(HYDROData_Entity) FindObjectByName( HYDROGUI_Module* theModule,
                                                     const QString& theName,
                                                     const ObjectKind theObjectKind = KIND_UNKNOWN );
 
@@ -176,11 +196,13 @@ public:
    * \param theModule module
    * \param thePrefix name prefix
    * \param theUsedNames list of already used names
+   * \param theIsTryToUsePurePrefix if true - the prefix will be returned if the name equal to the prefix is not busy
    * \return generated name
    */
   static QString                  GenerateObjectName( HYDROGUI_Module*   theModule,
                                                       const QString&     thePrefix,
-                                                      const QStringList& theUsedNames = QStringList() );
+                                                      const QStringList& theUsedNames = QStringList(),
+                                                      const bool         theIsTryToUsePurePrefix = false );
 
   /**
    * \brief Get id of the active view.
@@ -236,7 +258,7 @@ public:
    * \param theBackRefNames list of back-reference object names
    */
   static void                     GetObjectBackReferences( HYDROGUI_Module* theModule,
-                                                           const Handle(HYDROData_Object)& theObj,
+                                                           const Handle(HYDROData_Entity)& theObj,
                                                            HYDROData_SequenceOfObjects& theBackRefObjects,
                                                            QStringList& theBackRefNames );
 
@@ -256,6 +278,23 @@ public:
   static QColor                   GenerateFillingColor( HYDROGUI_Module*   theModule,
                                                         const QStringList& theZoneNames );
 
+  /**
+   * \brief Generates the filling color for intersected zone
+   * \param theDoc model document
+   * \param theZoneNames list of intersected zones
+   * \return result color
+   */
+  static QColor                   GenerateFillingColor( const Handle(HYDROData_Document)& theDoc,
+                                                        const QStringList&                theZoneNames );
+
+  /**
+   * \brief Find names of existing objects of the given kind.
+   * \param theDoc model document
+   * \param theObjectKind kind of object
+   * \return list of names
+   */
+  static QStringList              FindExistingObjectsNames( const Handle(HYDROData_Document)& theDoc, 
+                                                            const ObjectKind theObjectKind );
 };
 
 #endif