5ff205d964fe95b52ee6f49b1883bf75eb9a7f14
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_WindowCocoa.h
30  * Declaration of GHOST_WindowCocoa class.
31  */
32
33 #ifndef _GHOST_WINDOW_COCOA_H_
34 #define _GHOST_WINDOW_COCOA_H_
35
36 #ifndef __APPLE__
37 #error Apple OSX only!
38 #endif // __APPLE__
39
40 #include "GHOST_Window.h"
41 #include "STR_String.h"
42
43 class GHOST_SystemCocoa;
44
45 /**
46  * Window on Mac OSX/Cocoa.
47  * Carbon windows have a size widget in the lower right corner of the window.
48  * To force it to be visible, the height of the client rectangle is reduced so
49  * that applications do not draw in that area. GHOST will manage that area
50  * which is called the gutter.
51  * When OpenGL contexts are active, GHOST will use AGL_BUFFER_RECT to prevent
52  * OpenGL drawing outside the reduced client rectangle.
53  * @author      Maarten Gribnau
54  * @date        May 23, 2001
55  */
56 class GHOST_WindowCocoa : public GHOST_Window {
57 public:
58         /**
59          * Constructor.
60          * Creates a new window and opens it.
61          * To check if the window was created properly, use the getValid() method.
62          * @param systemCocoa The associated system class to forward events to
63          * @param title         The text shown in the title bar of the window.
64          * @param left          The coordinate of the left edge of the window.
65          * @param top           The coordinate of the top edge of the window.
66          * @param width         The width the window.
67          * @param height        The height the window.
68          * @param state         The state the window is initially opened with.
69          * @param type          The type of drawing context installed in this window.
70          * @param stereoVisual  Stereo visual for quad buffered stereo.
71          */
72         GHOST_WindowCocoa(
73                 const GHOST_SystemCocoa *systemCocoa,
74                 const STR_String& title,
75                 GHOST_TInt32 left,
76                 GHOST_TInt32 top,
77                 GHOST_TUns32 width,
78                 GHOST_TUns32 height,
79                 GHOST_TWindowState state,
80                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
81                 const bool stereoVisual = false
82         );
83
84         /**
85          * Destructor.
86          * Closes the window and disposes resources allocated.
87          */
88         virtual ~GHOST_WindowCocoa();
89
90         /**
91          * Returns indication as to whether the window is valid.
92          * @return The validity of the window.
93          */
94         virtual bool getValid() const;
95
96         /**
97          * Sets the title displayed in the title bar.
98          * @param title The title to display in the title bar.
99          */
100         virtual void setTitle(const STR_String& title);
101
102         /**
103          * Returns the title displayed in the title bar.
104          * @param title The title displayed in the title bar.
105          */
106         virtual void getTitle(STR_String& title) const;
107
108         /**
109          * Returns the window rectangle dimensions.
110          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
111          * @param bounds The bounding rectangle of the window.
112          */
113         virtual void getWindowBounds(GHOST_Rect& bounds) const;
114         
115         /**
116          * Returns the client rectangle dimensions.
117          * The left and top members of the rectangle are always zero.
118          * @param bounds The bounding rectangle of the cleient area of the window.
119          */
120         virtual void getClientBounds(GHOST_Rect& bounds) const;
121
122         /**
123          * Resizes client rectangle width.
124          * @param width The new width of the client area of the window.
125          */
126         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
127
128         /**
129          * Resizes client rectangle height.
130          * @param height The new height of the client area of the window.
131          */
132         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
133
134         /**
135          * Resizes client rectangle.
136          * @param width         The new width of the client area of the window.
137          * @param height        The new height of the client area of the window.
138          */
139         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
140
141         /**
142          * Returns the state of the window (normal, minimized, maximized).
143          * @return The state of the window.
144          */
145         virtual GHOST_TWindowState getState() const;
146
147         /**
148          * Sets the window "modified" status, indicating unsaved changes
149          * @param isUnsavedChanges Unsaved changes or not
150          * @return Indication of success.
151          */
152         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
153         
154         /**
155          * Converts a point in screen coordinates to client rectangle coordinates
156          * @param inX   The x-coordinate on the screen.
157          * @param inY   The y-coordinate on the screen.
158          * @param outX  The x-coordinate in the client rectangle.
159          * @param outY  The y-coordinate in the client rectangle.
160          */
161         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
162
163         /**
164          * Converts a point in screen coordinates to client rectangle coordinates
165          * @param inX   The x-coordinate in the client rectangle.
166          * @param inY   The y-coordinate in the client rectangle.
167          * @param outX  The x-coordinate on the screen.
168          * @param outY  The y-coordinate on the screen.
169          */
170         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
171
172         /**
173          * Sets the state of the window (normal, minimized, maximized).
174          * @param state The state of the window.
175          * @return Indication of success.
176          */
177         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
178
179         /**
180          * Sets the order of the window (bottom, top).
181          * @param order The order of the window.
182          * @return Indication of success.
183          */
184         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
185
186         /**
187          * Swaps front and back buffers of a window.
188          * @return      A boolean success indicator.
189          */
190         virtual GHOST_TSuccess swapBuffers();
191
192         /**
193          * Updates the drawing context of this window. Needed
194          * whenever the window is changed.
195          * @return Indication of success.
196          */
197         GHOST_TSuccess updateDrawingContext();
198
199         /**
200          * Activates the drawing context of this window.
201          * @return      A boolean success indicator.
202          */
203         virtual GHOST_TSuccess activateDrawingContext();
204
205         virtual void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
206     
207     /**
208      * Returns the dirty state of the window when in full-screen mode.
209      * @return Whether it is dirty.
210      */
211     virtual bool getFullScreenDirty();
212
213                 /* accessor for fullscreen window */
214         /*virtual void setMac_windowState(short value);
215         virtual short getMac_windowState();*/
216
217
218         const GHOST_TabletData* GetTabletData()
219         { return &m_tablet; }
220
221         GHOST_TabletData& GetCocoaTabletData()
222         { return m_tablet; }
223 protected:
224         /**
225          * Tries to install a rendering context in this window.
226          * @param type  The type of rendering context installed.
227          * @return Indication as to whether installation has succeeded.
228          */
229         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
230
231         /**
232          * Removes the current drawing context.
233          * @return Indication as to whether removal has succeeded.
234          */
235         virtual GHOST_TSuccess removeDrawingContext();
236     
237         /**
238          * Invalidates the contents of this window.
239          * @return Indication of success.
240          */
241         virtual GHOST_TSuccess invalidate();
242
243         /**
244          * Sets the cursor visibility on the window using
245          * native window system calls.
246          */
247         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
248         
249         /**
250          * Sets the cursor shape on the window using
251          * native window system calls.
252          */
253         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
254
255         /**
256          * Sets the cursor shape on the window using
257          * native window system calls.
258          */
259         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask,
260                                         int sizex, int sizey, int hotX, int hotY, int fg_color, int bg_color);
261                                         
262         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
263     
264         /** The window containing the OpenGL view */
265     NSWindow *m_window;
266         
267         /** The openGL view */
268         NSOpenGLView *m_openGLView; 
269     
270         /** The opgnGL drawing context */
271         NSOpenGLContext *m_openGLContext;
272         
273         //CGrafPtr m_grafPtr;
274     //AGLContext m_aglCtx;
275
276         /** The first created OpenGL context (for sharing display lists) */
277         //static AGLContext s_firstaglCtx;
278                 
279         NSCursor*       m_customCursor;
280
281         GHOST_TabletData m_tablet;
282     
283     /** When running in full-screen this tells whether to refresh the window. */
284     bool m_fullScreenDirty;
285                          
286     /**
287      * The width/height of the size rectangle in the lower right corner of a 
288      * Mac/Carbon window. This is also the height of the gutter area.
289      */
290 #ifdef GHOST_DRAW_CARBON_GUTTER
291     static const GHOST_TInt32 s_sizeRectSize;
292 #endif // GHOST_DRAW_CARBON_GUTTER
293 };
294
295 #endif // _GHOST_WINDOW_COCOA_H_
296