Salome HOME
updated copyright message
[modules/gui.git] / src / OCCViewer / OCCViewer_Utilities.h
1 // Copyright (C) 2014-2023  CEA, EDF, OPEN CASCADE
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef OCCVIEWER_UTILITIES_H
21 #define OCCVIEWER_UTILITIES_H
22
23 // internal includes
24 #include "OCCViewer.h"
25 #include "OCCViewer_ViewWindow.h"
26
27 // OCC includes
28 #include <Image_PixMap.hxx>
29
30 class QImage;
31 class OCCViewer_Viewer;
32
33 #ifdef WIN32
34 #pragma warning ( disable:4251 )
35 #endif
36
37 class OCCVIEWER_EXPORT OCCViewer_Utilities
38 {
39 public:
40
41   /*!
42    * Convert Qt image to OCCT pixmap
43    * \param theImage Qt source image
44    * \return resulting OCCT pixmap
45    */
46   static Handle(Image_PixMap) imageToPixmap( const QImage& theImage );
47
48   /*!
49    * Set 2D mode for the viewer. Hide or show 3D actions.
50    * \param theViewer an OCC viewer
51    * \param theMode OCC view window mode
52    * \return the old 2d mode.
53    */
54   static OCCViewer_ViewWindow::Mode2dType
55               setViewer2DMode( OCCViewer_Viewer* theViewer,
56                                const OCCViewer_ViewWindow::Mode2dType& theMode );
57
58   /*!
59    * Find dialog in the current view frame by name
60    * \param theView an OCC view
61    * \param theName name of dialog
62    * \return true/false if dialog is opened/isn't opened
63    */
64   static bool isDialogOpened( OCCViewer_ViewWindow* theView, const QString& theName );
65
66   /*!
67    * Get bounding box of visible objects.
68    * \param theView defined occ view
69    * \param theBounds used to return bounds of the bounding box
70    * \return \c true if the bounding box is computed
71    */
72   static bool computeVisibleBounds( const Handle(V3d_View) theView, double theBounds[6] );
73
74   /*!
75    * Compute the bounding box center of visible objects.
76    * \param theView defined occ view
77    * \param theX used to return X coordinate of the bounding box center
78    * \param theY used to return Y coordinate of the bounding box center
79    * \param theZ used to return Z coordinate of the bounding box center
80    * \return \c true if the bounding box center is computed
81    */
82   static bool computeVisibleBBCenter( const Handle(V3d_View) theView, double& theX, double& theY, double& theZ );
83
84   static bool computeSceneBBCenter( const Handle(V3d_View) theView, double& theX, double& theY, double& theZ );
85 };
86
87 #endif // OCCVIEWER_UTILITIES_H