src/lib/elm_animator.c

   1 /**
   2  *
   3  * @addtogroup Animator
   4  *
   5  * Animator
   6 */
   7
   8 #include <Elementary.h>
   9
  10
  11
  12 #define ELM_FX_EXCEPTION_ENABLE
  13
  14 #define ELM_FX_NULL_CHECK( obj ) \
  15                      if( ( obj ) == 0 ) \
  16                             return
  17
  18 #define ELM_FX_NULL_CHECK_WITH_RET( obj, ret ) \
  19                    if( ( obj ) == 0 ) \
  20                             return ret
  21
  22
  23 static const float _in_out_table[181] = {
  24 0, 3.08652e-05, 0.000123472, 0.000277855, 0.000494071, 0.000772201, 0.00111235, 0.00151464, 0.00197923, 0.00250628, 0.00309601, 0.00374862, 0.00446438, 0.00524354, 0.00608643, 0.00699335, 0.00796467,
  25 0.00900077, 0.0101021, 0.011269, 0.012502, 0.0138016, 0.0151684, 0.0166028, 0.0181056, 0.0196773, 0.0213187, 0.0230304, 0.0248132, 0.026668, 0.0285955, 0.0305966, 0.0326724, 0.0348238, 0.0370519,
  26 0.0393577, 0.0417424, 0.0442074, 0.0467538, 0.0493831, 0.0520968, 0.0548963, 0.0577834, 0.0607596, 0.063827, 0.0669873, 0.0702427, 0.0735953, 0.0770474, 0.0806015, 0.0842603, 0.0880264, 0.0919029,
  27 0.095893, 0.1, 0.104228, 0.10858, 0.11306, 0.117674,  0.122427, 0.127322,  0.132367, 0.137567, 0.142929, 0.14846, 0.154169, 0.160065, 0.166158, 0.172458, 0.178977,0.18573, 0.192732, 0.2, 0.207554,
  28 0.215417, 0.223615, 0.232178, 0.241144, 0.250556, 0.260466, 0.270939, 0.282055, 0.29392, 0.30667, 0.320495, 0.335664, 0.352594, 0.371981, 0.395178, 0.425672, 0.5, 0.574328, 0.604822, 0.628019,
  29 0.647406, 0.664336, 0.679505, 0.69333, 0.70608, 0.717945, 0.729061, 0.739534, 0.749444, 0.758856, 0.767822, 0.776385, 0.784583, 0.792446, 0.8, 0.807268, 0.81427, 0.821023, 0.827542, 0.833842,
  30 0.839935, 0.845831, 0.85154, 0.857071, 0.862433, 0.867633, 0.872678, 0.877573, 0.882326, 0.88694, 0.89142, 0.895772, 0.9, 0.904107, 0.908097, 0.911974, 0.91574, 0.919398, 0.922953, 0.926405,
  31 0.929757, 0.933013, 0.936173, 0.93924, 0.942217, 0.945104, 0.947903, 0.950617, 0.953246, 0.955793, 0.958258, 0.960642, 0.962948, 0.965176, 0.967328, 0.969403, 0.971405, 0.973332, 0.975187, 0.97697,
  32 0.978681, 0.980323, 0.981894, 0.983397, 0.984832, 0.986198, 0.987498, 0.988731, 0.989898, 0.990999, 0.992035, 0.993007, 0.993914, 0.994756, 0.995536, 0.996251, 0.996904, 0.997494, 0.998021, 0.998485,
  33 0.998888, 0.999228, 0.999506, 0.999722, 0.999877, 0.999969, 1 };
  34
  35
  36 static const float _in_table[181] = {
  37 0, 1.54322e-05, 6.17303e-05, 0.000138899, 0.000246944, 0.000385877, 0.00055571, 0.000756459, 0.000988143, 0.00125078, 0.0015444, 0.00186903, 0.0022247, 0.00261143, 0.00302928, 0.00347827, 0.00395845,
  38 0.00446987, 0.00501256, 0.00558659, 0.00619201, 0.00682887, 0.00749724, 0.00819718, 0.00892875, 0.00969203, 0.0104871, 0.011314, 0.0121729, 0.0130637, 0.0139867, 0.0149419, 0.0159293, 0.0169492,
  39 0.0180015, 0.0190865, 0.0202041, 0.0213546, 0.0225379, 0.0237544, 0.025004, 0.0262869, 0.0276032, 0.0289531, 0.0303367, 0.0317542, 0.0332056, 0.0346912, 0.0362112, 0.0377656, 0.0393546, 0.0409785,
  40 0.0426374, 0.0443314, 0.0460608, 0.0478257, 0.0496265, 0.0514631, 0.0533359, 0.0552451, 0.057191, 0.0591736, 0.0611933, 0.0632503, 0.0653449, 0.0674772, 0.0696476, 0.0718564, 0.0741037, 0.0763899,
  41 0.0787153, 0.0810802, 0.0834849, 0.0859296, 0.0884148, 0.0909407, 0.0935076, 0.0961161, 0.0987663, 0.101459, 0.104194, 0.106971, 0.109793, 0.112658, 0.115567, 0.11852, 0.121519, 0.124564,  0.127654,
  42 0.130791, 0.133975, 0.137206, 0.140485, 0.143813, 0.147191, 0.150618, 0.154095, 0.157623, 0.161203, 0.164835, 0.168521, 0.17226, 0.176053, 0.179901, 0.183806, 0.187767, 0.191786, 0.195863, 0.2,
  43 0.204197, 0.208455, 0.212776, 0.217159, 0.221607, 0.226121, 0.230701, 0.235349, 0.240066, 0.244853, 0.249712, 0.254644, 0.259651, 0.264733, 0.269893, 0.275133, 0.280454, 0.285857, 0.291345, 0.29692,
  44 0.302584, 0.308339, 0.314187, 0.320131, 0.326173, 0.332316, 0.338562, 0.344915, 0.351378, 0.357955, 0.364647, 0.371461, 0.378398, 0.385464, 0.392663, 0.4, 0.40748, 0.415108, 0.42289, 0.430833,
  45 0.438944, 0.447229, 0.455697, 0.464357, 0.473217, 0.482289, 0.491583, 0.501112, 0.51089, 0.520932, 0.531255, 0.541877, 0.552821, 0.56411, 0.575772, 0.587839, 0.600347, 0.61334, 0.626867, 0.640989,
  46 0.65578, 0.671329, 0.68775, 0.705189, 0.723838, 0.743962, 0.76594, 0.790356, 0.818188, 0.851343, 0.894737, 1 };
  47
  48
  49 static const float _out_table[181] = {
  50 0, 0.105263, 0.148657, 0.181812, 0.209644, 0.23406, 0.256038, 0.276162, 0.294811, 0.31225, 0.328671, 0.34422, 0.359011, 0.373133, 0.38666, 0.399653, 0.412161, 0.424228, 0.43589, 0.447179, 0.458123,
  51 0.468745, 0.479068, 0.48911, 0.498888, 0.508417, 0.517711, 0.526783, 0.535643, 0.544303, 0.552771, 0.561056, 0.569167, 0.57711, 0.584892, 0.59252, 0.6, 0.607337, 0.614536, 0.621602, 0.628539, 0.635353,
  52 0.642045, 0.648622, 0.655085, 0.661438, 0.667684, 0.673827, 0.679869, 0.685813, 0.691661, 0.697416, 0.70308, 0.708655, 0.714143, 0.719546, 0.724867, 0.730107, 0.735267, 0.740349, 0.745356, 0.750288,
  53 0.755147, 0.759934, 0.764651, 0.769299, 0.773879, 0.778393, 0.782841, 0.787224, 0.791545, 0.795803, 0.8, 0.804137, 0.808214, 0.812233, 0.816194, 0.820099, 0.823947, 0.82774, 0.831479, 0.835165,
  54 0.838797, 0.842377, 0.845905, 0.849382, 0.852809, 0.856187, 0.859515, 0.862794, 0.866025, 0.869209, 0.872346, 0.875436, 0.878481, 0.88148, 0.884433, 0.887342, 0.890207, 0.893029, 0.895806, 0.898541,
  55 0.901234, 0.903884, 0.906492, 0.909059, 0.911585, 0.91407, 0.916515, 0.91892, 0.921285, 0.92361, 0.925896, 0.928144, 0.930352, 0.932523, 0.934655, 0.93675, 0.938807, 0.940826, 0.942809, 0.944755,
  56 0.946664, 0.948537, 0.950374, 0.952174, 0.953939, 0.955669, 0.957363, 0.959021, 0.960645, 0.962234, 0.963789, 0.965309, 0.966794, 0.968246, 0.969663, 0.971047, 0.972397, 0.973713, 0.974996, 0.976246,
  57 0.977462, 0.978645, 0.979796, 0.980914, 0.981998, 0.983051, 0.984071, 0.985058, 0.986013, 0.986936, 0.987827,0.988686, 0.989513, 0.990308, 0.991071, 0.991803, 0.992503, 0.993171, 0.993808, 0.994413,
  58 0.994987, 0.99553, 0.996042, 0.996522, 0.996971, 0.997389, 0.997775, 0.998131, 0.998456,  0.998749, 0.999012, 0.999244, 0.999444, 0.999614, 0.999753, 0.999861, 0.999938, 0.999985, 1 };
  59
  60
  61 struct _animator {
  62
  63         Evas_Object*            parent;
  64         Ecore_Timer*            timer;
  65
  66         double                  begin_time;
  67         double                  cur_time;
  68         double                  duration;
  69         unsigned int            repeat_cnt;
  70         unsigned int            cur_repeat_cnt;
  71
  72         double                  (*curve_op)( const double );
  73
  74         void                    (*animator_op)(void*, Elm_Animator*, const double);
  75         void*                   animator_arg;
  76
  77         void                    (*completion_op)(void*);
  78         void*                   completion_arg;
  79
  80         Eina_Bool               auto_reverse :1;
  81         Eina_Bool               on_animating : 1;
  82
  83 };
  84
  85
  86 inline static double _animator_curve_linear( const double frame );
  87 inline static double _animator_curve_in_out( const double frame );
  88 inline static double _animator_curve_in( const double frame );
  89 inline static double _animator_curve_out( const double frame );
  90 inline static unsigned int _animator_compute_reverse_repeat_count( unsigned int cnt );
  91 inline static unsigned int _animator_compute_no_reverse_repeat_count( unsigned int cnt );
  92 static int _animator_animate_cb( void* data );
  93 inline static void _delete_timer( Elm_Animator* animator );
  94
  95
  96 inline static unsigned int _animator_compute_reverse_repeat_count( unsigned int cnt )
  97 {
  98         return ( ( cnt  + 1 ) << 1 ) - 1;
  99 }
 100
 101 inline static unsigned int _animator_compute_no_reverse_repeat_count( unsigned int cnt )
 102 {
 103         return cnt >> 1;
 104 }
 105
 106 inline static double _animator_curve_linear( const double frame )
 107 {
 108         return frame;
 109 }
 110
 111
 112 inline static double _animator_curve_in_out( const double frame )
 113 {
 114         return _in_out_table[ (int) ( frame * 180 ) ];
 115 }
 116
 117 inline static double _animator_curve_in( const double frame )
 118 {
 119         return  _in_table[ (int) ( frame * 180 ) ];
 120 }
 121
 122 inline static double _animator_curve_out( const double frame )
 123 {
 124         return  _out_table[ (int) ( frame * 180 ) ];
 125
 126 }
 127
 128 inline static void _delete_timer( Elm_Animator* animator )
 129 {
 130         if( animator->timer ) {
 131                 ecore_timer_del( animator->timer );
 132                 animator->timer = NULL;
 133         }
 134 }
 135
 136
 137
 138
 139 static int _animator_animate_cb( void* data )
 140 {
 141         Elm_Animator* animator = (Elm_Animator*) data;
 142
 143         animator->cur_time = ecore_time_get();
 144
 145         double elapsed_time = animator->cur_time - animator->begin_time;
 146
 147         //TODO: HOW TO MAKE IT PRECIOUS TIME? -> Use Interpolation!!
 148         if( elapsed_time > animator->duration ) {
 149                 elapsed_time = animator->duration;
 150         }
 151
 152         float frame = animator->curve_op( elapsed_time / animator->duration );
 153
 154         //Reverse?
 155         if( animator->auto_reverse == EINA_TRUE ) {
 156                 if( animator->cur_repeat_cnt % 2 == 0 ) {
 157                         frame = 1 - frame;
 158                 }
 159         }
 160
 161         if( animator->duration > 0 ) {
 162                 animator->animator_op( animator->animator_arg,
 163                                        animator,
 164                                        frame );
 165         }
 166
 167         //Not end. Keep going.
 168         if( elapsed_time < animator->duration ) {
 169                 return ECORE_CALLBACK_RENEW;
 170         }
 171
 172         //Repeat and reverse and time done!
 173         if( animator->cur_repeat_cnt == 0 ) {
 174
 175                 animator->on_animating = EINA_FALSE;
 176                 _delete_timer( animator );
 177
 178                 if( animator->completion_op ) {
 179                         animator->completion_op( animator->completion_arg );
 180                 }
 181
 182                 return ECORE_CALLBACK_CANCEL;
 183         }
 184
 185         //Repeat Case
 186         --animator->cur_repeat_cnt;
 187         animator->begin_time = ecore_time_get();
 188
 189         return ECORE_CALLBACK_RENEW;
 190
 191 }
 192
 193 /**
 194  * @ingroup Animator
 195  *
 196  * Get the value of reverse mode.
 197  *
 198  * @param  animator      Animator object
 199  * @return               EINA_TRUE is reverse mode
 200  */
 201 inline EAPI Eina_Bool elm_animator_auto_reverse_get( Elm_Animator* animator )
 202 {
 203 #ifdef ELM_FX_EXCEPTION_ENABLE_WITH_RET
 204         ELM_FX_NULL_CHECK( animator, EINA_FALSE );
 205 #endif
 206
 207         return animator->auto_reverse;
 208 }
 209
 210
 211
 212 /**
 213  * @ingroup Animator
 214  *
 215  * Get the value of repeat count.
 216  *
 217  * @param  animator      Animator object
 218  * @return               Repeat count
 219  */
 220 inline EAPI unsigned int elm_animator_repeat_get( Elm_Animator* animator )
 221 {
 222 #ifdef ELM_FX_EXCEPTION_ENABLE_WITH_RET
 223         ELM_FX_NULL_CHECK( animator, EINA_FALSE );
 224 #endif
 225
 226         return animator->repeat_cnt;
 227 }
 228
 229
 230
 231 /**
 232  * @ingroup Animator
 233  *
 234  * Set auto reverse function.
 235  *
 236  * @param  animator      Animator object
 237  * @param  reverse       Reverse or not
 238  */
 239 EAPI void elm_animator_auto_reverse_set( Elm_Animator* animator, Eina_Bool reverse )
 240 {
 241 #ifdef ELM_FX_EXCEPTION_ENABLE
 242         ELM_FX_NULL_CHECK( animator );
 243 #endif
 244         if( animator->auto_reverse == reverse ) {
 245                 return;
 246         }
 247
 248         animator->auto_reverse = reverse;
 249
 250         if( reverse == EINA_TRUE ) {
 251                 animator->repeat_cnt = _animator_compute_reverse_repeat_count( animator->repeat_cnt );
 252         }else {
 253                 animator->repeat_cnt = _animator_compute_no_reverse_repeat_count( animator->repeat_cnt );
 254         }
 255 }
 256
 257
 258
 259 /**
 260  * @ingroup Animator
 261  *
 262  * Set the animation acceleration style.
 263  *
 264  * @param  animator     Animator object
 265  * @param  cs           Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
 266  */
 267 EAPI void elm_animator_curve_style_set( Elm_Animator* animator, Elm_Animator_Curve_Style cs )
 268 {
 269 #ifdef ELM_FX_EXCEPTION_ENABLE
 270         ELM_FX_NULL_CHECK( animator );
 271 #endif
 272
 273         switch( cs ) {
 274
 275                 case ELM_ANIMATOR_CURVE_LINEAR:
 276                         animator->curve_op = _animator_curve_linear;
 277                         break;
 278                 case ELM_ANIMATOR_CURVE_IN_OUT:
 279                         animator->curve_op = _animator_curve_in_out;
 280                         break;
 281                 case ELM_ANIMATOR_CURVE_IN:
 282                         animator->curve_op = _animator_curve_in;
 283                         break;
 284                 case ELM_ANIMATOR_CURVE_OUT:
 285                         animator->curve_op = _animator_curve_out;
 286                         break;
 287                 default:
 288                         animator->curve_op = _animator_curve_linear;
 289                         break;
 290
 291         }
 292 }
 293
 294
 295 /**
 296  * @ingroup Animator
 297  *
 298  * Set the operation duration.
 299  *
 300  * @param  animator     Animator object
 301  * @param  duration     Duration in second
 302  */
 303 inline EAPI void elm_animator_duration_set( Elm_Animator* animator, const double duration )
 304 {
 305 #ifdef ELM_FX_EXCEPTION_ENABLE
 306         ELM_FX_NULL_CHECK( animator );
 307 #endif
 308
 309         if( animator->on_animating == EINA_TRUE ) {
 310                 return ;
 311         }
 312
 313         animator->duration = duration;
 314
 315 #ifdef ELM_FX_EXCEPTION_ENABLE
 316         if( animator->duration < 0 ) {
 317                 animator->duration = 0;
 318         }
 319 #endif
 320
 321 }
 322
 323
 324
 325
 326 /**
 327  * @ingroup Animator
 328  *
 329  * Set the callback function for animator operation.
 330  *
 331  * @param     animator          Animator object
 332  * @param     op                Callback function pointer
 333  * @param     data              Callback function user argument
 334  */
 335 inline EAPI void elm_animator_operation_callback_set( Elm_Animator* animator, void (*op)(void*, Elm_Animator*, const double), void* data )
 336 {
 337 #ifdef ELM_FX_EXCEPTION_ENABLE
 338         ELM_FX_NULL_CHECK( animator );
 339 #endif
 340         if( animator->on_animating == EINA_TRUE ) {
 341                 return ;
 342         }
 343
 344         animator->animator_op = op;
 345         animator->animator_arg = data;
 346 }
 347
 348
 349
 350
 351
 352
 353
 354
 355 /**
 356  * @ingroup Animator
 357  *
 358  * Add new animator.
 359  *
 360  * @param    parent     Parent object
 361  * @return              Animator object
 362  */
 363 EAPI Elm_Animator* elm_animator_add( Evas_Object* parent )
 364 {
 365 #ifdef ELM_FX_EXCEPTION_ENABLE
 366         ELM_FX_NULL_CHECK_WITH_RET( parent, NULL );
 367 #endif
 368
 369         Elm_Animator* animator = calloc( 1, sizeof( Elm_Animator ) );
 370
 371         if( animator == NULL ) {
 372                 fprintf( stderr, "Failed to allocate Elm_Animator!\n" );
 373                 return NULL;
 374         }
 375
 376         animator->parent = parent;
 377         elm_animator_auto_reverse_set( animator, EINA_FALSE );
 378         elm_animator_curve_style_set( animator, ELM_ANIMATOR_CURVE_LINEAR );
 379
 380         return animator;
 381 }
 382
 383
 384
 385
 386 /**
 387  * @ingroup Animator
 388  *
 389  * Get the status for the animator operation.
 390  *
 391  * @param    animator   Animator object
 392  * @return              EINA_TRUE is animator is operating.
 393  */
 394 EAPI Eina_Bool elm_animator_operating_get( Elm_Animator* animator )
 395 {
 396 #ifdef ELM_FX_EXCEPTION_ENABLE
 397         ELM_FX_NULL_CHECK_WITH_RET( animator, EINA_FALSE );
 398 #endif
 399         return animator->on_animating;
 400 }
 401
 402
 403
 404
 405 /**
 406  * @ingroup Animator
 407  *
 408  * Delete animator.
 409  *
 410  * @param    animator   Animator object
 411  */
 412 EAPI void elm_animator_del( Elm_Animator* animator )
 413 {
 414 #ifdef ELM_FX_EXCEPTION_ENABLE
 415         ELM_FX_NULL_CHECK( animator );
 416 #endif
 417         _delete_timer( animator );
 418
 419         free( animator );
 420
 421 }
 422
 423
 424
 425 /**
 426  * @ingroup Animator
 427  *
 428  * Set the callback function for the animator end.
 429  *
 430  * @param    animator   Animator object
 431  * @param    op         Callback function pointer
 432  * @param    data       Callback function user argument
 433  */
 434 EAPI void elm_animator_completion_callback_set( Elm_Animator* animator, void (*op)(void*), void* data )
 435 {
 436 #ifdef ELM_FX_EXCEPTION_ENABLE
 437         ELM_FX_NULL_CHECK( animator );
 438 #endif
 439         if( animator->on_animating == EINA_TRUE ) {
 440                 return ;
 441         }
 442
 443         animator->completion_op = op;
 444         animator->completion_arg = data;
 445 }
 446
 447
 448
 449
 450
 451
 452
 453 /**
 454  * @ingroup Animator
 455  *
 456  * Stop animator.
 457  *
 458  * @param    animator   Animator object
 459  */
 460 EAPI void elm_animator_stop( Elm_Animator* animator )
 461 {
 462 #ifdef ELM_FX_EXCEPTION_ENABLE
 463         ELM_FX_NULL_CHECK( animator );
 464 #endif
 465         animator->on_animating = EINA_FALSE;
 466
 467         _delete_timer( animator );
 468
 469 }
 470
 471
 472 /**
 473  * @ingroup Animator
 474  *
 475  * Set the animator repeat count.
 476  *
 477  * @param    animator   Animator object
 478  * @param    repeat_cnt Repeat count
 479  */
 480 EAPI void elm_animator_repeat_set( Elm_Animator* animator, const unsigned int repeat_cnt )
 481 {
 482 #ifdef ELM_FX_EXCEPTION_ENABLE
 483         ELM_FX_NULL_CHECK( animator );
 484
 485 #endif
 486         if( animator->auto_reverse == EINA_FALSE ) {
 487                 animator->repeat_cnt = repeat_cnt;
 488         }else {
 489                 animator->repeat_cnt = _animator_compute_reverse_repeat_count( repeat_cnt );
 490         }
 491 }
 492
 493
 494 /**
 495  * @ingroup Animator
 496  *
 497  * Animate now.
 498  *
 499  * @param    animator   Animator object
 500  */
 501 EAPI void elm_animator_animate( Elm_Animator* animator )
 502 {
 503 #ifdef ELM_FX_EXCEPTION_ENABLE
 504         ELM_FX_NULL_CHECK( animator );
 505
 506         if( animator->animator_op == NULL ) {
 507                 return ;
 508         }
 509 #endif
 510
 511         animator->begin_time = ecore_time_get();
 512         animator->on_animating = EINA_TRUE;
 513         animator->cur_repeat_cnt = animator->repeat_cnt;
 514
 515         _delete_timer( animator );
 516
 517         animator->timer = ecore_timer_add( 0.0016, _animator_animate_cb, animator );
 518         ecore_timer_interval_set( animator->timer, 0.0016 );
 519
 520         if( animator->timer == NULL ) {
 521                 animator->on_animating = EINA_FALSE;
 522         }
 523
 524 }
 525
 526