8b461802fa45c27a97e56f1dc99ab10b81117027
[blender.git] / intern / ghost / intern / GHOST_WindowWin32.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_WindowWin32.h
30  * Declaration of GHOST_WindowWin32 class.
31  */
32
33 #ifndef _GHOST_WINDOW_WIN32_H_
34 #define _GHOST_WINDOW_WIN32_H_
35
36 #ifndef WIN32
37 #error WIN32 only!
38 #endif // WIN32
39
40 #include "GHOST_Window.h"
41
42 #include <windows.h>
43
44
45 #include <wintab.h>
46 #define PACKETDATA      (PK_BUTTONS | PK_NORMAL_PRESSURE | PK_ORIENTATION | PK_CURSOR)
47 #define PACKETMODE      PK_BUTTONS
48 #include <pktdef.h>
49
50 // typedefs for WinTab functions to allow dynamic loading
51 typedef UINT (API * GHOST_WIN32_WTInfo) ( UINT, UINT, LPVOID );
52 typedef HCTX (API * GHOST_WIN32_WTOpen) (HWND, LPLOGCONTEXTA, BOOL);
53 typedef BOOL (API * GHOST_WIN32_WTClose) (HCTX);
54 typedef BOOL (API * GHOST_WIN32_WTPacket) (HCTX, UINT, LPVOID);
55
56 /**
57  * GHOST window on M$ Windows OSs.
58  * @author      Maarten Gribnau
59  * @date        May 10, 2001
60  */
61 class GHOST_WindowWin32 : public GHOST_Window {
62 public:
63         /**
64          * Constructor.
65          * Creates a new window and opens it.
66          * To check if the window was created properly, use the getValid() method.
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          */
76         GHOST_WindowWin32(
77                 const STR_String& title,
78                 GHOST_TInt32 left,
79                 GHOST_TInt32 top,
80                 GHOST_TUns32 width,
81                 GHOST_TUns32 height,
82                 GHOST_TWindowState state,
83                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
84                 const bool stereoVisual = false
85         );
86
87         /**
88          * Destructor.
89          * Closes the window and disposes resources allocated.
90          */
91         virtual ~GHOST_WindowWin32();
92
93         /**
94          * Returns indication as to whether the window is valid.
95          * @return The validity of the window.
96          */
97         virtual bool getValid() const;
98
99         /**
100          * Sets the title displayed in the title bar.
101          * @param title The title to display in the title bar.
102          */
103         virtual void setTitle(const STR_String& title);
104
105         /**
106          * Returns the title displayed in the title bar.
107          * @param title The title displayed in the title bar.
108          */
109         virtual void getTitle(STR_String& title) const;
110
111         /**
112          * Returns the window rectangle dimensions.
113          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
114          * @param bounds The bounding rectangle of the window.
115          */
116         virtual void getWindowBounds(GHOST_Rect& bounds) const;
117         
118         /**
119          * Returns the client rectangle dimensions.
120          * The left and top members of the rectangle are always zero.
121          * @param bounds The bounding rectangle of the cleient area of the window.
122          */
123         virtual void getClientBounds(GHOST_Rect& bounds) const;
124
125         /**
126          * Resizes client rectangle width.
127          * @param width The new width of the client area of the window.
128          */
129         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
130
131         /**
132          * Resizes client rectangle height.
133          * @param height The new height of the client area of the window.
134          */
135         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
136
137         /**
138          * Resizes client rectangle.
139          * @param width         The new width of the client area of the window.
140          * @param height        The new height of the client area of the window.
141          */
142         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
143
144         /**
145          * Returns the state of the window (normal, minimized, maximized).
146          * @return The state of the window.
147          */
148         virtual GHOST_TWindowState getState() const;
149
150         /**
151          * Converts a point in screen coordinates to client rectangle coordinates
152          * @param inX   The x-coordinate on the screen.
153          * @param inY   The y-coordinate on the screen.
154          * @param outX  The x-coordinate in the client rectangle.
155          * @param outY  The y-coordinate in the client rectangle.
156          */
157         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
158
159         /**
160          * Converts a point in screen coordinates to client rectangle coordinates
161          * @param inX   The x-coordinate in the client rectangle.
162          * @param inY   The y-coordinate in the client rectangle.
163          * @param outX  The x-coordinate on the screen.
164          * @param outY  The y-coordinate on the screen.
165          */
166         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
167
168         /**
169          * Sets the state of the window (normal, minimized, maximized).
170          * @param state The state of the window.
171          * @return Indication of success.
172          */
173         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
174
175         /**
176          * Sets the order of the window (bottom, top).
177          * @param order The order of the window.
178          * @return Indication of success.
179          */
180         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
181
182         /**
183          * Swaps front and back buffers of a window.
184          * @return Indication of success.
185          */
186         virtual GHOST_TSuccess swapBuffers();
187
188         /**
189          * Activates the drawing context of this window.
190          * @return Indication of success.
191          */
192         virtual GHOST_TSuccess activateDrawingContext();
193
194         /**
195          * Invalidates the contents of this window.
196          */
197         virtual GHOST_TSuccess invalidate();
198
199         /**
200          * Returns the name of the window class.
201          * @return The name of the window class.
202          */
203         static LPCSTR getWindowClassName() { return s_windowClassName; }
204
205         /**
206          * Register a mouse click event (should be called 
207          * for any real button press, controls mouse
208          * capturing).
209          *
210          * @param press True the event was a button press.
211          */
212         void registerMouseClickEvent(bool press);
213
214         /**
215          * Inform the window that it has lost mouse capture,
216          * called in response to native window system messages.
217          */
218         void lostMouseCapture();
219
220         /**
221          * Loads the windows equivalent of a standard GHOST cursor.
222          * @param visible               Flag for cursor visibility.
223          * @param cursorShape   The cursor shape.
224          */
225         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
226
227         const GHOST_TabletData* GetTabletData()
228         { return m_tabletData; }
229
230         void processWin32TabletInitEvent();
231         void processWin32TabletEvent(WPARAM wParam, LPARAM lParam);
232
233 protected:
234         /**
235          * Tries to install a rendering context in this window.
236          * @param type  The type of rendering context installed.
237          * @return Indication of success.
238          */
239         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
240
241         /**
242          * Removes the current drawing context.
243          * @return Indication of success.
244          */
245         virtual GHOST_TSuccess removeDrawingContext();
246
247         /**
248          * Sets the cursor visibility on the window using
249          * native window system calls.
250          */
251         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
252         
253         /**
254          * Sets the cursor shape on the window using
255          * native window system calls.
256          */
257         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
258
259         /**
260          * Sets the cursor shape on the window using
261          * native window system calls.
262          */
263         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
264
265         virtual GHOST_TSuccess setWindowCustomCursorShape(
266                 GHOST_TUns8 *bitmap, 
267                 GHOST_TUns8 *mask, 
268                 int sizex, 
269                 int sizey,
270                 int hotX, 
271                 int hotY,
272                 int fg_color, 
273                 int bg_color
274         );
275         
276         /** Window handle. */
277         HWND m_hWnd;
278         /** Device context handle. */
279         HDC m_hDC;
280         /** OpenGL rendering context. */
281         HGLRC m_hGlRc;
282         /** The first created OpenGL context (for sharing display lists) */
283         static HGLRC s_firsthGLRc;
284         /** Flag for if window has captured the mouse */
285         bool m_hasMouseCaptured;
286         /** Count of number of pressed buttons */
287         int m_nPressedButtons;
288         /** HCURSOR structure of the custom cursor */
289         HCURSOR m_customCursor;
290
291         static LPCSTR s_windowClassName;
292         static const int s_maxTitleLength;
293
294         /** WinTab dll handle */
295         HMODULE m_wintab;
296
297         /** Tablet data for GHOST */
298         GHOST_TabletData* m_tabletData;
299
300         /** Stores the Tablet context if detected Tablet features using WinTab.dll */
301         HCTX m_tablet;
302         LONG m_maxPressure;
303         LONG m_maxAzimuth, m_maxAltitude;
304
305 };
306
307 #endif // _GHOST_WINDOW_WIN32_H_
308