0026273: Comments to methods are misplaced in gp_Vec.cdl
[occt.git] / src / OpenGl / OpenGl_Window.hxx
CommitLineData
b311480e 1// Created on: 2011-09-20
2// Created by: Sergey ZERCHANINOV
973c2be1 3// Copyright (c) 2011-2014 OPEN CASCADE SAS
b311480e 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
b311480e 6//
d5f74e42 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
973c2be1 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.
b311480e 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
b311480e 15
2166f0fa
SK
16#ifndef _OpenGl_Window_Header
17#define _OpenGl_Window_Header
18
3695b8c2 19#include <OpenGl_GlCore11.hxx>
2166f0fa 20#include <InterfaceGraphic_Aspect.hxx>
58655684 21#include <OpenGl_Caps.hxx>
2166f0fa 22
2166f0fa 23#include <Handle_OpenGl_Context.hxx>
3695b8c2 24#include <Handle_OpenGl_Window.hxx>
25b97fac 25#include <Handle_OpenGl_GraphicDriver.hxx>
3695b8c2 26
27#include <MMgt_TShared.hxx>
2166f0fa 28
a2e4f780 29#if defined(__APPLE__)
30 #import <TargetConditionals.h>
31#endif
32
33#if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
34 #ifdef __OBJC__
35 @class UIView;
36 #else
37 struct UIView;
38 #endif
39#endif
40
2166f0fa
SK
41//! This class represents low-level wrapper over window with GL context.
42//! The window itself should be provided to constructor.
43class OpenGl_Window : public MMgt_TShared
44{
45public:
46
47 //! Main constructor - prepare GL context for specified window.
25b97fac 48 OpenGl_Window (const Handle(OpenGl_GraphicDriver)& theDriver,
2166f0fa 49 const CALL_DEF_WINDOW& theCWindow,
5e27df78 50 Aspect_RenderingContext theGContext,
58655684 51 const Handle(OpenGl_Caps)& theCaps,
5e27df78 52 const Handle(OpenGl_Context)& theShareCtx);
2166f0fa
SK
53
54 //! Destructor
55 virtual ~OpenGl_Window();
56
57 //! Resizes the window.
58 void Resize (const CALL_DEF_WINDOW& theCWindow);
59
60 //! Reads depth component for current scene into specified buffer.
61 void ReadDepths (const Standard_Integer theX, const Standard_Integer theY,
62 const Standard_Integer theWidth, const Standard_Integer theHeight,
63 float* theDepths);
64
65 void SetBackgroundColor (const Standard_ShortReal theR,
66 const Standard_ShortReal theG,
67 const Standard_ShortReal theB);
68
2166f0fa
SK
69 Standard_Integer Width() const { return myWidth; }
70 Standard_Integer Height() const { return myHeight; }
71 const TEL_COLOUR& BackgroundColor() const { return myBgColor; }
2166f0fa
SK
72
73 const Handle(OpenGl_Context)& GetGlContext() const { return myGlContext; }
74
2166f0fa
SK
75protected:
76
77 //! Activates GL context and setup viewport.
78 void Init();
79
80 //! Makes GL context for this window active in current thread
81 virtual Standard_Boolean Activate();
82
83 void EnableFeatures() const;
84 void DisableFeatures() const;
85
2166f0fa
SK
86protected:
87
2166f0fa 88 Handle(OpenGl_Context) myGlContext;
2166f0fa 89 Standard_Boolean myOwnGContext; //!< set to TRUE if GL context was not created by this class
a2e4f780 90#if defined(__APPLE__)
91#if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
92 UIView* myUIView;
93#endif
94 Standard_Integer myWidthPt; //!< window width in logical units
95 Standard_Integer myHeightPt; //!< window height in logical units
96#endif
97 Standard_Integer myWidth; //!< window width in pixels
98 Standard_Integer myHeight; //!< window height in pixels
73192b37 99 TEL_COLOUR myBgColor; //!< background color
2166f0fa
SK
100
101public:
102
103 DEFINE_STANDARD_RTTI(OpenGl_Window) // Type definition
1c35b92f 104 DEFINE_STANDARD_ALLOC
2166f0fa
SK
105
106};
107
108#endif //_OpenGl_Window_Header