Salome HOME
refs #550: fix crash when myObject is NULL
[modules/hydro.git] / src / HYDROGUI / HYDROGUI_Tool.h
index cb77fb75c6468dd6a2efd39ed24c43294ff682c4..4ea4039edd77b2fec67829cf454ccb8205fad0db 100644 (file)
@@ -1,12 +1,8 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
-//
-// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-//
+// 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.
+// 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
 #include <TCollection_HAsciiString.hxx>
 #include <TCollection_HExtendedString.hxx>
 
+#include <Image_PixMap.hxx>
+
+// IDL includes
+#include <SALOMEconfig.h>
+#include CORBA_SERVER_HEADER(GEOM_Gen)
+
 class SUIT_ViewManager;
+class OCCViewer_ViewFrame;
 
 class HYDROGUI_DataModel;
 class HYDROGUI_Module;
 class HYDROGUI_Prs;
 
 class QDockWidget;
+class Handle(HYDROData_Document);
 
 /**
  * \class HYDROGUI_Tool
@@ -89,28 +93,17 @@ public:
   static Handle(TCollection_HExtendedString)      ToHExtString( const QString& );
 
   /**
-   * \brief Encode the Lambert93 coordinates to the absolute double value
-   */
-  static void                     LambertToDouble( const int theDegrees,
-                                                   const int theMinutes,
-                                                   const double theSeconds,
-                                                   double& theCoord );
-
-  /**
-   * \brief Decode the Lambert93 coordinates from the absolute double value
+   * \brief Get the active study id.
+   * \return active study id
    */
-  static void                     DoubleToLambert( const double theCoord,
-                                                   int& theDegrees,
-                                                   int& theMinutes,
-                                                   double& theSeconds );
+  static int                      GetActiveStudyId();
 
   /**
-   * \brief Check that the specified objects are equal.
-   * \param theObj1 first object
-   * \param theObj2 second object
+   * \brief Get path to the temporary directory.
+   * \param theToCreate flag used to create a directory if it doesn't exist
+   * \return path
    */
-  static bool                     IsEqual( const Handle(HYDROData_Object)& theObj1,
-                                           const Handle(HYDROData_Object)& theObj2 );
+  static QString                  GetTempDir( const bool theToCreate );
 
   /**
    * \brief Set the specified view manager to be active on the desktop.
@@ -121,6 +114,14 @@ public:
                                                         SUIT_ViewManager* theViewManager );
 
   /**
+   * \brief Returns TRUE if object can be shown on the viewer.
+   * \param theObject data model object to check
+   * \param theViewerType viewer type
+   */
+  static bool                     IsObjectHasPresentation( const Handle(HYDROData_Entity)& theObject,
+                                                           const QString&                  theViewerType = "" );
+
+/**
    * \brief Get sub-objects to build presentations.
    * \param theModule module
    * \param theSeq sequence of sub-objects
@@ -134,7 +135,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 );
 
   /**
@@ -156,7 +157,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.
@@ -164,7 +172,7 @@ public:
    * \return object kind
    */
   static ObjectKind GetSelectedPartition( HYDROGUI_Module* theModule );
-
+  
   /**
    * \brief Find the data object with the specified name.
    * \param theModule module
@@ -172,7 +180,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 );
 
@@ -192,11 +200,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.
@@ -234,13 +244,33 @@ public:
    */
   static QList<size_t>            GetOCCViewIdList( HYDROGUI_Module* theModule );
 
+
+  /**
+   * \brief Change OCC viewer action visibility.
+   * \param theViewFrame OCC viewer frame
+   * \param theActionId an action index, which state should be changed
+   * \param isShown the action visibility state
+   */
+  static void                     setOCCActionShown( OCCViewer_ViewFrame* theViewFrame,
+                                                     const int theActionId,
+                                                     const bool isShown );
+
+  /**
+   * \brief Change OCC viewer action visibility for all opened views.
+   * \param theActionId an action index, which state should be changed
+   * \param isShown the action visibility state
+   */
+  static void                     setOCCActionShown( HYDROGUI_Module* theModule,
+                                                     const int theActionId,
+                                                     const bool isShown );
+
   /**
-   * \brief Get the list of references (recursively) for the specified image object
-   * \param theImage image data object
+   * \brief Get the list of references (recursively) for the specified data object
+   * \param theObj data object
    * \param theRefObjects list of reference objects
    * \param theRefNames list of reference object names
    */
-  static void                     GetObjectReferences( const Handle(HYDROData_Image)& theImage,
+  static void                     GetObjectReferences( const Handle(HYDROData_Entity)& theObj,
                                                        HYDROData_SequenceOfObjects& theRefObjects,
                                                        QStringList& theRefNames );
 
@@ -248,13 +278,19 @@ public:
    * \brief Get the list of back-references for the specified object
    * \param theModule module
    * \param theObj data object
-   * \param theBackRefObjects list of back-reference objects
-   * \param theBackRefNames list of back-reference object names
+   * \return list of back-reference objects
+   */
+  static HYDROData_SequenceOfObjects GetObjectBackReferences( HYDROGUI_Module*                theModule,
+                                                              const Handle(HYDROData_Entity)& theObj );
+
+  /**
+   * \brief Get the map of back-references for the specified list of objects
+   * \param theModule module
+   * \param theObjectNames names of objects
+   * \return map of back-reference objects
    */
-  static void                     GetObjectBackReferences( HYDROGUI_Module* theModule,
-                                                           const Handle(HYDROData_Object)& theObj,
-                                                           HYDROData_SequenceOfObjects& theBackRefObjects,
-                                                           QStringList& theBackRefNames );
+  static QMap<QString,HYDROData_SequenceOfObjects> GetObjectsBackReferences( HYDROGUI_Module*   theModule,
+                                                                             const QStringList& theObjectNames );
 
   /**
    * \brief Get father dock window for widget 
@@ -272,6 +308,54 @@ 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, 
+                                                            bool isCheckValidProfile = false );
+
+  /**
+   * \brief Converts coordinate value to string.
+   * \param theNumber coordinate as a number
+   * \return coordinate as a string
+   */
+  static QString                  GetCoordinateString( const double theNumber, bool isInLocale );
+
+  /**
+   * \brief Converts Qt QImage object to OCCT Image_PixMap object.
+   * \param theImage QImage object
+   * \return Image_PixMap object
+   */
+  static Handle(Image_PixMap)     Pixmap( const QImage& theImage );
+
+  /**
+   * \brief Get the selected GEOM objects.
+   * \param theModule the module
+   * \param theTypes the acceptable GEOM object types
+   * \return list of GEOM objects entries
+   */
+  static QStringList GetSelectedGeomObjects( HYDROGUI_Module* theModule,
+                                             QList<GEOM::shape_type> theTypes );
+
+  /**
+   * \brief Delete the GEOM objects.
+   * \param theModule the module
+   * \param theEntries the GEOM objects entries
+   */
+  static void DeleteGeomObjects( HYDROGUI_Module* theModule, const QStringList& theEntries );
 };
 
 #endif