Yes I did it again ;)
[blender-staging.git] / intern / ghost / GHOST_ISystem.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 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 30, 2001
38  */
39
40 #ifndef _GHOST_ISYSTEM_H_
41 #define _GHOST_ISYSTEM_H_
42
43 #ifdef HAVE_CONFIG_H
44 #include <config.h>
45 #endif
46
47 #include "GHOST_Types.h"
48 #include "GHOST_ITimerTask.h"
49 #include "GHOST_IWindow.h"
50
51 class GHOST_IEventConsumer;
52
53 /**
54  * Interface for classes that provide access to the operating system.
55  * There should be only one system class in an application.
56  * Therefore, the routines to create and dispose the system are static.
57  * Provides:
58  * 1. Time(r) management.
59  * 2. Display/window management (windows are only created on the main display for now).
60  * 3. Event management.
61  * 4. Access to the state of the mouse buttons and the keyboard.
62  * @author      Maarten Gribnau
63  * @date        May 30, 2001
64  */
65
66 class GHOST_ISystem
67 {
68 public:
69         /**
70          * Creates the one and only system.
71          * @return An indication of success.
72          */
73         static GHOST_TSuccess createSystem();
74
75         /**
76          * Disposes the one and only system.
77          * @return An indication of success.
78          */
79         static GHOST_TSuccess disposeSystem();
80
81         /**
82          * Returns a pointer to the one and only system (nil if it hasn't been created).
83          * @return A pointer to the system.
84          */
85         static GHOST_ISystem* getSystem();
86
87 protected:
88         /**
89          * Constructor.
90          * Protected default constructor to force use of static createSystem member.
91          */
92         GHOST_ISystem() {}
93
94         /**
95          * Destructor.
96          * Protected default constructor to force use of static dispose member.
97          */
98         virtual ~GHOST_ISystem() {}
99
100 public:
101         /***************************************************************************************
102          ** Time(r) functionality
103          ***************************************************************************************/
104
105         /**
106          * Returns the system time.
107          * Returns the number of milliseconds since the start of the system process.
108          * Based on ANSI clock() routine.
109          * @return The number of milliseconds.
110          */
111         virtual GHOST_TUns64 getMilliSeconds() const = 0;
112
113         /**
114          * Installs a timer.
115          * Note that, on most operating systems, messages need to be processed in order 
116          * for the timer callbacks to be invoked.
117          * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
118          * @param interval      The interval between calls to the timerProc (in milliseconds)
119          * @param timerProc     The callback invoked when the interval expires,
120          * @param userData      Placeholder for user data.
121          * @return A timer task (0 if timer task installation failed).
122          */
123         virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0) = 0;
124
125         /**
126          * Removes a timer.
127          * @param timerTask Timer task to be removed.
128          * @return Indication of success.
129          */
130         virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask) = 0;
131
132         /***************************************************************************************
133          ** Display/window management functionality
134          ***************************************************************************************/
135
136         /**
137          * Returns the number of displays on this system.
138          * @return The number of displays.
139          */
140         virtual GHOST_TUns8 getNumDisplays() const = 0;
141
142         /**
143          * Returns the dimensions of the main display on this system.
144          * @return The dimension of the main display.
145          */
146         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
147         
148         /**
149          * Create a new window.
150          * The new window is added to the list of windows managed. 
151          * Never explicitly delete the window, use disposeWindow() instead.
152          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
153          * @param       left            The coordinate of the left edge of the window.
154          * @param       top             The coordinate of the top edge of the window.
155          * @param       width           The width the window.
156          * @param       height          The height the window.
157          * @param       state           The state of the window when opened.
158          * @param       type            The type of drawing context installed in this window.
159          * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
160          * @return      The new window (or 0 if creation failed).
161          */
162         virtual GHOST_IWindow* createWindow(
163                 const STR_String& title,
164                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
165                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
166                 const bool stereoVisual) = 0;
167
168         /**
169          * Dispose a window.
170          * @param       window Pointer to the window to be disposed.
171          * @return      Indication of success.
172          */
173         virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window) = 0;
174
175         /**
176          * Returns whether a window is valid.
177          * @param       window Pointer to the window to be checked.
178          * @return      Indication of validity.
179          */
180         virtual bool validWindow(GHOST_IWindow* window) = 0;
181
182         /**
183          * Begins full screen mode.
184          * @param setting       The new setting of the display.
185          * @param window        Window displayed in full screen.
186          *                                      This window is invalid after full screen has been ended.
187          * @return      Indication of success.
188          */
189         virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
190                 const bool stereoVisual) = 0;
191
192         /**
193          * Ends full screen mode.
194          * @return      Indication of success.
195          */
196         virtual GHOST_TSuccess endFullScreen(void) = 0;
197
198         /**
199          * Returns current full screen mode status.
200          * @return The current status.
201          */
202         virtual bool getFullScreen(void) = 0;
203
204         /***************************************************************************************
205          ** Event management functionality
206          ***************************************************************************************/
207
208         /**
209          * Retrieves events from the system and stores them in the queue.
210          * @param waitForEvent Flag to wait for an event (or return immediately).
211          * @return Indication of the presence of events.
212          */
213         virtual bool processEvents(bool waitForEvent) = 0;
214         
215         /**
216          * Retrieves events from the queue and send them to the event consumers.
217          * @return Indication of the presence of events.
218          */
219         virtual bool dispatchEvents() = 0;
220
221         /**
222          * Adds the given event consumer to our list.
223          * @param consumer The event consumer to add.
224          * @return Indication of success.
225          */
226         virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer) = 0;
227         
228         /***************************************************************************************
229          ** Cursor management functionality
230          ***************************************************************************************/
231
232         /**
233          * Returns the current location of the cursor (location in screen coordinates)
234          * @param x                     The x-coordinate of the cursor.
235          * @param y                     The y-coordinate of the cursor.
236          * @return                      Indication of success.
237          */
238         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;
239
240         /**
241          * Updates the location of the cursor (location in screen coordinates).
242          * Not all operating systems allow the cursor to be moved (without the input device being moved).
243          * @param x                     The x-coordinate of the cursor.
244          * @param y                     The y-coordinate of the cursor.
245          * @return                      Indication of success.
246          */
247         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const = 0;
248
249         /***************************************************************************************
250          ** Access to mouse button and keyboard states.
251          ***************************************************************************************/
252
253         /**
254          * Returns the state of a modifier key (ouside the message queue).
255          * @param mask          The modifier key state to retrieve.
256          * @param isDown        The state of a modifier key (true == pressed).
257          * @return                      Indication of success.
258          */
259         virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const = 0;
260
261         /**
262          * Returns the state of a mouse button (ouside the message queue).
263          * @param mask          The button state to retrieve.
264          * @param isDown        Button state.
265          * @return                      Indication of success.
266          */
267         virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const = 0;
268
269 protected:
270         /**
271          * Initialize the system.
272          * @return Indication of success.
273          */
274         virtual GHOST_TSuccess init() = 0;
275
276         /**
277          * Shut the system down.
278          * @return Indication of success.
279          */
280         virtual GHOST_TSuccess exit() = 0;
281
282         /** The one and only system */
283         static GHOST_ISystem* m_system;
284 };
285
286 #endif // _GHOST_ISYSTEM_H_
287