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