4 * The callbacks setting methods.
6 * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7 * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8 * Creation date: Fri Dec 3 1999
10 * Permission is hereby granted, free of charge, to any person obtaining a
11 * copy of this software and associated documentation files (the "Software"),
12 * to deal in the Software without restriction, including without limitation
13 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14 * and/or sell copies of the Software, and to permit persons to whom the
15 * Software is furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included
18 * in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
24 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 #include <GL/freeglut.h>
29 #include "fg_internal.h"
31 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
37 /* Sets the global idle callback */
38 void FGAPIENTRY glutIdleFunc( FGCBIdle callback )
40 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutIdleFunc" );
41 fgState.IdleCallback = callback;
44 /* Creates a timer and sets its callback */
45 void FGAPIENTRY glutTimerFunc( unsigned int timeOut, FGCBTimer callback, int timerID )
47 SFG_Timer *timer, *node;
49 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutTimerFunc" );
51 if( (timer = fgState.FreeTimers.Last) )
53 fgListRemove( &fgState.FreeTimers, &timer->Node );
57 if( ! (timer = malloc(sizeof(SFG_Timer))) )
58 fgError( "Fatal error: "
59 "Memory allocation failure in glutTimerFunc()" );
62 timer->Callback = callback;
64 timer->TriggerTime = fgElapsedTime() + timeOut;
66 /* Insert such that timers are sorted by end-time */
67 for( node = fgState.Timers.First; node; node = node->Node.Next )
69 if( node->TriggerTime > timer->TriggerTime )
73 fgListInsert( &fgState.Timers, &node->Node, &timer->Node );
76 /* Deprecated version of glutMenuStatusFunc callback setting method */
77 void FGAPIENTRY glutMenuStateFunc( FGCBMenuState callback )
79 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuStateFunc" );
80 fgState.MenuStateCallback = callback;
83 /* Sets the global menu status callback for the current window */
84 void FGAPIENTRY glutMenuStatusFunc( FGCBMenuStatus callback )
86 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuStatusFunc" );
87 fgState.MenuStatusCallback = callback;
92 * Menu specific callbacks.
94 /* Callback upon menu destruction */
95 void FGAPIENTRY glutMenuDestroyFunc( FGCBDestroy callback )
97 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuDestroyFunc" );
98 if( fgStructure.CurrentMenu )
99 fgStructure.CurrentMenu->Destroy = callback;
104 * All of the window-specific callbacks setting methods can be generalized to this:
106 #define SET_CALLBACK(a) \
109 if( fgStructure.CurrentWindow == NULL ) \
111 SET_WCB( ( *( fgStructure.CurrentWindow ) ), a, callback ); \
114 * And almost every time the callback setter function can be implemented like this:
116 #define IMPLEMENT_CALLBACK_FUNC_2NAME(a,b) \
117 void FGAPIENTRY glut##a##Func( FGCB##b callback ) \
119 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glut"#a"Func" ); \
122 #define IMPLEMENT_CALLBACK_FUNC(a) IMPLEMENT_CALLBACK_FUNC_2NAME(a,a)
124 /* Implement all these callback setter functions... */
125 IMPLEMENT_CALLBACK_FUNC(Position)
126 IMPLEMENT_CALLBACK_FUNC(Keyboard)
127 IMPLEMENT_CALLBACK_FUNC(KeyboardUp)
128 IMPLEMENT_CALLBACK_FUNC(Special)
129 IMPLEMENT_CALLBACK_FUNC(SpecialUp)
130 IMPLEMENT_CALLBACK_FUNC(Mouse)
131 IMPLEMENT_CALLBACK_FUNC(MouseWheel)
132 IMPLEMENT_CALLBACK_FUNC(Motion)
133 IMPLEMENT_CALLBACK_FUNC_2NAME(PassiveMotion,Passive)
134 IMPLEMENT_CALLBACK_FUNC(Entry)
135 /* glutWMCloseFunc is an alias for glutCloseFunc; both set the window's Destroy callback */
136 IMPLEMENT_CALLBACK_FUNC_2NAME(Close,Destroy)
137 IMPLEMENT_CALLBACK_FUNC_2NAME(WMClose,Destroy)
138 IMPLEMENT_CALLBACK_FUNC(OverlayDisplay)
139 IMPLEMENT_CALLBACK_FUNC(WindowStatus)
140 IMPLEMENT_CALLBACK_FUNC(ButtonBox)
141 IMPLEMENT_CALLBACK_FUNC(Dials)
142 IMPLEMENT_CALLBACK_FUNC(TabletMotion)
143 IMPLEMENT_CALLBACK_FUNC(TabletButton)
144 IMPLEMENT_CALLBACK_FUNC(MultiEntry)
145 IMPLEMENT_CALLBACK_FUNC(MultiButton)
146 IMPLEMENT_CALLBACK_FUNC(MultiMotion)
147 IMPLEMENT_CALLBACK_FUNC(MultiPassive)
148 IMPLEMENT_CALLBACK_FUNC(InitContext)
149 IMPLEMENT_CALLBACK_FUNC(AppStatus)
154 * Sets the Display callback for the current window
156 void FGAPIENTRY glutDisplayFunc( FGCBDisplay callback )
158 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDisplayFunc" );
160 fgError( "Fatal error in program. NULL display callback not "
161 "permitted in GLUT 3.0+ or freeglut 2.0.1+" );
162 SET_CALLBACK( Display );
165 void fghDefaultReshape(int width, int height)
167 glViewport( 0, 0, width, height );
170 void FGAPIENTRY glutReshapeFunc( FGCBReshape callback )
172 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeFunc" );
175 callback = fghDefaultReshape;
177 SET_CALLBACK( Reshape );
181 * Sets the Visibility callback for the current window.
182 * NB: the Visibility func is deprecated in favor of the WindowStatus func,
183 * which provides more detail. The visibility func callback is implemented
184 * as a translation step from the windowStatus func. When the user sets the
185 * windowStatus func, any visibility func is overwritten.
186 * DEVELOPER NOTE: in the library, only invoke the window status func, this
187 * gets automatically translated to the visibility func if thats what the
189 * window status is kind of anemic on win32 as there are no window messages
190 * to notify us that the window is covered by other windows or not.
191 * Should one want to query this, see
192 * http://stackoverflow.com/questions/5445889/get-which-process-window-is-actually-visible-in-c-sharp
193 * for an implementation outline (but it would be polling based, not push based).
195 static void fghVisibility( int status )
199 FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED ( "Visibility Callback" );
200 freeglut_return_if_fail( fgStructure.CurrentWindow );
202 /* Translate window status func states to visibility states */
203 if( ( GLUT_HIDDEN == status ) || ( GLUT_FULLY_COVERED == status ) )
204 vis_status = GLUT_NOT_VISIBLE;
205 else /* GLUT_FULLY_RETAINED, GLUT_PARTIALLY_RETAINED */
206 vis_status = GLUT_VISIBLE;
208 INVOKE_WCB( *( fgStructure.CurrentWindow ), Visibility, ( vis_status ) );
211 void FGAPIENTRY glutVisibilityFunc( FGCBVisibility callback )
213 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutVisibilityFunc" );
214 SET_CALLBACK( Visibility );
217 glutWindowStatusFunc( fghVisibility );
219 glutWindowStatusFunc( NULL );
223 * Sets the joystick callback and polling rate for the current window
225 void FGAPIENTRY glutJoystickFunc( FGCBJoystick callback, int pollInterval )
227 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutJoystickFunc" );
228 fgInitialiseJoysticks ();
231 fgStructure.CurrentWindow->State.JoystickPollRate <= 0 || /* Joystick callback was disabled */
232 !FETCH_WCB(*fgStructure.CurrentWindow,Joystick)
235 callback && ( pollInterval > 0 ) /* but is now enabled */
237 ++fgState.NumActiveJoysticks;
239 fgStructure.CurrentWindow->State.JoystickPollRate > 0 && /* Joystick callback was enabled */
240 FETCH_WCB(*fgStructure.CurrentWindow,Joystick)
243 !callback || ( pollInterval <= 0 ) /* but is now disabled */
245 --fgState.NumActiveJoysticks;
247 SET_CALLBACK( Joystick );
248 fgStructure.CurrentWindow->State.JoystickPollRate = pollInterval;
250 /* set last poll time such that joystick will be polled asap */
251 fgStructure.CurrentWindow->State.JoystickLastPoll = fgElapsedTime();
252 if (fgStructure.CurrentWindow->State.JoystickLastPoll < pollInterval)
253 fgStructure.CurrentWindow->State.JoystickLastPoll = 0;
255 fgStructure.CurrentWindow->State.JoystickLastPoll -= pollInterval;
261 * Sets the spaceball motion callback for the current window
263 void FGAPIENTRY glutSpaceballMotionFunc( FGCBSpaceMotion callback )
265 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpaceballMotionFunc" );
266 fgInitialiseSpaceball();
268 SET_CALLBACK( SpaceMotion );
272 * Sets the spaceball rotate callback for the current window
274 void FGAPIENTRY glutSpaceballRotateFunc( FGCBSpaceRotation callback )
276 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpaceballRotateFunc" );
277 fgInitialiseSpaceball();
279 SET_CALLBACK( SpaceRotation );
283 * Sets the spaceball button callback for the current window
285 void FGAPIENTRY glutSpaceballButtonFunc( FGCBSpaceButton callback )
287 FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpaceballButtonFunc" );
288 fgInitialiseSpaceball();
290 SET_CALLBACK( SpaceButton );
293 /*** END OF FILE ***/