6b6869762d34dc3ad4bfbceb6d2ff74489a27388
[occt.git] / src / OpenGl / OpenGl_Window.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_Window_Header
17 #define _OpenGl_Window_Header
18
19 #include <OpenGl_GlCore11.hxx>
20 #include <InterfaceGraphic_Aspect.hxx>
21 #include <OpenGl_Caps.hxx>
22
23 #include <Handle_OpenGl_Context.hxx>
24 #include <Handle_OpenGl_Window.hxx>
25 #include <Handle_OpenGl_GraphicDriver.hxx>
26
27 #include <MMgt_TShared.hxx>
28
29 //! This class represents low-level wrapper over window with GL context.
30 //! The window itself should be provided to constructor.
31 class OpenGl_Window : public MMgt_TShared
32 {
33 public:
34
35   //! Main constructor - prepare GL context for specified window.
36   OpenGl_Window (const Handle(OpenGl_GraphicDriver)& theDriver,
37                  const CALL_DEF_WINDOW&        theCWindow,
38                  Aspect_RenderingContext       theGContext,
39                  const Handle(OpenGl_Caps)&    theCaps,
40                  const Handle(OpenGl_Context)& theShareCtx);
41
42   //! Destructor
43   virtual ~OpenGl_Window();
44
45   //! Resizes the window.
46   void Resize (const CALL_DEF_WINDOW& theCWindow);
47
48   //! Reads depth component for current scene into specified buffer.
49   void ReadDepths (const Standard_Integer theX,     const Standard_Integer theY,
50                    const Standard_Integer theWidth, const Standard_Integer theHeight,
51                    float* theDepths);
52
53   void SetBackgroundColor (const Standard_ShortReal theR,
54                            const Standard_ShortReal theG,
55                            const Standard_ShortReal theB);
56
57   Standard_Integer Width()  const { return myWidth; }
58   Standard_Integer Height() const { return myHeight; }
59   const TEL_COLOUR& BackgroundColor() const { return myBgColor; }
60
61   const Handle(OpenGl_Context)& GetGlContext() const { return myGlContext; }
62
63 protected:
64
65   //! Activates GL context and setup viewport.
66   void Init();
67
68   //! Makes GL context for this window active in current thread
69   virtual Standard_Boolean Activate();
70
71   void EnableFeatures() const;
72   void DisableFeatures() const;
73
74   //! Draw directly to the FRONT buffer. Can cause artifacts on the screen.
75   void MakeFrontBufCurrent() const;
76
77   //! Draw to BACK buffer. Normal and default state.
78   void MakeBackBufCurrent() const;
79
80 protected:
81
82   Handle(OpenGl_Context) myGlContext;
83   Standard_Boolean       myOwnGContext; //!< set to TRUE if GL context was not created by this class
84   Standard_Integer       myWidth;       //!< window width
85   Standard_Integer       myHeight;      //!< window height
86   TEL_COLOUR             myBgColor;     //!< background color
87
88 public:
89
90   DEFINE_STANDARD_RTTI(OpenGl_Window) // Type definition
91   DEFINE_STANDARD_ALLOC
92
93 };
94
95 #endif //_OpenGl_Window_Header