0024023: Revamp the OCCT Handle -- general
[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 #include <MMgt_TShared.hxx>
23
24
25 #if defined(__APPLE__)
26   #import <TargetConditionals.h>
27 #endif
28
29 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
30   #ifdef __OBJC__
31     @class UIView;
32   #else
33     struct UIView;
34   #endif
35 #endif
36
37 class OpenGl_Context;
38 class OpenGl_GraphicDriver;
39
40 class OpenGl_Window;
41 DEFINE_STANDARD_HANDLE(OpenGl_Window,MMgt_TShared)
42
43 //! This class represents low-level wrapper over window with GL context.
44 //! The window itself should be provided to constructor.
45 class OpenGl_Window : public MMgt_TShared
46 {
47 public:
48
49   //! Main constructor - prepare GL context for specified window.
50   OpenGl_Window (const Handle(OpenGl_GraphicDriver)& theDriver,
51                  const CALL_DEF_WINDOW&        theCWindow,
52                  Aspect_RenderingContext       theGContext,
53                  const Handle(OpenGl_Caps)&    theCaps,
54                  const Handle(OpenGl_Context)& theShareCtx);
55
56   //! Destructor
57   virtual ~OpenGl_Window();
58
59   //! Resizes the window.
60   void Resize (const CALL_DEF_WINDOW& theCWindow);
61
62   //! Reads depth component for current scene into specified buffer.
63   void ReadDepths (const Standard_Integer theX,     const Standard_Integer theY,
64                    const Standard_Integer theWidth, const Standard_Integer theHeight,
65                    float* theDepths);
66
67   void SetBackgroundColor (const Standard_ShortReal theR,
68                            const Standard_ShortReal theG,
69                            const Standard_ShortReal theB);
70
71   Standard_Integer Width()  const { return myWidth; }
72   Standard_Integer Height() const { return myHeight; }
73   const TEL_COLOUR& BackgroundColor() const { return myBgColor; }
74
75   const Handle(OpenGl_Context)& GetGlContext() const { return myGlContext; }
76
77 protected:
78
79   //! Activates GL context and setup viewport.
80   void Init();
81
82   //! Makes GL context for this window active in current thread
83   virtual Standard_Boolean Activate();
84
85   void EnableFeatures() const;
86   void DisableFeatures() const;
87
88 protected:
89
90   Handle(OpenGl_Context) myGlContext;
91   Standard_Boolean       myOwnGContext; //!< set to TRUE if GL context was not created by this class
92 #if defined(__APPLE__)
93 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
94   UIView*                myUIView;
95 #endif
96   Standard_Integer       myWidthPt;     //!< window width  in logical units
97   Standard_Integer       myHeightPt;    //!< window height in logical units
98 #endif
99   Standard_Integer       myWidth;       //!< window width  in pixels
100   Standard_Integer       myHeight;      //!< window height in pixels
101   TEL_COLOUR             myBgColor;     //!< background color
102
103   Standard_Integer       mySwapInterval;//!< last assigned swap interval (VSync) for this window
104
105 public:
106
107   DEFINE_STANDARD_RTTI(OpenGl_Window, MMgt_TShared) // Type definition
108   DEFINE_STANDARD_ALLOC
109
110 };
111
112 #endif //_OpenGl_Window_Header