src/OpenGl/OpenGl_Window.hxx

   1 // Created on: 2011-09-20
   2 // Created by: Sergey ZERCHANINOV
   3 // Copyright (c) 2011-2012 OPEN CASCADE SAS
   4 //
   5 // The content of this file is subject to the Open CASCADE Technology Public
   6 // License Version 6.5 (the "License"). You may not use the content of this file
   7 // except in compliance with the License. Please obtain a copy of the License
   8 // at http://www.opencascade.org and read it completely before using this file.
   9 //
  10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 //
  13 // The Original Code and all software distributed under the License is
  14 // distributed on an "AS IS" basis, without warranty of any kind, and the
  15 // Initial Developer hereby disclaims all such warranties, including without
  16 // limitation, any warranties of merchantability, fitness for a particular
  17 // purpose or non-infringement. Please see the License for the specific terms
  18 // and conditions governing the rights and limitations under the License.
  19
  20
  21 #ifndef _OpenGl_Window_Header
  22 #define _OpenGl_Window_Header
  23
  24 #include <Handle_OpenGl_Window.hxx>
  25 #include <MMgt_TShared.hxx>
  26
  27 #include <InterfaceGraphic.hxx>
  28 #include <InterfaceGraphic_Aspect.hxx>
  29 #include <InterfaceGraphic_telem.hxx>
  30
  31 #include <Handle_OpenGl_Display.hxx>
  32 #include <Handle_OpenGl_Context.hxx>
  33
  34 //! This class represents low-level wrapper over window with GL context.
  35 //! The window itself should be provided to constructor.
  36 class OpenGl_Window : public MMgt_TShared
  37 {
  38 public:
  39
  40   //! Main constructor - prepare GL context for specified window.
  41   OpenGl_Window (const Handle(OpenGl_Display)& theDisplay,
  42                  const CALL_DEF_WINDOW&        theCWindow,
  43                  Aspect_RenderingContext       theGContext);
  44
  45   //! Destructor
  46   virtual ~OpenGl_Window();
  47
  48   //! Resizes the window.
  49   void Resize (const CALL_DEF_WINDOW& theCWindow);
  50
  51   //! Reads depth component for current scene into specified buffer.
  52   void ReadDepths (const Standard_Integer theX,     const Standard_Integer theY,
  53                    const Standard_Integer theWidth, const Standard_Integer theHeight,
  54                    float* theDepths);
  55
  56   void SetBackgroundColor (const Standard_ShortReal theR,
  57                            const Standard_ShortReal theG,
  58                            const Standard_ShortReal theB);
  59
  60   void EnablePolygonOffset() const;
  61   void DisablePolygonOffset() const;
  62
  63   Standard_Integer Width()  const { return myWidth; }
  64   Standard_Integer Height() const { return myHeight; }
  65   const TEL_COLOUR& BackgroundColor() const { return myBgColor; }
  66   Standard_Boolean Dither()     const { return myDither; }
  67   Standard_Boolean BackDither() const { return myBackDither; }
  68
  69   const Handle(OpenGl_Display)& GetDisplay() const { return myDisplay; }
  70
  71   const Handle(OpenGl_Context)& GetGlContext() const { return myGlContext; }
  72
  73   WINDOW    GetWindow()   const { return myWindow; }
  74   GLCONTEXT GetGContext() const { return myGContext; }
  75
  76 protected:
  77
  78   //! Activates GL context and setup viewport.
  79   void Init();
  80
  81   //! Makes GL context for this window active in current thread
  82   virtual Standard_Boolean Activate();
  83
  84   void EnableFeatures() const;
  85   void DisableFeatures() const;
  86
  87   //! Draw directly to the FRONT buffer. Can cause artifacts on the screen.
  88   void MakeFrontBufCurrent() const;
  89
  90   //! Draw to BACK buffer. Normal and default state.
  91   void MakeBackBufCurrent() const;
  92
  93   //! Draw simultaneously to BACK and FRONT buffers. Abnormal usage.
  94   void MakeFrontAndBackBufCurrent() const;
  95
  96 protected:
  97
  98   Handle(OpenGl_Display) myDisplay;
  99   WINDOW                 myWindow;      //!< native window handle, system-specific
 100   Handle(OpenGl_Context) myGlContext;
 101   GLCONTEXT              myGContext;    //!< native GL context bound to this window, system-specific
 102   Standard_Boolean       myOwnGContext; //!< set to TRUE if GL context was not created by this class
 103 #if (defined(_WIN32) || defined(__WIN32__))
 104   HDC                    myWindowDC;
 105   BOOL                   mySysPalInUse;
 106 #endif
 107
 108   Standard_Integer       myWidth;       // WSWidth
 109   Standard_Integer       myHeight;      // WSHeight
 110   TEL_COLOUR             myBgColor;     // WSBackground
 111   Standard_Boolean       myDither;
 112   Standard_Boolean       myBackDither;
 113
 114 public:
 115
 116   DEFINE_STANDARD_RTTI(OpenGl_Window) // Type definition
 117   DEFINE_STANDARD_ALLOC
 118
 119 };
 120
 121 #endif //_OpenGl_Window_Header