Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / intern / ghost / intern / GHOST_System.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_System.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_System class.
31  */
32
33 #ifndef _GHOST_SYSTEM_H_
34 #define _GHOST_SYSTEM_H_
35
36 #include "GHOST_ISystem.h"
37
38 #include "GHOST_Debug.h"
39 #include "GHOST_Buttons.h"
40 #include "GHOST_ModifierKeys.h"
41 #include "GHOST_EventManager.h"
42 #ifdef GHOST_DEBUG
43 #include "GHOST_EventPrinter.h"
44 #endif // GHOST_DEBUG
45
46 class GHOST_DisplayManager;
47 class GHOST_Event;
48 class GHOST_TimerManager;
49 class GHOST_Window;
50 class GHOST_WindowManager;
51 class GHOST_NDOFManager;
52
53 /**
54  * Implementation of platform independent functionality of the GHOST_ISystem
55  * interface.
56  * GHOST_System is an abstract class because not all methods of GHOST_ISystem
57  * are implemented.
58  * @see GHOST_ISystem.
59  * @author      Maarten Gribnau
60  * @date        May 7, 2001
61  */
62 class GHOST_System : public GHOST_ISystem
63 {
64 protected:
65         /**
66          * Constructor.
67          * Protected default constructor to force use of static createSystem member.
68          */
69         GHOST_System();
70
71         /**
72          * Destructor.
73          * Protected default constructor to force use of static dispose member.
74          */
75         virtual ~GHOST_System();
76
77 public:
78         /***************************************************************************************
79          ** Time(r) functionality
80          ***************************************************************************************/
81
82         /**
83          * Returns the system time.
84          * Returns the number of milliseconds since the start of the system process.
85          * Based on ANSI clock() routine.
86          * @return The number of milliseconds.
87          */
88         virtual GHOST_TUns64 getMilliSeconds() const;
89
90         /**
91          * Installs a timer.
92          * Note that, on most operating systems, messages need to be processed in order 
93          * for the timer callbacks to be invoked.
94          * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
95          * @param interval      The interval between calls to the timerProc
96          * @param timerProc     The callback invoked when the interval expires,
97          * @param userData      Placeholder for user data.
98          * @return A timer task (0 if timer task installation failed).
99          */
100         virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0);
101
102         /**
103          * Removes a timer.
104          * @param timerTask Timer task to be removed.
105          * @return Indication of success.
106          */
107         virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask);
108
109         /***************************************************************************************
110          ** Display/window management functionality
111          ***************************************************************************************/
112         
113         /**
114          * Inherited from GHOST_ISystem but left pure virtual
115          *
116          * virtual      GHOST_TUns8 getNumDisplays() const = 0;
117          * virtual void getMainDisplayDimensions(...) const = 0;
118          * virtual GHOST_IWindow* createWindow(..)
119          */
120
121         /**
122          * Dispose a window.
123          * @param       window Pointer to the window to be disposed.
124          * @return      Indication of success.
125          */
126         virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window);
127
128         /**
129          * Returns whether a window is valid.
130          * @param       window Pointer to the window to be checked.
131          * @return      Indication of validity.
132          */
133         virtual bool validWindow(GHOST_IWindow* window);
134
135         /**
136          * Begins full screen mode.
137          * @param setting       The new setting of the display.
138          * @param window        Window displayed in full screen.
139          * @param stereoVisual  Stereo visual for quad buffered stereo.
140          * This window is invalid after full screen has been ended.
141          * @return      Indication of success.
142          */
143         virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
144                 const bool stereoVisual);
145
146         /**
147          * Ends full screen mode.
148          * @return      Indication of success.
149          */
150         virtual GHOST_TSuccess endFullScreen(void);
151
152         /**
153          * Returns current full screen mode status.
154          * @return The current status.
155          */
156         virtual bool getFullScreen(void);
157
158
159         /***************************************************************************************
160          ** Event management functionality
161          ***************************************************************************************/
162
163         /**
164          * Inherited from GHOST_ISystem but left pure virtual
165          *
166          *      virtual bool processEvents(bool waitForEvent) = 0;
167          */
168
169
170
171         /**
172          * Dispatches all the events on the stack.
173          * The event stack will be empty afterwards.
174          * @return Indication as to whether any of the consumers handled the events.
175          */
176         virtual bool dispatchEvents();
177
178         /**
179          * Adds the given event consumer to our list.
180          * @param consumer The event consumer to add.
181          * @return Indication of success.
182          */
183         virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer);
184
185         /**
186          * Remove the given event consumer to our list.
187          * @param consumer The event consumer to remove.
188          * @return Indication of success.
189          */
190         virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer* consumer);
191
192         /***************************************************************************************
193          ** Cursor management functionality
194          ***************************************************************************************/
195
196         /** Inherited from GHOST_ISystem but left pure virtual
197          *      GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;   
198          *  GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y)
199          */
200
201         /***************************************************************************************
202          ** Access to mouse button and keyboard states.
203          ***************************************************************************************/
204
205         /**
206          * Returns the state of a modifier key (ouside the message queue).
207          * @param mask          The modifier key state to retrieve.
208          * @param isDown        The state of a modifier key (true == pressed).
209          * @return                      Indication of success.
210          */
211         virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const;
212
213         /**
214          * Returns the state of a mouse button (ouside the message queue).
215          * @param mask          The button state to retrieve.
216          * @param isDown        Button state.
217          * @return                      Indication of success.
218          */
219         virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const;
220         
221         /***************************************************************************************
222          ** Other (internal) functionality.
223          ***************************************************************************************/
224
225         /**
226          * Pushes an event on the stack.
227          * To dispatch it, call dispatchEvent() or dispatchEvents().
228          * Do not delete the event!
229          * @param event The event to push on the stack.
230          */
231         virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);
232
233         /**
234          * Returns the timer manager.
235          * @return The timer manager.
236          */
237         inline virtual GHOST_TimerManager* getTimerManager() const;
238
239         /**
240          * Returns a pointer to our event manager.
241          * @return A pointer to our event manager.
242          */
243         virtual inline GHOST_EventManager* getEventManager() const;
244
245         /**
246          * Returns a pointer to our window manager.
247          * @return A pointer to our window manager.
248          */
249         virtual inline GHOST_WindowManager* getWindowManager() const;
250
251 #ifdef WITH_INPUT_NDOF
252         /**
253          * Returns a pointer to our n-degree of freedeom manager.
254          * @return A pointer to our n-degree of freedeom manager.
255          */
256         virtual inline GHOST_NDOFManager* getNDOFManager() const;
257 #endif
258
259         /**
260          * Returns the state of all modifier keys.
261          * @param keys  The state of all modifier keys (true == pressed).
262          * @return              Indication of success.
263          */
264         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const = 0;
265
266         /**
267          * Returns the state of the mouse buttons (ouside the message queue).
268          * @param buttons       The state of the buttons.
269          * @return                      Indication of success.
270          */
271         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const = 0;
272
273         /**
274          * Returns the selection buffer
275          * @param selection             Only used on X11
276          * @return                              Returns the clipboard data
277          *
278          */
279          virtual GHOST_TUns8* getClipboard(bool selection) const = 0;
280           
281           /**
282            * Put data to the Clipboard
283            * @param buffer              The buffer to copy to the clipboard
284            * @param selection   The clipboard to copy too only used on X11
285            */
286           virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
287
288         
289 protected:
290         /**
291          * Initialize the system.
292          * @return Indication of success.
293          */
294         virtual GHOST_TSuccess init();
295
296         /**
297          * Shut the system down.
298          * @return Indication of success.
299          */
300         virtual GHOST_TSuccess exit();
301
302         /**
303          * Creates a fullscreen window.
304          * @param window The window created.
305          * @return Indication of success.
306          */
307         virtual GHOST_TSuccess createFullScreenWindow(GHOST_Window** window,
308                 const bool stereoVisual);
309
310         /** The display manager (platform dependant). */
311         GHOST_DisplayManager* m_displayManager;
312
313         /** The timer manager. */
314         GHOST_TimerManager* m_timerManager;
315
316         /** The window manager. */
317         GHOST_WindowManager* m_windowManager;
318
319         /** The event manager. */
320         GHOST_EventManager* m_eventManager;
321
322 #ifdef WITH_INPUT_NDOF
323         /** The N-degree of freedom device manager */
324         GHOST_NDOFManager* m_ndofManager;
325 #endif
326         
327         /** Prints all the events. */
328 #ifdef GHOST_DEBUG
329         GHOST_EventPrinter* m_eventPrinter;
330 #endif // GHOST_DEBUG
331
332         /** Settings of the display before the display went fullscreen. */
333         GHOST_DisplaySetting m_preFullScreenSetting;
334 };
335
336 inline GHOST_TimerManager* GHOST_System::getTimerManager() const
337 {
338         return m_timerManager;
339 }
340
341 inline GHOST_EventManager* GHOST_System::getEventManager() const
342 {
343         return m_eventManager;
344 }
345
346 inline GHOST_WindowManager* GHOST_System::getWindowManager() const
347 {
348         return m_windowManager;
349 }
350
351 #ifdef WITH_INPUT_NDOF
352 inline GHOST_NDOFManager* GHOST_System::getNDOFManager() const
353 {
354         return m_ndofManager;
355 }
356 #endif
357
358 #endif // _GHOST_SYSTEM_H_
359