src/HYDROGUI/HYDROGUI_Tool.h

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROGUI_TOOL_H
  24 #define HYDROGUI_TOOL_H
  25
  26 #include <HYDROData_Image.h>
  27
  28 #include <GraphicsView_Defs.h>
  29 #include <GraphicsView_ViewPort.h>
  30
  31 #include <TCollection_AsciiString.hxx>
  32 #include <TCollection_ExtendedString.hxx>
  33 #include <TCollection_HAsciiString.hxx>
  34 #include <TCollection_HExtendedString.hxx>
  35
  36 class SUIT_ViewManager;
  37
  38 class HYDROGUI_DataModel;
  39 class HYDROGUI_Module;
  40 class HYDROGUI_Prs;
  41
  42 class QDockWidget;
  43
  44 /**
  45  * \class HYDROGUI_Tool
  46  * \brief This class contains several useful methods.
  47  */
  48 class HYDROGUI_Tool
  49 {
  50 public:
  51   /**
  52    * \brief Convert \a TCollection_AsciiString to \a QString
  53    */
  54   static QString                                  ToQString( const TCollection_AsciiString& );
  55
  56   /**
  57    * \brief Convert \a TCollection_ExtendedString to \a QString
  58    */
  59   static QString                                  ToQString( const TCollection_ExtendedString& );
  60
  61   /**
  62    * \brief Convert \a Handle_TCollection_HAsciiString to \a QString
  63    */
  64   static QString                                  ToQString( const Handle(TCollection_HAsciiString)& );
  65
  66   /**
  67    * \brief Convert \a Handle_TCollection_HExtendedString to \a QString
  68    */
  69   static QString                                  ToQString( const Handle(TCollection_HExtendedString)& );
  70
  71   /**
  72    * \brief Convert \a QString to \a TCollection_AsciiString
  73    */
  74   static TCollection_AsciiString                  ToAsciiString( const QString& );
  75
  76   /**
  77    * \brief Convert \a QString to \a TCollection_ExtendedString
  78    */
  79   static TCollection_ExtendedString               ToExtString( const QString& );
  80
  81   /**
  82    * \brief Convert \a QString to \a Handle_TCollection_HAsciiString
  83    */
  84   static Handle(TCollection_HAsciiString)         ToHAsciiString( const QString& );
  85
  86   /**
  87    * \brief Convert \a QString to \a Handle_TCollection_HExtendedString
  88    */
  89   static Handle(TCollection_HExtendedString)      ToHExtString( const QString& );
  90
  91   /**
  92    * \brief Check that the specified objects are equal.
  93    * \param theObj1 first object
  94    * \param theObj2 second object
  95    */
  96   static bool                     IsEqual( const Handle(HYDROData_Object)& theObj1,
  97                                            const Handle(HYDROData_Object)& theObj2 );
  98
  99   /**
 100    * \brief Set the specified view manager to be active on the desktop.
 101    * \param theModule module
 102    * \param theViewManager view manager
 103    */
 104   static void                     SetActiveViewManager( HYDROGUI_Module* theModule,
 105                                                         SUIT_ViewManager* theViewManager );
 106
 107   /**
 108    * \brief Get sub-objects to build presentations.
 109    * \param theModule module
 110    * \param theSeq sequence of sub-objects
 111    */
 112   static void                     GetPrsSubObjects( HYDROGUI_Module* theModule,
 113                                                     HYDROData_SequenceOfObjects& theSeq );
 114
 115   /**
 116    * \brief Get presentation built for specified data object.
 117    * \param theObj data object
 118    * \param theObjects list of existing presentations
 119    * \return presentation
 120    */
 121   static HYDROGUI_Prs*            GetPresentation( const Handle(HYDROData_Object)& theObj,
 122                                                    const GraphicsView_ObjectList& theObjects );
 123
 124   /**
 125    * \brief Get list of HYDRO presentations from the specified viewport.
 126    * \param theViewPort viewport
 127    * \return list of HYDRO presentations
 128    */
 129   static GraphicsView_ObjectList  GetPrsList( GraphicsView_ViewPort* theViewPort );
 130
 131   /**
 132    * \brief Get list of the selected data objects.
 133    * \param theModule module
 134    * \return list of the selected data objects
 135    */
 136   static HYDROData_SequenceOfObjects GetSelectedObjects( HYDROGUI_Module* theModule );
 137
 138   /**
 139    * \brief Get the selected data object (first in the selected list).
 140    * \param theModule module
 141    * \return selected data object
 142    */
 143   static Handle(HYDROData_Object) GetSelectedObject( HYDROGUI_Module* theModule );
 144
 145   /**
 146    * \brief Get kind of objects the selected partition contains.
 147    * \param theModule module
 148    * \return object kind
 149    */
 150   static ObjectKind GetSelectedPartition( HYDROGUI_Module* theModule );
 151
 152   /**
 153    * \brief Find the data object with the specified name.
 154    * \param theModule module
 155    * \param theName name
 156    * \param theObjectKind kind of object
 157    * \return data object
 158    */
 159   static Handle(HYDROData_Object) FindObjectByName( HYDROGUI_Module* theModule,
 160                                                     const QString& theName,
 161                                                     const ObjectKind theObjectKind = KIND_UNKNOWN );
 162
 163   /**
 164    * \brief Find the data objects with the specified names.
 165    * \param theModule module
 166    * \param theNames list of names
 167    * \param theObjectKind kind of object
 168    * \return list of data objects
 169    */
 170   static HYDROData_SequenceOfObjects FindObjectsByNames( HYDROGUI_Module*   theModule,
 171                                                          const QStringList& theNames,
 172                                                          const ObjectKind   theObjectKind = KIND_UNKNOWN );
 173
 174   /**
 175    * \brief Generate name for new object.
 176    * \param theModule module
 177    * \param thePrefix name prefix
 178    * \param theUsedNames list of already used names
 179    * \return generated name
 180    */
 181   static QString                  GenerateObjectName( HYDROGUI_Module*   theModule,
 182                                                       const QString&     thePrefix,
 183                                                       const QStringList& theUsedNames = QStringList() );
 184
 185   /**
 186    * \brief Get id of the active view.
 187    * \param theModule module
 188    * \return view id
 189    */
 190   static size_t                   GetActiveViewId( HYDROGUI_Module* theModule,
 191                                                    const QString&   theViewId = QString() );
 192
 193   /**
 194    * \brief Get id of the active GraphicsView view.
 195    * \param theModule module
 196    * \return view id
 197    */
 198   static size_t                   GetActiveGraphicsViewId( HYDROGUI_Module* theModule );
 199
 200   /**
 201    * \brief Get id of the active OCC view.
 202    * \param theModule module
 203    * \return view id
 204    */
 205   static size_t                   GetActiveOCCViewId( HYDROGUI_Module* theModule );
 206
 207   /**
 208    * \brief Get list of ids of existing GraphicsView views.
 209    * \param theModule module
 210    * \return list of view ids
 211    */
 212   static QList<size_t>            GetGraphicsViewIdList( HYDROGUI_Module* theModule );
 213
 214   /**
 215    * \brief Get list of ids of existing OCC views.
 216    * \param theModule module
 217    * \return list of view ids
 218    */
 219   static QList<size_t>            GetOCCViewIdList( HYDROGUI_Module* theModule );
 220
 221   /**
 222    * \brief Get the list of references (recursively) for the specified image object
 223    * \param theImage image data object
 224    * \param theRefObjects list of reference objects
 225    * \param theRefNames list of reference object names
 226    */
 227   static void                     GetObjectReferences( const Handle(HYDROData_Image)& theImage,
 228                                                        HYDROData_SequenceOfObjects& theRefObjects,
 229                                                        QStringList& theRefNames );
 230
 231   /**
 232    * \brief Get the list of back-references for the specified object
 233    * \param theModule module
 234    * \param theObj data object
 235    * \param theBackRefObjects list of back-reference objects
 236    * \param theBackRefNames list of back-reference object names
 237    */
 238   static void                     GetObjectBackReferences( HYDROGUI_Module* theModule,
 239                                                            const Handle(HYDROData_Object)& theObj,
 240                                                            HYDROData_SequenceOfObjects& theBackRefObjects,
 241                                                            QStringList& theBackRefNames );
 242
 243   /**
 244    * \brief Get father dock window for widget
 245    * \param wid widget
 246    * \return dock window
 247    */
 248   static QDockWidget*             WindowDock( QWidget* wid );
 249
 250   /**
 251    * \brief Generates the filling color for intersected zone
 252    * \param theModule module
 253    * \param theZoneNames list of intersected zones
 254    * \return result color
 255    */
 256   static QColor                   GenerateFillingColor( HYDROGUI_Module*   theModule,
 257                                                         const QStringList& theZoneNames );
 258
 259 };
 260
 261 #endif