fix for fullscreen on X11 (used by the BGE, not blender application),
[blender.git] / intern / ghost / intern / GHOST_Window.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_Window.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_Window class.
31  */
32
33 #ifndef __GHOST_WINDOW_H__
34 #define __GHOST_WINDOW_H__
35
36 #include "GHOST_IWindow.h"
37
38 class STR_String;
39
40 /**
41  * Platform independent implementation of GHOST_IWindow.
42  * Dimensions are given in screen coordinates that are relative to the 
43  * upper-left corner of the screen.
44  * Implements part of the GHOST_IWindow interface and adds some methods to
45  * be implemented by childs of this class.
46  * \author      Maarten Gribnau
47  * \date        May 7, 2001
48  */
49 class GHOST_Window : public GHOST_IWindow
50 {
51 public:
52         /**
53          * \section Interface inherited from GHOST_IWindow left for derived class
54          * implementation.
55          * virtual      bool getValid() const = 0;
56          * virtual void setTitle(const STR_String& title) = 0;
57          * virtual void getTitle(STR_String& title) const = 0;
58          * virtual      void getWindowBounds(GHOST_Rect& bounds) const = 0;
59          * virtual      void getClientBounds(GHOST_Rect& bounds) const = 0;
60          * virtual      GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
61          * virtual      GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
62          * virtual      GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
63          * virtual      void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
64          * virtual      void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
65          * virtual GHOST_TWindowState getState() const = 0;
66          * virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
67          * virtual GHOST_TWindowOrder getOrder(void) = 0;
68          * virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
69          * virtual GHOST_TSuccess swapBuffers() = 0;
70          * virtual GHOST_TSuccess activateDrawingContext() = 0;
71          * virtual GHOST_TSuccess invalidate() = 0;
72          */
73
74         /**
75          * Constructor.
76          * Creates a new window and opens it.
77          * To check if the window was created properly, use the getValid() method.
78          * \param width                         The width the window.
79          * \param heigh                         The height the window.
80          * \param state                         The state the window is initially opened with.
81          * \param type                          The type of drawing context installed in this window.
82          * \param stereoVisual          Stereo visual for quad buffered stereo.
83          * \param exclusive                     Use to show the window ontop and ignore others
84          *                                                      (used fullscreen).
85          * \param numOfAASamples        Number of samples used for AA (zero if no AA)
86          */
87         GHOST_Window(
88             GHOST_TUns32 width,
89             GHOST_TUns32 height,
90             GHOST_TWindowState state,
91             GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
92             const bool stereoVisual = false,
93             const bool exclusive = false,
94             const GHOST_TUns16 numOfAASamples = 0);
95
96         /**
97          * \section Interface inherited from GHOST_IWindow left for derived class
98          * implementation.
99          * virtual      bool getValid() const = 0;
100          * virtual void setTitle(const STR_String& title) = 0;
101          * virtual void getTitle(STR_String& title) const = 0;
102          * virtual      void getWindowBounds(GHOST_Rect& bounds) const = 0;
103          * virtual      void getClientBounds(GHOST_Rect& bounds) const = 0;
104          * virtual      GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
105          * virtual      GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
106          * virtual      GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
107          * virtual      void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
108          * virtual      void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
109          * virtual GHOST_TWindowState getState() const = 0;
110          * virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
111          * virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
112          * virtual GHOST_TSuccess swapBuffers() = 0;
113          * virtual GHOST_TSuccess activateDrawingContext() = 0;
114          * virtual GHOST_TSuccess invalidate() = 0;
115          */
116          
117         /**
118          * Destructor.
119          * Closes the window and disposes resources allocated.
120          */
121         virtual ~GHOST_Window();
122
123         /**
124          * Returns the associated OS object/handle
125          * \return The associated OS object/handle
126          */
127         virtual void *getOSWindow() const;
128         
129         /**
130          * Returns the current cursor shape.
131          * \return      The current cursor shape.
132          */
133         inline virtual GHOST_TStandardCursor getCursorShape() const;
134
135         /**
136          * Set the shape of the cursor.
137          * \param       cursor  The new cursor shape type id.
138          * \return      Indication of success.
139          */
140         virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
141
142         /**
143          * Set the shape of the cursor to a custom cursor.
144          * \param       bitmap  The bitmap data for the cursor.
145          * \param       mask    The mask data for the cursor.
146          * \param       hotX    The X coordinate of the cursor hotspot.
147          * \param       hotY    The Y coordinate of the cursor hotspot.
148          * \return      Indication of success.
149          */
150         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
151                                                     GHOST_TUns8 mask[16][2],
152                                                     int hotX,
153                                                     int hotY);
154                                                                                                 
155         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
156                                                     GHOST_TUns8 *mask,
157                                                     int sizex, int sizey,
158                                                     int hotX,  int hotY,
159                                                     int fg_color, int bg_color);
160         
161         /**
162          * Returns the visibility state of the cursor.
163          * \return      The visibility state of the cursor.
164          */
165         inline virtual bool getCursorVisibility() const;
166         inline virtual GHOST_TGrabCursorMode getCursorGrabMode() const;
167         inline virtual bool getCursorGrabModeIsWarp() const;
168         inline virtual void getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
169         inline virtual void getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
170         inline virtual void setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y);
171
172         /**
173          * Shows or hides the cursor.
174          * \param       visible The new visibility state of the cursor.
175          * \return      Indication of success.
176          */
177         virtual GHOST_TSuccess setCursorVisibility(bool visible);
178
179         /**
180          * Sets the cursor grab.
181          * \param       mode The new grab state of the cursor.
182          * \return      Indication of success.
183          */
184         virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds, GHOST_TInt32 mouse_ungrab_xy[2]);
185
186         /**
187          * Gets the cursor grab region, if unset the window is used.
188          * reset when grab is disabled.
189          */
190         virtual GHOST_TSuccess getCursorGrabBounds(GHOST_Rect& bounds);
191
192         /**
193          * Sets the progress bar value displayed in the window/application icon
194          * \param progress The progress % (0.0 to 1.0)
195          */
196         virtual GHOST_TSuccess setProgressBar(float progress) {
197                 return GHOST_kFailure;
198         }
199         
200         /**
201          * Hides the progress bar in the icon
202          */
203         virtual GHOST_TSuccess endProgressBar() {
204                 return GHOST_kFailure;
205         }
206         
207         /**
208          * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
209          */
210         virtual void setAcceptDragOperation(bool canAccept);
211         
212         /**
213          * Returns acceptance of the dropped object
214          * Usually called by the "object dropped" event handling function
215          */
216         virtual bool canAcceptDragOperation() const;
217         
218         /**
219          * Sets the window "modified" status, indicating unsaved changes
220          * \param isUnsavedChanges Unsaved changes or not
221          * \return Indication of success.
222          */
223         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
224         
225         /**
226          * Gets the window "modified" status, indicating unsaved changes
227          * \return True if there are unsaved changes
228          */
229         virtual bool getModifiedState();
230         
231         /**
232          * Returns the type of drawing context used in this window.
233          * \return The current type of drawing context.
234          */
235         inline virtual GHOST_TDrawingContextType getDrawingContextType();
236
237         /**
238          * Tries to install a rendering context in this window.
239          * Child classes do not need to overload this method.
240          * They should overload the installDrawingContext and removeDrawingContext instead.
241          * \param type  The type of rendering context installed.
242          * \return Indication as to whether installation has succeeded.
243          */
244         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
245
246         /**
247          * Returns the window user data.
248          * \return The window user data.
249          */
250         inline virtual GHOST_TUserDataPtr getUserData() const
251         {
252                 return m_userData;
253         }
254         
255         /**
256          * Changes the window user data.
257          * \param data The window user data.
258          */
259         virtual void setUserData(const GHOST_TUserDataPtr userData)
260         {
261                 m_userData = userData;
262         }
263         
264         virtual float getNativePixelSize(void)
265         {
266                 if (m_nativePixelSize > 0.0f)
267                         return m_nativePixelSize;
268                 return 1.0f;
269         }
270
271 protected:
272         /**
273          * Tries to install a rendering context in this window.
274          * \param type  The type of rendering context installed.
275          * \return Indication as to whether installation has succeeded.
276          */
277         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;
278
279         /**
280          * Removes the current drawing context.
281          * \return Indication as to whether removal has succeeded.
282          */
283         virtual GHOST_TSuccess removeDrawingContext() = 0;
284
285         /**
286          * Sets the cursor visibility on the window using
287          * native window system calls.
288          */
289         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible) = 0;
290
291         /**
292          * Sets the cursor grab on the window using
293          * native window system calls.
294          */
295         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) {
296                 return GHOST_kSuccess;
297         }
298         
299         /**
300          * Sets the cursor shape on the window using
301          * native window system calls.
302          */
303         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) = 0;
304
305         /**
306          * Sets the cursor shape on the window using
307          * native window system calls.
308          */
309         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2],
310                                                           GHOST_TUns8 mask[16][2],
311                                                           int hotX, int hotY) = 0;
312         
313         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, 
314                                                           int szx, int szy, int hotX, int hotY, int fg, int bg) = 0;
315         /** The the of drawing context installed in this window. */
316         GHOST_TDrawingContextType m_drawingContextType;
317         
318         /** The window user data */
319         GHOST_TUserDataPtr m_userData;
320
321         /** The current visibility of the cursor */
322         bool m_cursorVisible;
323
324         /** The current grabbed state of the cursor */
325         GHOST_TGrabCursorMode m_cursorGrab;
326
327         /** Initial grab location. */
328         GHOST_TInt32 m_cursorGrabInitPos[2];
329
330         /** Accumulated offset from m_cursorGrabInitPos. */
331         GHOST_TInt32 m_cursorGrabAccumPos[2];
332
333         /** Wrap the cursor within this region. */
334         GHOST_Rect m_cursorGrabBounds;
335
336         /** The current shape of the cursor */
337         GHOST_TStandardCursor m_cursorShape;
338     
339         /** The presence of progress indicator with the application icon */
340         bool m_progressBarVisible;
341         
342         /** The acceptance of the "drop candidate" of the current drag'n'drop operation */
343         bool m_canAcceptDragOperation;
344         
345         /** Modified state : are there unsaved changes */
346         bool m_isUnsavedChanges;
347         
348         /** Stores whether this is a full screen window. */
349         bool m_fullScreen;
350
351         /** Stereo visual created. Only necessary for 'real' stereo support,
352          *  ie quad buffered stereo. This is not always possible, depends on
353          *  the graphics h/w
354          */
355         bool m_stereoVisual;
356         
357         /** Number of samples used in anti-aliasing, set to 0 if no AA **/
358         GHOST_TUns16 m_numOfAASamples;
359
360         /** Full-screen width */
361         GHOST_TUns32 m_fullScreenWidth;
362         /** Full-screen height */
363         GHOST_TUns32 m_fullScreenHeight;
364         
365         /* OSX only, retina screens */
366         float m_nativePixelSize;
367 };
368
369
370 inline GHOST_TDrawingContextType GHOST_Window::getDrawingContextType()
371 {
372         return m_drawingContextType;
373 }
374
375 inline bool GHOST_Window::getCursorVisibility() const
376 {
377         return m_cursorVisible;
378 }
379
380 inline GHOST_TGrabCursorMode GHOST_Window::getCursorGrabMode() const
381 {
382         return m_cursorGrab;
383 }
384
385 inline bool GHOST_Window::getCursorGrabModeIsWarp() const
386 {
387         return (m_cursorGrab == GHOST_kGrabWrap) ||
388                (m_cursorGrab == GHOST_kGrabHide);
389 }
390
391 inline void GHOST_Window::getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const
392 {
393         x = m_cursorGrabInitPos[0];
394         y = m_cursorGrabInitPos[1];
395 }
396
397 inline void GHOST_Window::getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const
398 {
399         x = m_cursorGrabAccumPos[0];
400         y = m_cursorGrabAccumPos[1];
401 }
402
403 inline void GHOST_Window::setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y)
404 {
405         m_cursorGrabAccumPos[0] = x;
406         m_cursorGrabAccumPos[1] = y;
407 }
408
409 inline GHOST_TStandardCursor GHOST_Window::getCursorShape() const
410 {
411         return m_cursorShape;
412 }
413
414 #endif // _GHOST_WINDOW_H
415