Added tablet tilt data collection for GHOST/Win32 - thanks elubie for doing the hard...
[blender-staging.git] / intern / ghost / intern / GHOST_WindowWin32.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31 /**
32  * @file        GHOST_WindowWin32.h
33  * Declaration of GHOST_WindowWin32 class.
34  */
35
36 #ifndef _GHOST_WINDOW_WIN32_H_
37 #define _GHOST_WINDOW_WIN32_H_
38
39 #ifndef WIN32
40 #error WIN32 only!
41 #endif // WIN32
42
43 #include "GHOST_Window.h"
44
45 #include <windows.h>
46
47
48 #include <wintab.h>
49 #define PACKETDATA      (PK_BUTTONS | PK_NORMAL_PRESSURE | PK_ORIENTATION | PK_CURSOR)
50 #define PACKETMODE      PK_BUTTONS
51 #include <pktdef.h>
52
53 // typedefs for WinTab functions to allow dynamic loading
54 typedef UINT (API * GHOST_WIN32_WTInfo) ( UINT, UINT, LPVOID );
55 typedef HCTX (API * GHOST_WIN32_WTOpen) (HWND, LPLOGCONTEXTA, BOOL);
56 typedef BOOL (API * GHOST_WIN32_WTClose) (HCTX);
57 typedef BOOL (API * GHOST_WIN32_WTPacket) (HCTX, UINT, LPVOID);
58
59 /**
60  * GHOST window on M$ Windows OSs.
61  * @author      Maarten Gribnau
62  * @date        May 10, 2001
63  */
64 class GHOST_WindowWin32 : public GHOST_Window {
65 public:
66         /**
67          * Constructor.
68          * Creates a new window and opens it.
69          * To check if the window was created properly, use the getValid() method.
70          * @param title         The text shown in the title bar of the window.
71          * @param left          The coordinate of the left edge of the window.
72          * @param top           The coordinate of the top edge of the window.
73          * @param width         The width the window.
74          * @param height        The height the window.
75          * @param state         The state the window is initially opened with.
76          * @param type          The type of drawing context installed in this window.
77          * @param stereoVisual  Stereo visual for quad buffered stereo.
78          */
79         GHOST_WindowWin32(
80                 const STR_String& title,
81                 GHOST_TInt32 left,
82                 GHOST_TInt32 top,
83                 GHOST_TUns32 width,
84                 GHOST_TUns32 height,
85                 GHOST_TWindowState state,
86                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
87                 const bool stereoVisual = false
88         );
89
90         /**
91          * Destructor.
92          * Closes the window and disposes resources allocated.
93          */
94         virtual ~GHOST_WindowWin32();
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          * Sets the title displayed in the title bar.
104          * @param title The title to display in the title bar.
105          */
106         virtual void setTitle(const STR_String& title);
107
108         /**
109          * Returns the title displayed in the title bar.
110          * @param title The title displayed in the title bar.
111          */
112         virtual void getTitle(STR_String& title) const;
113
114         /**
115          * Returns the window rectangle dimensions.
116          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
117          * @param bounds The bounding rectangle of the window.
118          */
119         virtual void getWindowBounds(GHOST_Rect& bounds) const;
120         
121         /**
122          * Returns the client rectangle dimensions.
123          * The left and top members of the rectangle are always zero.
124          * @param bounds The bounding rectangle of the cleient area of the window.
125          */
126         virtual void getClientBounds(GHOST_Rect& bounds) const;
127
128         /**
129          * Resizes client rectangle width.
130          * @param width The new width of the client area of the window.
131          */
132         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
133
134         /**
135          * Resizes client rectangle height.
136          * @param height The new height of the client area of the window.
137          */
138         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
139
140         /**
141          * Resizes client rectangle.
142          * @param width         The new width of the client area of the window.
143          * @param height        The new height of the client area of the window.
144          */
145         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
146
147         /**
148          * Returns the state of the window (normal, minimized, maximized).
149          * @return The state of the window.
150          */
151         virtual GHOST_TWindowState getState() const;
152
153         /**
154          * Converts a point in screen coordinates to client rectangle coordinates
155          * @param inX   The x-coordinate on the screen.
156          * @param inY   The y-coordinate on the screen.
157          * @param outX  The x-coordinate in the client rectangle.
158          * @param outY  The y-coordinate in the client rectangle.
159          */
160         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
161
162         /**
163          * Converts a point in screen coordinates to client rectangle coordinates
164          * @param inX   The x-coordinate in the client rectangle.
165          * @param inY   The y-coordinate in the client rectangle.
166          * @param outX  The x-coordinate on the screen.
167          * @param outY  The y-coordinate on the screen.
168          */
169         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
170
171         /**
172          * Sets the state of the window (normal, minimized, maximized).
173          * @param state The state of the window.
174          * @return Indication of success.
175          */
176         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
177
178         /**
179          * Sets the order of the window (bottom, top).
180          * @param order The order of the window.
181          * @return Indication of success.
182          */
183         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
184
185         /**
186          * Swaps front and back buffers of a window.
187          * @return Indication of success.
188          */
189         virtual GHOST_TSuccess swapBuffers();
190
191         /**
192          * Activates the drawing context of this window.
193          * @return Indication of success.
194          */
195         virtual GHOST_TSuccess activateDrawingContext();
196
197         /**
198          * Invalidates the contents of this window.
199          */
200         virtual GHOST_TSuccess invalidate();
201
202         /**
203          * Returns the name of the window class.
204          * @return The name of the window class.
205          */
206         static LPCSTR getWindowClassName() { return s_windowClassName; }
207
208         /**
209          * Register a mouse click event (should be called 
210          * for any real button press, controls mouse
211          * capturing).
212          *
213          * @param press True the event was a button press.
214          */
215         void registerMouseClickEvent(bool press);
216
217         /**
218          * Inform the window that it has lost mouse capture,
219          * called in response to native window system messages.
220          */
221         void lostMouseCapture();
222
223         /**
224          * Loads the windows equivalent of a standard GHOST cursor.
225          * @param visible               Flag for cursor visibility.
226          * @param cursorShape   The cursor shape.
227          */
228         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
229
230         const GHOST_TabletData* GetTabletData()
231         { return m_tabletData; }
232
233         void processWin32TabletInitEvent();
234         void processWin32TabletEvent(WPARAM wParam, LPARAM lParam);
235
236 protected:
237         /**
238          * Tries to install a rendering context in this window.
239          * @param type  The type of rendering context installed.
240          * @return Indication of success.
241          */
242         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
243
244         /**
245          * Removes the current drawing context.
246          * @return Indication of success.
247          */
248         virtual GHOST_TSuccess removeDrawingContext();
249
250         /**
251          * Sets the cursor visibility on the window using
252          * native window system calls.
253          */
254         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
255         
256         /**
257          * Sets the cursor shape on the window using
258          * native window system calls.
259          */
260         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
261
262         /**
263          * Sets the cursor shape on the window using
264          * native window system calls.
265          */
266         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
267
268         virtual GHOST_TSuccess setWindowCustomCursorShape(
269                 GHOST_TUns8 *bitmap, 
270                 GHOST_TUns8 *mask, 
271                 int sizex, 
272                 int sizey,
273                 int hotX, 
274                 int hotY,
275                 int fg_color, 
276                 int bg_color
277         );
278         
279         /** Window handle. */
280         HWND m_hWnd;
281         /** Device context handle. */
282         HDC m_hDC;
283         /** OpenGL rendering context. */
284         HGLRC m_hGlRc;
285         /** The first created OpenGL context (for sharing display lists) */
286         static HGLRC s_firsthGLRc;
287         /** Flag for if window has captured the mouse */
288         bool m_hasMouseCaptured;
289         /** Count of number of pressed buttons */
290         int m_nPressedButtons;
291         /** HCURSOR structure of the custom cursor */
292         HCURSOR m_customCursor;
293
294         static LPCSTR s_windowClassName;
295         static const int s_maxTitleLength;
296
297         /** WinTab dll handle */
298         HMODULE m_wintab;
299
300         /** Tablet data for GHOST */
301         GHOST_TabletData* m_tabletData;
302
303         /** Stores the Tablet context if detected Tablet features using WinTab.dll */
304         HCTX m_tablet;
305         LONG m_maxPressure;
306         LONG m_maxAzimuth, m_maxAltitude;
307
308 };
309
310 #endif // _GHOST_WINDOW_WIN32_H_
311