src/SMESHGUI/SMESHGUI_Utils.h

   1 // Copyright (C) 2007-2021  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, or (at your option) any later version.
  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 // SMESH SMESHGUI : GUI for SMESH component
  24 // File   : SMESHGUI_Utils.h
  25 // Author : Open CASCADE S.A.S.
  26 //
  27 #ifndef SMESHGUI_UTILS_H
  28 #define SMESHGUI_UTILS_H
  29
  30 // SMESH includes
  31 #include "SMESH_SMESHGUI.hxx"
  32
  33 // CORBA includes
  34 #include <omniORB4/CORBA.h>
  35
  36 // SALOME KERNEL includes
  37 #include <SALOMEDSClient_definitions.hxx>
  38 #include <SALOME_GenericObj_wrap.hxx>
  39
  40 // SALOME GUI includes
  41 #include <SALOME_InteractiveObject.hxx>
  42 #include <LightApp_DataOwner.h>
  43
  44 //OCC includes
  45 #include <gp_XYZ.hxx>
  46
  47 #include <SALOMEconfig.h>
  48 #include CORBA_CLIENT_HEADER(SMESH_Mesh)
  49
  50 class SUIT_ViewWindow;
  51 class SUIT_Desktop;
  52 class SUIT_Study;
  53 class SUIT_ResourceMgr;
  54
  55 class CAM_Module;
  56
  57 class SALOMEDSClient_Study;
  58 class SALOMEDSClient_SObject;
  59
  60 class SalomeApp_Study;
  61 class SalomeApp_Module;
  62 class LightApp_SelectionMgr;
  63
  64 class SMDS_MeshFace;
  65
  66 namespace SMESH
  67 {
  68 SMESHGUI_EXPORT
  69   SUIT_Desktop*
  70   GetDesktop( const CAM_Module* );
  71
  72 SMESHGUI_EXPORT
  73   LightApp_SelectionMgr*
  74   GetSelectionMgr( const SalomeApp_Module* );
  75
  76 SMESHGUI_EXPORT
  77   SalomeApp_Study*
  78   GetAppStudy( const CAM_Module* );
  79
  80 SMESHGUI_EXPORT
  81   SUIT_ResourceMgr*
  82   GetResourceMgr( const SalomeApp_Module* );
  83
  84 SMESHGUI_EXPORT
  85   CORBA::Object_var DataOwnerToObject( const LightApp_DataOwnerPtr& );
  86
  87   template<class TInterface> typename TInterface::_var_type
  88     DataOwnerToInterface( const LightApp_DataOwnerPtr& theDataOwner )
  89     {
  90       CORBA::Object_var anObj = DataOwnerToObject(theDataOwner);
  91       if(!CORBA::is_nil(anObj))
  92         return TInterface::_narrow(anObj);
  93       return TInterface::_nil();
  94     }
  95
  96 SMESHGUI_EXPORT
  97   SUIT_Study* GetActiveStudy();
  98
  99 SMESHGUI_EXPORT
 100   SUIT_ViewWindow* GetActiveWindow();
 101
 102 SMESHGUI_EXPORT
 103   _PTR(Study) getStudy();
 104
 105 SMESHGUI_EXPORT
 106   _PTR(SObject) FindSObject( CORBA::Object_ptr );
 107
 108 SMESHGUI_EXPORT
 109   void SetName( _PTR(SObject), const QString& );
 110
 111 SMESHGUI_EXPORT
 112   void SetValue( _PTR(SObject), const QString& );
 113   void setFileType( _PTR(SObject), const QString& );
 114   void setFileName( _PTR(SObject), const QString& );
 115
 116 SMESHGUI_EXPORT
 117   CORBA::Object_var SObjectToObject( _PTR(SObject) );
 118
 119   template<class TInterface> typename TInterface::_var_type
 120     SObjectToInterface( _PTR(SObject) theSObject )
 121     {
 122       CORBA::Object_var anObj = SObjectToObject(theSObject);
 123       if(!CORBA::is_nil(anObj))
 124         return TInterface::_narrow(anObj);
 125       return TInterface::_nil();
 126     }
 127
 128 SMESHGUI_EXPORT
 129   _PTR(SObject) ObjectToSObject( CORBA::Object_ptr );
 130
 131 SMESHGUI_EXPORT
 132   CORBA::Object_var IObjectToObject( const Handle(SALOME_InteractiveObject)& );
 133
 134   template<class TInterface> typename TInterface::_var_type
 135     IObjectToInterface( const Handle(SALOME_InteractiveObject)& theIO )
 136     {
 137       CORBA::Object_var anObj = IObjectToObject(theIO);
 138       if(!CORBA::is_nil(anObj))
 139         return TInterface::_narrow(anObj);
 140       return TInterface::_nil();
 141     }
 142
 143 SMESHGUI_EXPORT
 144   CORBA::Object_var IORToObject( const QString& );
 145
 146   template<class TInterface> typename TInterface::_var_type
 147     IORToInterface( const QString& theIOR )
 148     {
 149       CORBA::Object_var anObj = IORToObject( theIOR );
 150       if ( !CORBA::is_nil( anObj ) )
 151         return TInterface::_narrow( anObj );
 152       return TInterface::_nil();
 153     }
 154
 155 SMESHGUI_EXPORT
 156   CORBA::Object_var EntryToObject( const QString& );
 157
 158   template<class TInterface> typename TInterface::_var_type
 159     EntryToInterface( const QString& theEntry )
 160     {
 161       CORBA::Object_var anObj = EntryToObject( theEntry );
 162       if ( !CORBA::is_nil( anObj ) )
 163         return TInterface::_narrow( anObj );
 164       return TInterface::_nil();
 165     }
 166
 167 SMESHGUI_EXPORT
 168   int GetNameOfSelectedIObjects( LightApp_SelectionMgr*, QString& );
 169
 170 SMESHGUI_EXPORT
 171   QString GetName( const Handle(SALOME_InteractiveObject)& theIO );
 172
 173 SMESHGUI_EXPORT
 174   _PTR(SObject) GetMeshOrSubmesh( _PTR(SObject) );
 175
 176 SMESHGUI_EXPORT
 177   void ShowHelpFile( const QString& );
 178
 179   /*!
 180    * \brief Return the normal to a face
 181     * \param theFace - input face
 182     * \retval gp_XYZ - normal to a face
 183    */
 184 SMESHGUI_EXPORT
 185   gp_XYZ getNormale( const SMDS_MeshFace* theFace );
 186
 187
 188   // type to use instead of SMESH_IDSource_var for automatic UnRegister()
 189   typedef SALOME::GenericObj_wrap<SMESH_IDSource> IDSource_wrap;
 190
 191   /*!
 192    * \brief Class useful to convert a string returned from a CORBA call
 193    *        to other string types w/o memory leak.
 194    *
 195    *        Usage (of instantiations): QString s = toQStr( objVar->GetName() );
 196    *                              std::string ss = toStdStr( objVar->GetName() );
 197    */
 198   template < class _STRING >
 199   class toStrT : public _STRING {
 200     CORBA::String_var myStr;
 201   public:
 202     toStrT( char* s ): _STRING( s ), myStr(s)
 203     {}
 204     operator const char*() const
 205     { return myStr.in(); }
 206   };
 207   // Instantiations:
 208   struct toQStr : public toStrT< QString > {
 209     toQStr( char* s ): toStrT< QString >(s) {}
 210   };
 211   struct toStdStr : public toStrT< std::string > {
 212     toStdStr( char* s ): toStrT< std::string >(s) {}
 213   };
 214
 215   QString fromUtf8( const char* txt );
 216   QString fromUtf8( const std::string& txt );
 217   struct toUtf8: public std::string
 218   {
 219     toUtf8( const QString& txt );
 220     operator const char*() const { return c_str(); }
 221   };
 222 }
 223
 224 #endif // SMESHGUI_UTILS_H