git.mutantstargoat.com Git - freeglut/blob - src/freeglut_callbacks.c

   1 /*
   2  * freeglut_callbacks.c
   3  *
   4  * The callbacks setting methods.
   5  *
   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
   9  *
  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:
  16  *
  17  * The above copyright notice and this permission notice shall be included
  18  * in all copies or substantial portions of the Software.
  19  *
  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.
  26  */
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #define  G_LOG_DOMAIN  "freeglut-callbacks"
  33
  34 #include "../include/GL/freeglut.h"
  35 #include "freeglut_internal.h"
  36
  37
  38 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
  39
  40 /*
  41  * All of the callbacks setting methods can be generalized to this:
  42  */
  43 #define SET_CALLBACK(a) if( fgStructure.Window == NULL ) return;\
  44                             fgStructure.Window->Callbacks.a = callback;
  45
  46 /*
  47  * Sets the Display callback for the current window
  48  */
  49 void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
  50 {
  51     if( !callback )
  52         fgError ("Fatal error in program.  NULL display callback not "
  53             "permitted in GLUT 3.0+ or freeglut 2.0.1+\n");
  54     SET_CALLBACK( Display );
  55
  56     /*
  57      * Force a redisplay with the new callback
  58      */
  59     fgStructure.Window->State.Redisplay = TRUE;
  60
  61 }
  62
  63 /*
  64  * Sets the Reshape callback for the current window
  65  */
  66 void FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) )
  67 {
  68     SET_CALLBACK( Reshape );
  69 }
  70
  71 /*
  72  * Sets the Keyboard callback for the current window
  73  */
  74 void FGAPIENTRY glutKeyboardFunc( void (* callback)( unsigned char, int, int ) )
  75 {
  76     SET_CALLBACK( Keyboard );
  77 }
  78
  79 /*
  80  * Sets the Special callback for the current window
  81  */
  82 void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
  83 {
  84     SET_CALLBACK( Special );
  85 }
  86
  87 /*
  88  * Sets the global idle callback
  89  */
  90 void FGAPIENTRY glutIdleFunc( void (* callback)( void ) )
  91 {
  92     freeglut_assert_ready;
  93
  94     /*
  95      * The global idle callback pointer is stored in fgState structure
  96      */
  97     fgState.IdleCallback = callback;
  98 }
  99
 100 /*
 101  * Sets the Timer callback for the current window
 102  */
 103 void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ), int timerID )
 104 {
 105     SFG_Timer* timer;
 106
 107     freeglut_assert_ready;
 108
 109     /*
 110      * Create a new freeglut timer hook structure
 111      */
 112     timer = (SFG_Timer *)calloc( sizeof(SFG_Timer), 1 );
 113
 114     /*
 115      * Remember the callback address and timer hook's ID
 116      */
 117     timer->Callback  = callback;
 118     timer->ID        = timerID;
 119
 120     /*
 121      * When will the time out happen (in terms of window's timer)
 122      */
 123     timer->TriggerTime = fgElapsedTime() + timeOut;
 124
 125     /*
 126      * Have the new hook attached to the current window
 127      */
 128     fgListAppend( &fgState.Timers, &timer->Node );
 129 }
 130
 131 /*
 132  * Sets the Visibility callback for the current window.
 133  *
 134  * I had to peer to GLUT sources to clean up the mess.
 135  * Can anyone please explain me what is going on here?!?
 136  */
 137 static void fghVisibility( int status )
 138 {
 139     freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Window != NULL );
 140     freeglut_return_if_fail( fgStructure.Window->Callbacks.Visibility != NULL );
 141
 142     if( status == GLUT_HIDDEN  || status == GLUT_FULLY_COVERED )
 143         fgStructure.Window->Callbacks.Visibility( GLUT_NOT_VISIBLE );
 144     else
 145         fgStructure.Window->Callbacks.Visibility( GLUT_VISIBLE );
 146 }
 147
 148 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 149 {
 150     SET_CALLBACK( Visibility );
 151
 152     if( callback )
 153         glutWindowStatusFunc( fghVisibility );
 154     else
 155         glutWindowStatusFunc( NULL );
 156 }
 157
 158 /*
 159  * Sets the keyboard key release callback for the current window
 160  */
 161 void FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int ) )
 162 {
 163     SET_CALLBACK( KeyboardUp );
 164 }
 165
 166 /*
 167  * Sets the special key release callback for the current window
 168  */
 169 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
 170 {
 171     SET_CALLBACK( SpecialUp );
 172 }
 173
 174 /*
 175  * Sets the joystick callback and polling rate for the current window
 176  */
 177 void FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int ), int pollInterval )
 178 {
 179     SET_CALLBACK( Joystick );
 180
 181     freeglut_return_if_fail( fgStructure.Window != NULL );
 182
 183     /*
 184      * Do not forget setting the joystick poll rate
 185      */
 186     fgStructure.Window->State.JoystickPollRate = pollInterval;
 187
 188     /*
 189      * Make sure the joystick polling routine gets called as early as possible:
 190      */
 191     fgStructure.Window->State.JoystickLastPoll =
 192         fgElapsedTime() - fgStructure.Window->State.JoystickPollRate;
 193
 194     if( fgStructure.Window->State.JoystickLastPoll < 0 )
 195         fgStructure.Window->State.JoystickLastPoll = 0;
 196 }
 197
 198 /*
 199  * Sets the mouse callback for the current window
 200  */
 201 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
 202 {
 203     SET_CALLBACK( Mouse );
 204 }
 205
 206 /*
 207  * Sets the mouse motion callback for the current window (one or more buttons are pressed)
 208  */
 209 void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
 210 {
 211     SET_CALLBACK( Motion );
 212 }
 213
 214 /*
 215  * Sets the passive mouse motion callback for the current window (no mouse buttons are pressed)
 216  */
 217 void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
 218 {
 219     SET_CALLBACK( Passive );
 220 }
 221
 222 /*
 223  * Window mouse entry/leave callback
 224  */
 225 void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
 226 {
 227     SET_CALLBACK( Entry );
 228 }
 229
 230 /*
 231  * Window destruction callbacks
 232  */
 233 void FGAPIENTRY glutCloseFunc( void (* callback)( void ) )
 234 {
 235     SET_CALLBACK( Destroy );
 236 }
 237
 238 void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) )
 239 {
 240     glutCloseFunc( callback );
 241 }
 242
 243 /* A. Donev: Destruction callback for menus */
 244 void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
 245 {
 246    if( fgStructure.Menu == NULL ) return;
 247    fgStructure.Menu->Destroy = callback;
 248 }
 249
 250 /*
 251  * Deprecated version of glutMenuStatusFunc callback setting method
 252  */
 253 void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
 254 {
 255     freeglut_assert_ready;
 256
 257     fgState.MenuStateCallback = callback;
 258 }
 259
 260 /*
 261  * Sets the global menu status callback for the current window
 262  */
 263 void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
 264 {
 265     freeglut_assert_ready;
 266
 267     fgState.MenuStatusCallback = callback;
 268 }
 269
 270 /*
 271  * Sets the overlay display callback for the current window
 272  */
 273 void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
 274 {
 275     SET_CALLBACK( OverlayDisplay );
 276 }
 277
 278 /*
 279  * Sets the window status callback for the current window
 280  */
 281 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
 282 {
 283     SET_CALLBACK( WindowStatus );
 284 }
 285
 286 /*
 287  * Sets the spaceball motion callback for the current window
 288  */
 289 void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
 290 {
 291     SET_CALLBACK( SpaceMotion );
 292 }
 293
 294 /*
 295  * Sets the spaceball rotate callback for the current window
 296  */
 297 void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
 298 {
 299     SET_CALLBACK( SpaceRotation );
 300 }
 301
 302 /*
 303  * Sets the spaceball button callback for the current window
 304  */
 305 void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
 306 {
 307     SET_CALLBACK( SpaceButton );
 308 }
 309
 310 /*
 311  * Sets the button box callback for the current window
 312  */
 313 void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
 314 {
 315     SET_CALLBACK( ButtonBox );
 316 }
 317
 318 /*
 319  * Sets the dials box callback for the current window
 320  */
 321 void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
 322 {
 323     SET_CALLBACK( Dials );
 324 }
 325
 326 /*
 327  * Sets the tablet motion callback for the current window
 328  */
 329 void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
 330 {
 331     SET_CALLBACK( TabletMotion );
 332 }
 333
 334 /*
 335  * Sets the tablet buttons callback for the current window
 336  */
 337 void FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) )
 338 {
 339     SET_CALLBACK( TabletButton );
 340 }
 341
 342 /*** END OF FILE ***/