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., 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_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 class GHOST_SystemWin32;
  51 class GHOST_DropTargetWin32;
  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          * @param numOfAASamples        Number of samples used for AA (zero if no AA)
  79          */
  80         GHOST_WindowWin32(
  81                 GHOST_SystemWin32 * system,
  82                 const STR_String& title,
  83                 GHOST_TInt32 left,
  84                 GHOST_TInt32 top,
  85                 GHOST_TUns32 width,
  86                 GHOST_TUns32 height,
  87                 GHOST_TWindowState state,
  88                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
  89                 const bool stereoVisual = false,
  90                 const GHOST_TUns16 numOfAASamples = 0,
  91                 GHOST_TSuccess msEnabled = GHOST_kFailure,
  92                 int msPixelFormat = 0
  93         );
  94
  95         /**
  96          * Destructor.
  97          * Closes the window and disposes resources allocated.
  98          */
  99         virtual ~GHOST_WindowWin32();
 100
 101         /**
 102          * Returns the window to replace this one if it's getting replaced
 103          * @return The window replacing this one.
 104          */
 105
 106         GHOST_Window *getNextWindow();
 107
 108         /**
 109          * Returns indication as to whether the window is valid.
 110          * @return The validity of the window.
 111          */
 112         virtual bool getValid() const;
 113
 114         /**
 115          * Access to the handle of the window.
 116          * @return The handle of the window.
 117          */
 118         virtual HWND getHWND() const;
 119
 120         /**
 121          * Sets the title displayed in the title bar.
 122          * @param title The title to display in the title bar.
 123          */
 124         virtual void setTitle(const STR_String& title);
 125
 126         /**
 127          * Returns the title displayed in the title bar.
 128          * @param title The title displayed in the title bar.
 129          */
 130         virtual void getTitle(STR_String& title) const;
 131
 132         /**
 133          * Returns the window rectangle dimensions.
 134          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
 135          * @param bounds The bounding rectangle of the window.
 136          */
 137         virtual void getWindowBounds(GHOST_Rect& bounds) const;
 138
 139         /**
 140          * Returns the client rectangle dimensions.
 141          * The left and top members of the rectangle are always zero.
 142          * @param bounds The bounding rectangle of the cleient area of the window.
 143          */
 144         virtual void getClientBounds(GHOST_Rect& bounds) const;
 145
 146         /**
 147          * Resizes client rectangle width.
 148          * @param width The new width of the client area of the window.
 149          */
 150         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 151
 152         /**
 153          * Resizes client rectangle height.
 154          * @param height The new height of the client area of the window.
 155          */
 156         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 157
 158         /**
 159          * Resizes client rectangle.
 160          * @param width         The new width of the client area of the window.
 161          * @param height        The new height of the client area of the window.
 162          */
 163         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 164
 165         /**
 166          * Returns the state of the window (normal, minimized, maximized).
 167          * @return The state of the window.
 168          */
 169         virtual GHOST_TWindowState getState() const;
 170
 171         /**
 172          * Converts a point in screen coordinates to client rectangle coordinates
 173          * @param inX   The x-coordinate on the screen.
 174          * @param inY   The y-coordinate on the screen.
 175          * @param outX  The x-coordinate in the client rectangle.
 176          * @param outY  The y-coordinate in the client rectangle.
 177          */
 178         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 179
 180         /**
 181          * Converts a point in screen coordinates to client rectangle coordinates
 182          * @param inX   The x-coordinate in the client rectangle.
 183          * @param inY   The y-coordinate in the client rectangle.
 184          * @param outX  The x-coordinate on the screen.
 185          * @param outY  The y-coordinate on the screen.
 186          */
 187         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 188
 189         /**
 190          * Sets the state of the window (normal, minimized, maximized).
 191          * @param state The state of the window.
 192          * @return Indication of success.
 193          */
 194         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
 195
 196         /**
 197          * Sets the order of the window (bottom, top).
 198          * @param order The order of the window.
 199          * @return Indication of success.
 200          */
 201         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 202
 203         /**
 204          * Swaps front and back buffers of a window.
 205          * @return Indication of success.
 206          */
 207         virtual GHOST_TSuccess swapBuffers();
 208
 209         /**
 210          * Activates the drawing context of this window.
 211          * @return Indication of success.
 212          */
 213         virtual GHOST_TSuccess activateDrawingContext();
 214
 215         /**
 216          * Invalidates the contents of this window.
 217          */
 218         virtual GHOST_TSuccess invalidate();
 219
 220         /**
 221          * Returns the name of the window class.
 222          * @return The name of the window class.
 223          */
 224         static LPCSTR getWindowClassName() { return s_windowClassName; }
 225
 226         /**
 227          * Register a mouse click event (should be called
 228          * for any real button press, controls mouse
 229          * capturing).
 230          *
 231          * @param press True the event was a button press.
 232          */
 233         void registerMouseClickEvent(bool press);
 234
 235         /**
 236          * Inform the window that it has lost mouse capture,
 237          * called in response to native window system messages.
 238          */
 239         void lostMouseCapture();
 240
 241         /**
 242          * Loads the windows equivalent of a standard GHOST cursor.
 243          * @param visible               Flag for cursor visibility.
 244          * @param cursorShape   The cursor shape.
 245          */
 246         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
 247
 248         const GHOST_TabletData* GetTabletData()
 249         { return m_tabletData; }
 250
 251         void processWin32TabletInitEvent();
 252         void processWin32TabletEvent(WPARAM wParam, LPARAM lParam);
 253
 254 protected:
 255         GHOST_TSuccess initMultisample(PIXELFORMATDESCRIPTOR pfd);
 256
 257         /**
 258          * Tries to install a rendering context in this window.
 259          * @param type  The type of rendering context installed.
 260          * @return Indication of success.
 261          */
 262         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
 263
 264         /**
 265          * Removes the current drawing context.
 266          * @return Indication of success.
 267          */
 268         virtual GHOST_TSuccess removeDrawingContext();
 269
 270         /**
 271          * Sets the cursor visibility on the window using
 272          * native window system calls.
 273          */
 274         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
 275
 276         /**
 277          * Sets the cursor grab on the window using native window system calls.
 278          * Using registerMouseClickEvent.
 279          * @param mode  GHOST_TGrabCursorMode.
 280          */
 281         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
 282
 283         /**
 284          * Sets the cursor shape on the window using
 285          * native window system calls.
 286          */
 287         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
 288
 289         /**
 290          * Sets the cursor shape on the window using
 291          * native window system calls.
 292          */
 293         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
 294
 295         virtual GHOST_TSuccess setWindowCustomCursorShape(
 296                 GHOST_TUns8 *bitmap,
 297                 GHOST_TUns8 *mask,
 298                 int sizex,
 299                 int sizey,
 300                 int hotX,
 301                 int hotY,
 302                 int fg_color,
 303                 int bg_color
 304         );
 305
 306         /** Pointer to system */
 307         GHOST_SystemWin32 * m_system;
 308         /** Pointer to COM IDropTarget implementor */
 309         GHOST_DropTargetWin32 * m_dropTarget;
 310         /** Window handle. */
 311         HWND m_hWnd;
 312         /** Device context handle. */
 313         HDC m_hDC;
 314         /** OpenGL rendering context. */
 315         HGLRC m_hGlRc;
 316         /** The first created OpenGL context (for sharing display lists) */
 317         static HGLRC s_firsthGLRc;
 318         /** The first created device context handle. */
 319         static HDC s_firstHDC;
 320         /** Flag for if window has captured the mouse */
 321         bool m_hasMouseCaptured;
 322         /** Count of number of pressed buttons */
 323         int m_nPressedButtons;
 324         /** HCURSOR structure of the custom cursor */
 325         HCURSOR m_customCursor;
 326
 327         static LPCSTR s_windowClassName;
 328         static const int s_maxTitleLength;
 329
 330         /** WinTab dll handle */
 331         HMODULE m_wintab;
 332
 333         /** Tablet data for GHOST */
 334         GHOST_TabletData* m_tabletData;
 335
 336         /** Stores the Tablet context if detected Tablet features using WinTab.dll */
 337         HCTX m_tablet;
 338         LONG m_maxPressure;
 339         LONG m_maxAzimuth, m_maxAltitude;
 340
 341         /** Preferred number of samples */
 342         GHOST_TUns16 m_multisample;
 343
 344         /** Check if multisample is supported */
 345         GHOST_TSuccess m_multisampleEnabled;
 346
 347         /** The pixelFormat to use for multisample */
 348         int m_msPixelFormat;
 349
 350         /** We need to following to recreate the window */
 351         const STR_String& m_title;
 352         GHOST_TInt32 m_left;
 353         GHOST_TInt32 m_top;
 354         GHOST_TUns32 m_width;
 355         GHOST_TUns32 m_height;
 356         GHOST_TWindowState m_normal_state;
 357         bool m_stereo;
 358
 359         /** The GHOST_System passes this to wm if this window is being replaced */
 360         GHOST_Window *m_nextWindow;
 361 };
 362
 363 #endif // _GHOST_WINDOW_WIN32_H_