src/Xw/Xw_Window.hxx

   1 // Created on: 2013-04-06
   2 // Created by: Kirill Gavrilov
   3 // Copyright (c) 2013-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 _Xw_Window_H__
  17 #define _Xw_Window_H__
  18
  19 #if !defined(_WIN32) && (!defined(__APPLE__) || defined(MACOSX_USE_GLX)) && !defined(__ANDROID__) && !defined(__QNX__)
  20
  21 #include <Aspect_Window.hxx>
  22
  23 #include <Aspect_DisplayConnection.hxx>
  24 #include <Aspect_FillMethod.hxx>
  25 #include <Aspect_GradientFillMethod.hxx>
  26 #include <Aspect_Handle.hxx>
  27 #include <Aspect_TypeOfResize.hxx>
  28 #include <Standard.hxx>
  29 #include <Standard_Type.hxx>
  30 #include <Quantity_NameOfColor.hxx>
  31
  32 class Aspect_WindowDefinitionError;
  33 class Aspect_WindowError;
  34 class Aspect_Background;
  35 class Quantity_Color;
  36 class Aspect_GradientBackground;
  37
  38 //! This class defines XLib window intended for creation of OpenGL context.
  39 class Xw_Window : public Aspect_Window
  40 {
  41
  42 public:
  43
  44   //! Creates a XLib window defined by his position and size in pixels.
  45   //! Throws exception if window can not be created or Display do not support GLX extension.
  46   Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
  47                              const Standard_CString theTitle,
  48                              const Standard_Integer thePxLeft,
  49                              const Standard_Integer thePxTop,
  50                              const Standard_Integer thePxWidth,
  51                              const Standard_Integer thePxHeight,
  52                              const Aspect_FBConfig  theFBConfig = NULL);
  53
  54   //! Creates a wrapper over existing Window handle
  55   Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
  56                              const Window theXWin,
  57                              const Aspect_FBConfig theFBConfig = NULL);
  58
  59   //! Destroys the Window and all resourses attached to it
  60   Standard_EXPORT ~Xw_Window();
  61
  62   //! Opens the window <me>
  63   Standard_EXPORT virtual void Map() const Standard_OVERRIDE;
  64
  65   //! Closes the window <me>
  66   Standard_EXPORT virtual void Unmap() const Standard_OVERRIDE;
  67
  68   //! Applies the resizing to the window <me>
  69   Standard_EXPORT virtual Aspect_TypeOfResize DoResize() const Standard_OVERRIDE;
  70
  71   //! Apply the mapping change to the window <me>
  72   Standard_EXPORT virtual Standard_Boolean DoMapping() const Standard_OVERRIDE;
  73
  74   //! Returns True if the window <me> is opened
  75   Standard_EXPORT virtual Standard_Boolean IsMapped() const Standard_OVERRIDE;
  76
  77   //! Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions
  78   Standard_EXPORT virtual Standard_Real Ratio() const Standard_OVERRIDE;
  79
  80   //! Returns The Window POSITION in PIXEL
  81   Standard_EXPORT virtual void Position (Standard_Integer& X1,
  82                                          Standard_Integer& Y1,
  83                                          Standard_Integer& X2,
  84                                          Standard_Integer& Y2) const Standard_OVERRIDE;
  85
  86   //! Returns The Window SIZE in PIXEL
  87   Standard_EXPORT virtual void Size (Standard_Integer& theWidth,
  88                                      Standard_Integer& theHeight) const Standard_OVERRIDE;
  89
  90   //! @return native Window handle
  91   Standard_EXPORT Window XWindow() const;
  92
  93   //! @return connection to X Display
  94   Standard_EXPORT const Handle(Aspect_DisplayConnection)& DisplayConnection() const;
  95
  96   //! @return native Window handle
  97   virtual Aspect_Drawable NativeHandle() const Standard_OVERRIDE
  98   {
  99     return (Aspect_Drawable )XWindow();
 100   }
 101
 102   //! @return parent of native Window handle
 103   virtual Aspect_Drawable NativeParentHandle() const Standard_OVERRIDE
 104   {
 105     return 0;
 106   }
 107
 108   //! @return native Window FB config (GLXFBConfig on Xlib)
 109   virtual Aspect_FBConfig NativeFBConfig() const Standard_OVERRIDE
 110   {
 111     return myFBConfig;
 112   }
 113
 114   //! Invalidate entire window content through generation of Expose event.
 115   //! This method does not aggregate multiple calls into single event - dedicated event will be sent on each call.
 116   //! When NULL display connection is specified, the connection specified on window creation will be used.
 117   //! Sending exposure messages from non-window thread would require dedicated display connection opened specifically
 118   //! for this working thread to avoid race conditions, since Xlib display connection is not thread-safe by default.
 119   Standard_EXPORT virtual void InvalidateContent (const Handle(Aspect_DisplayConnection)& theDisp) Standard_OVERRIDE;
 120
 121 protected:
 122
 123   Handle(Aspect_DisplayConnection) myDisplay; //!< X Display connection
 124   Window           myXWindow;  //!< XLib window handle
 125   Aspect_FBConfig  myFBConfig; //!< GLXFBConfig
 126   Standard_Integer myXLeft;    //!< left   position in pixels
 127   Standard_Integer myYTop;     //!< top    position in pixels
 128   Standard_Integer myXRight;   //!< right  position in pixels
 129   Standard_Integer myYBottom;  //!< bottom position in pixels
 130   Standard_Boolean myIsOwnWin; //!< flag to indicate own window handle (to be deallocated on destruction)
 131
 132 public:
 133
 134   DEFINE_STANDARD_RTTIEXT(Xw_Window,Aspect_Window)
 135
 136 };
 137
 138 DEFINE_STANDARD_HANDLE(Xw_Window, Aspect_Window)
 139
 140 #endif //  Win32 or Mac OS X
 141 #endif // _Xw_Window_H__