1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef HYDROGUI_TOOL_H
24 #define HYDROGUI_TOOL_H
26 #include <HYDROData_Object.h>
28 #include <GraphicsView_Defs.h>
29 #include <GraphicsView_ViewPort.h>
31 #include <TCollection_AsciiString.hxx>
32 #include <TCollection_ExtendedString.hxx>
33 #include <TCollection_HAsciiString.hxx>
34 #include <TCollection_HExtendedString.hxx>
36 class SUIT_ViewManager;
38 class HYDROGUI_DataModel;
39 class HYDROGUI_Module;
43 * \class HYDROGUI_Tool
44 * \brief This class contains several useful methods.
50 * \brief Convert \a TCollection_AsciiString to \a QString
52 static QString ToQString( const TCollection_AsciiString& );
55 * \brief Convert \a TCollection_ExtendedString to \a QString
57 static QString ToQString( const TCollection_ExtendedString& );
60 * \brief Convert \a Handle_TCollection_HAsciiString to \a QString
62 static QString ToQString( const Handle(TCollection_HAsciiString)& );
65 * \brief Convert \a Handle_TCollection_HExtendedString to \a QString
67 static QString ToQString( const Handle(TCollection_HExtendedString)& );
70 * \brief Convert \a QString to \a TCollection_AsciiString
72 static TCollection_AsciiString ToAsciiString( const QString& );
75 * \brief Convert \a QString to \a TCollection_ExtendedString
77 static TCollection_ExtendedString ToExtString( const QString& );
80 * \brief Convert \a QString to \a Handle_TCollection_HAsciiString
82 static Handle(TCollection_HAsciiString) ToHAsciiString( const QString& );
85 * \brief Convert \a QString to \a Handle_TCollection_HExtendedString
87 static Handle(TCollection_HExtendedString) ToHExtString( const QString& );
90 * \brief Encode the Lambert93 coordinates to the absolute double value
92 static void LambertToDouble( const int theDegrees,
94 const double theSeconds,
98 * \brief Decode the Lambert93 coordinates from the absolute double value
100 static void DoubleToLambert( const double theCoord,
103 double& theSeconds );
106 * \brief Set the specified view manager to be active on the desktop.
107 * \param theModule module
108 * \param theViewManager view manager
110 static void SetActiveViewManager( HYDROGUI_Module* theModule,
111 SUIT_ViewManager* theViewManager );
114 * \brief Get sub-objects to build presentations.
115 * \param theModule module
116 * \param theSeq sequence of sub-objects
118 static void GetPrsSubObjects( HYDROGUI_Module* theModule,
119 HYDROData_SequenceOfObjects& theSeq );
122 * \brief Get presentation built for specified data object.
123 * \param theObj data object
124 * \param theObjects list of existing presentations
125 * \return presentation
127 static HYDROGUI_Prs* GetPresentation( const Handle(HYDROData_Object)& theObj,
128 const GraphicsView_ObjectList& theObjects );
131 * \brief Get list of HYDRO presentations from the specified viewport.
132 * \param theViewPort viewport
133 * \return list of HYDRO presentations
135 static GraphicsView_ObjectList GetPrsList( GraphicsView_ViewPort* theViewPort );
138 * \brief Get list of the selected data objects.
139 * \param theModule module
140 * \return list of the selected data objects
142 static HYDROData_SequenceOfObjects GetSelectedObjects( HYDROGUI_Module* theModule );
145 * \brief Get the selected data object (first in the selected list).
146 * \param theModule module
147 * \return selected data object
149 static Handle(HYDROData_Object) GetSelectedObject( HYDROGUI_Module* theModule );
152 * \brief Find the data object with the specified name.
153 * \param theModule module
154 * \param theName name
155 * \param theObjectKind kind of object
156 * \return data object
158 static Handle(HYDROData_Object) FindObjectByName( HYDROGUI_Module* theModule,
159 const QString& theName,
160 const ObjectKind theObjectKind = KIND_UNKNOWN );
163 * \brief Generate name for new object.
164 * \param theModule module
165 * \param thePrefix name prefix
166 * \return generated name
168 static QString GenerateObjectName( HYDROGUI_Module* theModule,
169 const QString& thePrefix );
172 * \brief Get id of the active GraphicsView view.
173 * \param theModule module
176 static size_t GetActiveGraphicsViewId( HYDROGUI_Module* theModule );
179 * \brief Get list of ids of existing GraphicsView views.
180 * \param theModule module
181 * \return list of view ids
183 static QList<size_t> GetGraphicsViewIdList( HYDROGUI_Module* theModule );