svn merge -r37793:37865 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / intern / ghost / intern / GHOST_WindowCocoa.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/intern/GHOST_WindowCocoa.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_WindowCocoa class.
32  */
33
34 #ifndef _GHOST_WINDOW_COCOA_H_
35 #define _GHOST_WINDOW_COCOA_H_
36
37 #ifndef __APPLE__
38 #error Apple OSX only!
39 #endif // __APPLE__
40
41 #include "GHOST_Window.h"
42 #include "STR_String.h"
43
44 @class CocoaWindow;
45 @class CocoaOpenGLView;
46
47 class GHOST_SystemCocoa;
48
49 /**
50  * Window on Mac OSX/Cocoa.
51  * Carbon windows have a size widget in the lower right corner of the window.
52  * To force it to be visible, the height of the client rectangle is reduced so
53  * that applications do not draw in that area. GHOST will manage that area
54  * which is called the gutter.
55  * When OpenGL contexts are active, GHOST will use AGL_BUFFER_RECT to prevent
56  * OpenGL drawing outside the reduced client rectangle.
57  * @author      Maarten Gribnau
58  * @date        May 23, 2001
59  */
60 class GHOST_WindowCocoa : public GHOST_Window {
61 public:
62         /**
63          * Constructor.
64          * Creates a new window and opens it.
65          * To check if the window was created properly, use the getValid() method.
66          * @param systemCocoa           The associated system class to forward events to
67          * @param title                         The text shown in the title bar of the window.
68          * @param left                          The coordinate of the left edge of the window.
69          * @param top                           The coordinate of the top edge of the window.
70          * @param width                         The width the window.
71          * @param height                        The height the window.
72          * @param state                         The state the window is initially opened with.
73          * @param type                          The type of drawing context installed in this window.
74          * @param stereoVisual          Stereo visual for quad buffered stereo.
75          * @param numOfAASamples        Number of samples used for AA (zero if no AA)
76          */
77         GHOST_WindowCocoa(
78                 GHOST_SystemCocoa *systemCocoa,
79                 const STR_String& title,
80                 GHOST_TInt32 left,
81                 GHOST_TInt32 bottom,
82                 GHOST_TUns32 width,
83                 GHOST_TUns32 height,
84                 GHOST_TWindowState state,
85                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
86                 const bool stereoVisual = false,
87                 const GHOST_TUns16 numOfAASamples = 0
88         );
89
90         /**
91          * Destructor.
92          * Closes the window and disposes resources allocated.
93          */
94         virtual ~GHOST_WindowCocoa();
95
96         /**
97          * Returns indication as to whether the window is valid.
98          * @return The validity of the window.
99          */
100         virtual bool getValid() const;
101         
102         /**
103          * Returns the associated NSWindow object
104          * @return The associated NSWindow object
105          */
106         virtual void* getOSWindow() const;
107
108         /**
109          * Sets the title displayed in the title bar.
110          * @param title The title to display in the title bar.
111          */
112         virtual void setTitle(const STR_String& title);
113
114         /**
115          * Returns the title displayed in the title bar.
116          * @param title The title displayed in the title bar.
117          */
118         virtual void getTitle(STR_String& title) const;
119
120         /**
121          * Returns the window rectangle dimensions.
122          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
123          * @param bounds The bounding rectangle of the window.
124          */
125         virtual void getWindowBounds(GHOST_Rect& bounds) const;
126         
127         /**
128          * Returns the client rectangle dimensions.
129          * The left and top members of the rectangle are always zero.
130          * @param bounds The bounding rectangle of the cleient area of the window.
131          */
132         virtual void getClientBounds(GHOST_Rect& bounds) const;
133
134         /**
135          * Resizes client rectangle width.
136          * @param width The new width of the client area of the window.
137          */
138         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
139
140         /**
141          * Resizes client rectangle height.
142          * @param height The new height of the client area of the window.
143          */
144         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
145
146         /**
147          * Resizes client rectangle.
148          * @param width         The new width of the client area of the window.
149          * @param height        The new height of the client area of the window.
150          */
151         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
152
153         /**
154          * Returns the state of the window (normal, minimized, maximized).
155          * @return The state of the window.
156          */
157         virtual GHOST_TWindowState getState() const;
158
159         /**
160          * Sets the window "modified" status, indicating unsaved changes
161          * @param isUnsavedChanges Unsaved changes or not
162          * @return Indication of success.
163          */
164         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
165         
166         /**
167          * Converts a point in screen coordinates to client rectangle coordinates
168          * @param inX   The x-coordinate on the screen.
169          * @param inY   The y-coordinate on the screen.
170          * @param outX  The x-coordinate in the client rectangle.
171          * @param outY  The y-coordinate in the client rectangle.
172          */
173         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
174
175         /**
176          * Converts a point in screen coordinates to client rectangle coordinates
177          * @param inX   The x-coordinate in the client rectangle.
178          * @param inY   The y-coordinate in the client rectangle.
179          * @param outX  The x-coordinate on the screen.
180          * @param outY  The y-coordinate on the screen.
181          */
182         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
183
184         /**
185          * Converts a point in screen coordinates to client rectangle coordinates
186          * but without the y coordinate conversion needed for ghost compatibility.
187          * @param inX   The x-coordinate in the client rectangle.
188          * @param inY   The y-coordinate in the client rectangle.
189          * @param outX  The x-coordinate on the screen.
190          * @param outY  The y-coordinate on the screen.
191          */
192         void clientToScreenIntern(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
193
194         /**
195          * Converts a point in screen coordinates to client rectangle coordinates,
196          * but without the y coordinate conversion needed for ghost compatibility.
197          * @param inX   The x-coordinate in the client rectangle.
198          * @param inY   The y-coordinate in the client rectangle.
199          * @param outX  The x-coordinate on the screen.
200          * @param outY  The y-coordinate on the screen.
201          */
202         void screenToClientIntern(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
203
204         /**
205          * Gets the screen the window is displayed in
206          * @return The NSScreen object
207          */
208         NSScreen* getScreen();
209         
210         /**
211          * Sets the state of the window (normal, minimized, maximized).
212          * @param state The state of the window.
213          * @return Indication of success.
214          */
215         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
216
217         /**
218          * Sets the order of the window (bottom, top).
219          * @param order The order of the window.
220          * @return Indication of success.
221          */
222         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
223
224         /**
225          * Swaps front and back buffers of a window.
226          * @return      A boolean success indicator.
227          */
228         virtual GHOST_TSuccess swapBuffers();
229
230         /**
231          * Updates the drawing context of this window. Needed
232          * whenever the window is changed.
233          * @return Indication of success.
234          */
235         GHOST_TSuccess updateDrawingContext();
236
237         /**
238          * Activates the drawing context of this window.
239          * @return      A boolean success indicator.
240          */
241         virtual GHOST_TSuccess activateDrawingContext();
242
243         virtual void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
244     
245
246         const GHOST_TabletData* GetTabletData()
247         { return &m_tablet; }
248
249         GHOST_TabletData& GetCocoaTabletData()
250         { return m_tablet; }
251         
252         /**
253          * Sets the progress bar value displayed in the window/application icon
254          * @param progress The progress % (0.0 to 1.0)
255          */
256         virtual GHOST_TSuccess setProgressBar(float progress);
257         
258         /**
259          * Hides the progress bar icon
260          */
261         virtual GHOST_TSuccess endProgressBar();
262 protected:
263         /**
264          * Tries to install a rendering context in this window.
265          * @param type  The type of rendering context installed.
266          * @return Indication as to whether installation has succeeded.
267          */
268         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
269
270         /**
271          * Removes the current drawing context.
272          * @return Indication as to whether removal has succeeded.
273          */
274         virtual GHOST_TSuccess removeDrawingContext();
275     
276         /**
277          * Invalidates the contents of this window.
278          * @return Indication of success.
279          */
280         virtual GHOST_TSuccess invalidate();
281
282         /**
283          * Sets the cursor visibility on the window using
284          * native window system calls.
285          */
286         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
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                 
294         /**
295          * Sets the cursor shape on the window using
296          * native window system calls.
297          */
298         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
299
300         /**
301          * Sets the cursor shape on the window using
302          * native window system calls.
303          */
304         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask,
305                                         int sizex, int sizey, int hotX, int hotY, int fg_color, int bg_color);
306                                         
307         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
308     
309         /** The window containing the OpenGL view */
310     CocoaWindow *m_window;
311         
312         /** The openGL view */
313         CocoaOpenGLView *m_openGLView; 
314     
315         /** The opgnGL drawing context */
316         NSOpenGLContext *m_openGLContext;
317         
318         /** The mother SystemCocoa class to send events */
319         GHOST_SystemCocoa *m_systemCocoa;
320                         
321         /** The first created OpenGL context (for sharing display lists) */
322         static NSOpenGLContext *s_firstOpenGLcontext;
323         
324         NSCursor*       m_customCursor;
325
326         GHOST_TabletData m_tablet;
327 };
328
329 #endif // _GHOST_WINDOW_COCOA_H_
330