0030507: Visualization - introduce AIS_ViewController
[occt.git] / src / Aspect / Aspect_Window.hxx
1 // Created by: NW,JPB,CAL
2 // Copyright (c) 1991-1999 Matra Datavision
3 // Copyright (c) 1999-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 _Aspect_Window_HeaderFile
17 #define _Aspect_Window_HeaderFile
18
19 #include <Aspect_Background.hxx>
20 #include <Aspect_GradientBackground.hxx>
21 #include <Aspect_FBConfig.hxx>
22 #include <Aspect_FillMethod.hxx>
23 #include <Quantity_Color.hxx>
24 #include <Aspect_GradientFillMethod.hxx>
25 #include <Aspect_TypeOfResize.hxx>
26 #include <Aspect_Drawable.hxx>
27 #include <Standard.hxx>
28 #include <Standard_Transient.hxx>
29 #include <Standard_Type.hxx>
30 #include <TCollection_AsciiString.hxx>
31
32 class Aspect_DisplayConnection;
33
34 DEFINE_STANDARD_HANDLE(Aspect_Window, Standard_Transient)
35
36 //! Defines a window.
37 class Aspect_Window : public Standard_Transient
38 {
39
40 public:
41
42   //! Modifies the window background.
43   Standard_EXPORT void SetBackground (const Aspect_Background& ABack);
44
45   //! Modifies the window background.
46   Standard_EXPORT void SetBackground (const Quantity_Color& color);
47
48   //! Modifies the window gradient background.
49   Standard_EXPORT void SetBackground (const Aspect_GradientBackground& ABackground);
50
51   //! Modifies the window gradient background.
52   Standard_EXPORT void SetBackground (const Quantity_Color& theFirstColor, const Quantity_Color& theSecondColor, const Aspect_GradientFillMethod theFillMethod);
53
54   //! Opens the window <me>.
55   Standard_EXPORT virtual void Map() const = 0;
56
57   //! Closes the window <me>.
58   Standard_EXPORT virtual void Unmap() const = 0;
59
60   //! Apply the resizing to the window <me>.
61   Standard_EXPORT virtual Aspect_TypeOfResize DoResize() const = 0;
62
63   //! Apply the mapping change to the window <me>.
64   //! and returns TRUE if the window is mapped at screen.
65   Standard_EXPORT virtual Standard_Boolean DoMapping() const = 0;
66
67   //! Returns the window background.
68   Standard_EXPORT Aspect_Background Background() const;
69
70   //! Returns the current image background fill mode.
71   Standard_EXPORT Aspect_FillMethod BackgroundFillMethod() const;
72
73   //! Returns the window gradient background.
74   Standard_EXPORT Aspect_GradientBackground GradientBackground() const;
75
76   //! Returns True if the window <me> is opened
77   //! and False if the window is closed.
78   Standard_EXPORT virtual Standard_Boolean IsMapped() const = 0;
79
80   //! Returns True if the window <me> is virtual
81   Standard_EXPORT Standard_Boolean IsVirtual() const;
82
83   //! Setup the virtual state
84   Standard_EXPORT void SetVirtual (const Standard_Boolean theVirtual);
85
86   //! Returns The Window RATIO equal to the physical
87   //! WIDTH/HEIGHT dimensions
88   Standard_EXPORT virtual Standard_Real Ratio() const = 0;
89
90   //! Returns The Window POSITION in PIXEL
91   Standard_EXPORT virtual void Position (Standard_Integer& X1, Standard_Integer& Y1, Standard_Integer& X2, Standard_Integer& Y2) const = 0;
92
93   //! Returns The Window SIZE in PIXEL
94   Standard_EXPORT virtual void Size (Standard_Integer& Width, Standard_Integer& Height) const = 0;
95
96   //! Returns native Window handle (HWND on Windows, Window with Xlib, and so on)
97   Standard_EXPORT virtual Aspect_Drawable NativeHandle() const = 0;
98
99   //! Returns parent of native Window handle (HWND on Windows, Window with Xlib, and so on)
100   Standard_EXPORT virtual Aspect_Drawable NativeParentHandle() const = 0;
101
102   //! Returns native Window FB config (GLXFBConfig on Xlib)
103   Standard_EXPORT virtual Aspect_FBConfig NativeFBConfig() const = 0;
104
105   //! Sets window title.
106   virtual void SetTitle (const TCollection_AsciiString& theTitle) { (void )theTitle; }
107
108   //! Invalidate entire window content.
109   //!
110   //! Implementation is expected to allow calling this method from non-GUI thread,
111   //! e.g. by queuing exposure event into window message queue or in other thread-safe manner.
112   //!
113   //! Optional display argument should be passed when called from non-GUI thread
114   //! on platforms implementing thread-unsafe connections to display.
115   //! NULL can be passed instead otherwise.
116   virtual void InvalidateContent (const Handle(Aspect_DisplayConnection)& theDisp) { (void )theDisp; }
117
118   DEFINE_STANDARD_RTTIEXT(Aspect_Window,Standard_Transient)
119
120 protected:
121
122   //! Initializes the datas of a Window.
123   Standard_EXPORT Aspect_Window();
124
125 protected:
126
127   Aspect_Background MyBackground;
128   Aspect_GradientBackground MyGradientBackground;
129   Aspect_FillMethod MyBackgroundFillMethod;
130   Standard_Boolean MyIsVirtual;
131
132 };
133
134 #endif // _Aspect_Window_HeaderFile