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     if (!timer)
 114         fgError ("Fatal error: "
 115             "Memory allocation failure in glutTimerFunc()\n");
 116
 117     /*
 118      * Remember the callback address and timer hook's ID
 119      */
 120     timer->Callback  = callback;
 121     timer->ID        = timerID;
 122
 123     /*
 124      * When will the time out happen (in terms of window's timer)
 125      */
 126     timer->TriggerTime = fgElapsedTime() + timeOut;
 127
 128     /*
 129      * Have the new hook attached to the current window
 130      */
 131     fgListAppend( &fgState.Timers, &timer->Node );
 132 }
 133
 134 /*
 135  * Sets the Visibility callback for the current window.
 136  *
 137  * I had to peer to GLUT sources to clean up the mess.
 138  * Can anyone please explain me what is going on here?!?
 139  */
 140 static void fghVisibility( int status )
 141 {
 142     freeglut_assert_ready;
 143     freeglut_return_if_fail( fgStructure.Window != NULL );
 144     freeglut_return_if_fail( fgStructure.Window->Callbacks.Visibility != NULL );
 145
 146     if( status == GLUT_HIDDEN  || status == GLUT_FULLY_COVERED )
 147         fgStructure.Window->Callbacks.Visibility( GLUT_NOT_VISIBLE );
 148     else
 149         fgStructure.Window->Callbacks.Visibility( GLUT_VISIBLE );
 150 }
 151
 152 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 153 {
 154     SET_CALLBACK( Visibility );
 155
 156     if( callback )
 157         glutWindowStatusFunc( fghVisibility );
 158     else
 159         glutWindowStatusFunc( NULL );
 160 }
 161
 162 /*
 163  * Sets the keyboard key release callback for the current window
 164  */
 165 void FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int ) )
 166 {
 167     SET_CALLBACK( KeyboardUp );
 168 }
 169
 170 /*
 171  * Sets the special key release callback for the current window
 172  */
 173 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
 174 {
 175     SET_CALLBACK( SpecialUp );
 176 }
 177
 178 /*
 179  * Sets the joystick callback and polling rate for the current window
 180  */
 181 void FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int ), int pollInterval )
 182 {
 183     SET_CALLBACK( Joystick );
 184
 185     freeglut_return_if_fail( fgStructure.Window != NULL );
 186
 187     /*
 188      * Do not forget setting the joystick poll rate
 189      */
 190     fgStructure.Window->State.JoystickPollRate = pollInterval;
 191
 192     /*
 193      * Make sure the joystick polling routine gets called as early as possible:
 194      */
 195     fgStructure.Window->State.JoystickLastPoll =
 196         fgElapsedTime() - fgStructure.Window->State.JoystickPollRate;
 197
 198     if( fgStructure.Window->State.JoystickLastPoll < 0 )
 199         fgStructure.Window->State.JoystickLastPoll = 0;
 200 }
 201
 202 /*
 203  * Sets the mouse callback for the current window
 204  */
 205 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
 206 {
 207     SET_CALLBACK( Mouse );
 208 }
 209
 210 /*
 211  * Sets the mouse motion callback for the current window (one or more buttons are pressed)
 212  */
 213 void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
 214 {
 215     SET_CALLBACK( Motion );
 216 }
 217
 218 /*
 219  * Sets the passive mouse motion callback for the current window (no mouse buttons are pressed)
 220  */
 221 void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
 222 {
 223     SET_CALLBACK( Passive );
 224 }
 225
 226 /*
 227  * Window mouse entry/leave callback
 228  */
 229 void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
 230 {
 231     SET_CALLBACK( Entry );
 232 }
 233
 234 /*
 235  * Window destruction callbacks
 236  */
 237 void FGAPIENTRY glutCloseFunc( void (* callback)( void ) )
 238 {
 239     SET_CALLBACK( Destroy );
 240 }
 241
 242 void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) )
 243 {
 244     glutCloseFunc( callback );
 245 }
 246
 247 /* A. Donev: Destruction callback for menus */
 248 void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
 249 {
 250    if( fgStructure.Menu == NULL ) return;
 251    fgStructure.Menu->Destroy = callback;
 252 }
 253
 254 /*
 255  * Deprecated version of glutMenuStatusFunc callback setting method
 256  */
 257 void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
 258 {
 259     freeglut_assert_ready;
 260
 261     fgState.MenuStateCallback = callback;
 262 }
 263
 264 /*
 265  * Sets the global menu status callback for the current window
 266  */
 267 void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
 268 {
 269     freeglut_assert_ready;
 270
 271     fgState.MenuStatusCallback = callback;
 272 }
 273
 274 /*
 275  * Sets the overlay display callback for the current window
 276  */
 277 void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
 278 {
 279     SET_CALLBACK( OverlayDisplay );
 280 }
 281
 282 /*
 283  * Sets the window status callback for the current window
 284  */
 285 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
 286 {
 287     SET_CALLBACK( WindowStatus );
 288 }
 289
 290 /*
 291  * Sets the spaceball motion callback for the current window
 292  */
 293 void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
 294 {
 295     SET_CALLBACK( SpaceMotion );
 296 }
 297
 298 /*
 299  * Sets the spaceball rotate callback for the current window
 300  */
 301 void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
 302 {
 303     SET_CALLBACK( SpaceRotation );
 304 }
 305
 306 /*
 307  * Sets the spaceball button callback for the current window
 308  */
 309 void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
 310 {
 311     SET_CALLBACK( SpaceButton );
 312 }
 313
 314 /*
 315  * Sets the button box callback for the current window
 316  */
 317 void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
 318 {
 319     SET_CALLBACK( ButtonBox );
 320 }
 321
 322 /*
 323  * Sets the dials box callback for the current window
 324  */
 325 void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
 326 {
 327     SET_CALLBACK( Dials );
 328 }
 329
 330 /*
 331  * Sets the tablet motion callback for the current window
 332  */
 333 void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
 334 {
 335     SET_CALLBACK( TabletMotion );
 336 }
 337
 338 /*
 339  * Sets the tablet buttons callback for the current window
 340  */
 341 void FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) )
 342 {
 343     SET_CALLBACK( TabletButton );
 344 }
 345
 346 /*** END OF FILE ***/