Merged changes in the trunk up to revision 54110.
[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 numOfAASamples        Number of samples used for AA (zero if no AA)
84          */
85         GHOST_Window(
86             GHOST_TUns32 width,
87             GHOST_TUns32 height,
88             GHOST_TWindowState state,
89             GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
90             const bool stereoVisual = false,
91             const GHOST_TUns16 numOfAASamples = 0);
92
93         /**
94          * \section Interface inherited from GHOST_IWindow left for derived class
95          * implementation.
96          * virtual      bool getValid() const = 0;
97          * virtual void setTitle(const STR_String& title) = 0;
98          * virtual void getTitle(STR_String& title) const = 0;
99          * virtual      void getWindowBounds(GHOST_Rect& bounds) const = 0;
100          * virtual      void getClientBounds(GHOST_Rect& bounds) const = 0;
101          * virtual      GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
102          * virtual      GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
103          * virtual      GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
104          * virtual      void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
105          * virtual      void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
106          * virtual GHOST_TWindowState getState() const = 0;
107          * virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
108          * virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
109          * virtual GHOST_TSuccess swapBuffers() = 0;
110          * virtual GHOST_TSuccess activateDrawingContext() = 0;
111          * virtual GHOST_TSuccess invalidate() = 0;
112          */
113          
114         /**
115          * Destructor.
116          * Closes the window and disposes resources allocated.
117          */
118         virtual ~GHOST_Window();
119
120         /**
121          * Returns the associated OS object/handle
122          * \return The associated OS object/handle
123          */
124         virtual void *getOSWindow() const;
125         
126         /**
127          * Returns the current cursor shape.
128          * \return      The current cursor shape.
129          */
130         inline virtual GHOST_TStandardCursor getCursorShape() const;
131
132         /**
133          * Set the shape of the cursor.
134          * \param       cursor  The new cursor shape type id.
135          * \return      Indication of success.
136          */
137         virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
138
139         /**
140          * Set the shape of the cursor to a custom cursor.
141          * \param       bitmap  The bitmap data for the cursor.
142          * \param       mask    The mask data for the cursor.
143          * \param       hotX    The X coordinate of the cursor hotspot.
144          * \param       hotY    The Y coordinate of the cursor hotspot.
145          * \return      Indication of success.
146          */
147         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
148                                                     GHOST_TUns8 mask[16][2],
149                                                     int hotX,
150                                                     int hotY);
151                                                                                                 
152         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
153                                                     GHOST_TUns8 *mask,
154                                                     int sizex, int sizey,
155                                                     int hotX,  int hotY,
156                                                     int fg_color, int bg_color);
157         
158         /**
159          * Returns the visibility state of the cursor.
160          * \return      The visibility state of the cursor.
161          */
162         inline virtual bool getCursorVisibility() const;
163         inline virtual GHOST_TGrabCursorMode getCursorGrabMode() const;
164         inline virtual bool getCursorGrabModeIsWarp() const;
165         inline virtual void getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
166         inline virtual void getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
167         inline virtual void setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y);
168
169         /**
170          * Shows or hides the cursor.
171          * \param       visible The new visibility state of the cursor.
172          * \return      Indication of success.
173          */
174         virtual GHOST_TSuccess setCursorVisibility(bool visible);
175
176         /**
177          * Sets the cursor grab.
178          * \param       mode The new grab state of the cursor.
179          * \return      Indication of success.
180          */
181         virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds, GHOST_TInt32 mouse_ungrab_xy[2]);
182
183         /**
184          * Gets the cursor grab region, if unset the window is used.
185          * reset when grab is disabled.
186          */
187         virtual GHOST_TSuccess getCursorGrabBounds(GHOST_Rect& bounds);
188
189         /**
190          * Sets the progress bar value displayed in the window/application icon
191          * \param progress The progress % (0.0 to 1.0)
192          */
193         virtual GHOST_TSuccess setProgressBar(float progress) {
194                 return GHOST_kFailure;
195         }
196         
197         /**
198          * Hides the progress bar in the icon
199          */
200         virtual GHOST_TSuccess endProgressBar() {
201                 return GHOST_kFailure;
202         }
203         
204         /**
205          * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
206          */
207         virtual void setAcceptDragOperation(bool canAccept);
208         
209         /**
210          * Returns acceptance of the dropped object
211          * Usually called by the "object dropped" event handling function
212          */
213         virtual bool canAcceptDragOperation() const;
214         
215         /**
216          * Sets the window "modified" status, indicating unsaved changes
217          * \param isUnsavedChanges Unsaved changes or not
218          * \return Indication of success.
219          */
220         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
221         
222         /**
223          * Gets the window "modified" status, indicating unsaved changes
224          * \return True if there are unsaved changes
225          */
226         virtual bool getModifiedState();
227         
228         /**
229          * Returns the type of drawing context used in this window.
230          * \return The current type of drawing context.
231          */
232         inline virtual GHOST_TDrawingContextType getDrawingContextType();
233
234         /**
235          * Tries to install a rendering context in this window.
236          * Child classes do not need to overload this method.
237          * They should overload the installDrawingContext and removeDrawingContext instead.
238          * \param type  The type of rendering context installed.
239          * \return Indication as to whether installation has succeeded.
240          */
241         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
242
243         /**
244          * Returns the window user data.
245          * \return The window user data.
246          */
247         inline virtual GHOST_TUserDataPtr getUserData() const
248         {
249                 return m_userData;
250         }
251         
252         /**
253          * Changes the window user data.
254          * \param data The window user data.
255          */
256         virtual void setUserData(const GHOST_TUserDataPtr userData)
257         {
258                 m_userData = userData;
259         }
260         
261         virtual float getNativePixelSize(void)
262         {
263                 if (m_nativePixelSize > 0.0f)
264                         return m_nativePixelSize;
265                 return 1.0f;
266         }
267
268 protected:
269         /**
270          * Tries to install a rendering context in this window.
271          * \param type  The type of rendering context installed.
272          * \return Indication as to whether installation has succeeded.
273          */
274         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;
275
276         /**
277          * Removes the current drawing context.
278          * \return Indication as to whether removal has succeeded.
279          */
280         virtual GHOST_TSuccess removeDrawingContext() = 0;
281
282         /**
283          * Sets the cursor visibility on the window using
284          * native window system calls.
285          */
286         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible) = 0;
287
288         /**
289          * Sets the cursor grab on the window using
290          * native window system calls.
291          */
292         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) {
293                 return GHOST_kSuccess;
294         }
295         
296         /**
297          * Sets the cursor shape on the window using
298          * native window system calls.
299          */
300         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) = 0;
301
302         /**
303          * Sets the cursor shape on the window using
304          * native window system calls.
305          */
306         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2],
307                                                           GHOST_TUns8 mask[16][2],
308                                                           int hotX, int hotY) = 0;
309         
310         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, 
311                                                           int szx, int szy, int hotX, int hotY, int fg, int bg) = 0;
312         /** The the of drawing context installed in this window. */
313         GHOST_TDrawingContextType m_drawingContextType;
314         
315         /** The window user data */
316         GHOST_TUserDataPtr m_userData;
317
318         /** The current visibility of the cursor */
319         bool m_cursorVisible;
320
321         /** The current grabbed state of the cursor */
322         GHOST_TGrabCursorMode m_cursorGrab;
323
324         /** Initial grab location. */
325         GHOST_TInt32 m_cursorGrabInitPos[2];
326
327         /** Accumulated offset from m_cursorGrabInitPos. */
328         GHOST_TInt32 m_cursorGrabAccumPos[2];
329
330         /** Wrap the cursor within this region. */
331         GHOST_Rect m_cursorGrabBounds;
332
333         /** The current shape of the cursor */
334         GHOST_TStandardCursor m_cursorShape;
335     
336         /** The presence of progress indicator with the application icon */
337         bool m_progressBarVisible;
338         
339         /** The acceptance of the "drop candidate" of the current drag'n'drop operation */
340         bool m_canAcceptDragOperation;
341         
342         /** Modified state : are there unsaved changes */
343         bool m_isUnsavedChanges;
344         
345         /** Stores whether this is a full screen window. */
346         bool m_fullScreen;
347
348         /** Stereo visual created. Only necessary for 'real' stereo support,
349          *  ie quad buffered stereo. This is not always possible, depends on
350          *  the graphics h/w
351          */
352         bool m_stereoVisual;
353         
354         /** Number of samples used in anti-aliasing, set to 0 if no AA **/
355         GHOST_TUns16 m_numOfAASamples;
356
357         /** Full-screen width */
358         GHOST_TUns32 m_fullScreenWidth;
359         /** Full-screen height */
360         GHOST_TUns32 m_fullScreenHeight;
361         
362         /* OSX only, retina screens */
363         float m_nativePixelSize;
364 };
365
366
367 inline GHOST_TDrawingContextType GHOST_Window::getDrawingContextType()
368 {
369         return m_drawingContextType;
370 }
371
372 inline bool GHOST_Window::getCursorVisibility() const
373 {
374         return m_cursorVisible;
375 }
376
377 inline GHOST_TGrabCursorMode GHOST_Window::getCursorGrabMode() const
378 {
379         return m_cursorGrab;
380 }
381
382 inline bool GHOST_Window::getCursorGrabModeIsWarp() const
383 {
384         return (m_cursorGrab == GHOST_kGrabWrap) ||
385                (m_cursorGrab == GHOST_kGrabHide);
386 }
387
388 inline void GHOST_Window::getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const
389 {
390         x = m_cursorGrabInitPos[0];
391         y = m_cursorGrabInitPos[1];
392 }
393
394 inline void GHOST_Window::getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const
395 {
396         x = m_cursorGrabAccumPos[0];
397         y = m_cursorGrabAccumPos[1];
398 }
399
400 inline void GHOST_Window::setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y)
401 {
402         m_cursorGrabAccumPos[0] = x;
403         m_cursorGrabAccumPos[1] = y;
404 }
405
406 inline GHOST_TStandardCursor GHOST_Window::getCursorShape() const
407 {
408         return m_cursorShape;
409 }
410
411 #endif // _GHOST_WINDOW_H
412