src/lib/elm_animator.c

   1 #include <Elementary.h>
   2
   3 /**
   4  * @addtogroup Animator Animator
   5  *
   6  * Support basic animation functions for Evas_Object
   7 */
   8 /*
   9 static const float _in_out_table[181] = {
  10 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,
  11 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,
  12 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,
  13 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,
  14 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,
  15 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,
  16 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,
  17 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,
  18 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,
  19 0.998888, 0.999228, 0.999506, 0.999722, 0.999877, 0.999969, 1 };
  20
  21 static const float _in_table[181] = {
  22 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,
  23 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,
  24 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,
  25 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,
  26 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,
  27 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,
  28 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,
  29 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,
  30 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,
  31 0.65578, 0.671329, 0.68775, 0.705189, 0.723838, 0.743962, 0.76594, 0.790356, 0.818188, 0.851343, 0.894737, 1 };
  32
  33 static const float _out_table[181] = {
  34 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,
  35 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,
  36 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,
  37 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,
  38 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,
  39 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,
  40 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,
  41 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,
  42 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 };
  43 */
  44
  45 struct _Animator
  46 {
  47    Evas_Object *parent;
  48    Ecore_Animator *animator;
  49    double begin_time;
  50    double cur_time;
  51    double duration;
  52    unsigned int repeat_cnt;
  53    unsigned int cur_repeat_cnt;
  54    double (*curve_op) (const double);
  55    void (*animator_op) (void *, Elm_Animator *, const double);
  56    void *animator_arg;
  57    void (*completion_op) (void *);
  58    void *completion_arg;
  59    Eina_Bool auto_reverse:1;
  60    Eina_Bool on_animating:1;
  61 };
  62
  63 static double _animator_curve_linear(const double frame);
  64
  65 static double _animator_curve_in_out(const double frame);
  66
  67 static double _animator_curve_in(const double frame);
  68
  69 static double _animator_curve_out(const double frame);
  70
  71 static unsigned int _animator_compute_reverse_repeat_count(unsigned int cnt);
  72
  73 static unsigned int _animator_compute_no_reverse_repeat_count(unsigned int cnt);
  74
  75 static int _animator_animate_cb(void *data);
  76
  77 static void _delete_animator(Elm_Animator * animator);
  78
  79 static unsigned int
  80 _animator_compute_reverse_repeat_count(unsigned int cnt)
  81 {
  82    return ((cnt + 1) * 2) - 1;
  83 }
  84
  85 static unsigned int
  86 _animator_compute_no_reverse_repeat_count(unsigned int cnt)
  87 {
  88    return cnt / 2;
  89 }
  90
  91 static double
  92 _animator_curve_linear(const double frame)
  93 {
  94    return frame;
  95 }
  96
  97 static double
  98 _animator_curve_in_out(const double frame)
  99 {
 100    if (frame < 0.5)
 101       return _animator_curve_out(frame * 2) * 0.5;
 102    else
 103       return _animator_curve_in(frame * 2 - 1) * 0.5 + 0.5;
 104 }
 105
 106 static double
 107 _animator_curve_in(const double frame)
 108 {
 109    return sqrt(1 - pow(frame - 1, 2));
 110 }
 111
 112 static double
 113 _animator_curve_out(const double frame)
 114 {
 115    return 1 - sqrt(1 - pow(frame, 2));
 116 }
 117
 118 static void
 119 _delete_animator(Elm_Animator * animator)
 120 {
 121    if (animator->animator)
 122      {
 123         ecore_animator_del(animator->animator);
 124         animator->animator = NULL;
 125      }
 126 }
 127
 128 static int
 129 _animator_animate_cb(void *data)
 130 {
 131    Elm_Animator *animator = (Elm_Animator *) data;
 132
 133    animator->cur_time = ecore_loop_time_get();
 134    double elapsed_time = animator->cur_time - animator->begin_time;
 135
 136    //TODO: HOW TO MAKE IT PRECIOUS TIME? -> Use Interpolation!!
 137    if (elapsed_time > animator->duration)
 138       elapsed_time = animator->duration;
 139
 140    float frame = animator->curve_op(elapsed_time / animator->duration);
 141
 142    //Reverse?
 143    if (animator->auto_reverse == EINA_TRUE)
 144      {
 145         if (animator->cur_repeat_cnt % 2 == 0)
 146            frame = 1 - frame;
 147      }
 148
 149    if (animator->duration > 0)
 150       animator->animator_op(animator->animator_arg, animator, frame);
 151
 152    //Not end. Keep going.
 153    if (elapsed_time < animator->duration)
 154       return ECORE_CALLBACK_RENEW;
 155
 156    //Repeat and reverse and time done!
 157    if (animator->cur_repeat_cnt == 0)
 158      {
 159         animator->on_animating = EINA_FALSE;
 160         _delete_animator(animator);
 161         if (animator->completion_op)
 162            animator->completion_op(animator->completion_arg);
 163         return ECORE_CALLBACK_CANCEL;
 164      }
 165
 166    //Repeat Case
 167    --animator->cur_repeat_cnt;
 168    animator->begin_time = ecore_loop_time_get();
 169
 170    return ECORE_CALLBACK_RENEW;
 171 }
 172
 173 /**
 174  * Get the value of reverse mode.
 175  *
 176  * @param animator Animator object
 177  * @return EINA_TRUE is reverse mode
 178  *
 179  * @ingroup Animator
 180  */
 181 EAPI Eina_Bool
 182 elm_animator_auto_reverse_get(Elm_Animator * animator)
 183 {
 184    if (!animator)
 185       return EINA_FALSE;
 186    return animator->auto_reverse;
 187 }
 188
 189 /**
 190  * Get the value of repeat count.
 191  *
 192  * @param animator Animator object
 193  * @return Repeat count
 194  *
 195  * @ingroup Animator
 196  */
 197 EAPI unsigned int
 198 elm_animator_repeat_get(Elm_Animator * animator)
 199 {
 200    if (!animator)
 201       return EINA_FALSE;
 202    return animator->repeat_cnt;
 203 }
 204
 205 /**
 206  * Set auto reverse function.
 207  *
 208  * @param animator Animator object
 209  * @param reverse Reverse or not
 210  *
 211  * @ingroup Animator
 212  */
 213 EAPI void
 214 elm_animator_auto_reverse_set(Elm_Animator * animator, Eina_Bool reverse)
 215 {
 216    if (!animator)
 217       return;
 218    if (animator->auto_reverse == reverse)
 219       return;
 220    animator->auto_reverse = reverse;
 221    if (reverse == EINA_TRUE)
 222       animator->repeat_cnt =
 223          _animator_compute_reverse_repeat_count(animator->repeat_cnt);
 224    else
 225       animator->repeat_cnt =
 226          _animator_compute_no_reverse_repeat_count(animator->repeat_cnt);
 227 }
 228
 229 /**
 230  * Set the animation acceleration style.
 231  *
 232  * @param animator Animator object
 233  * @param cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
 234  *
 235  * @ingroup Animator
 236  */
 237 EAPI void
 238 elm_animator_curve_style_set(Elm_Animator * animator,
 239                              Elm_Animator_Curve_Style cs)
 240 {
 241    if (!animator)
 242       return;
 243
 244    switch (cs)
 245      {
 246      case ELM_ANIMATOR_CURVE_LINEAR:
 247         animator->curve_op = _animator_curve_linear;
 248         break;
 249      case ELM_ANIMATOR_CURVE_IN_OUT:
 250         animator->curve_op = _animator_curve_in_out;
 251         break;
 252      case ELM_ANIMATOR_CURVE_IN:
 253         animator->curve_op = _animator_curve_in;
 254         break;
 255      case ELM_ANIMATOR_CURVE_OUT:
 256         animator->curve_op = _animator_curve_out;
 257         break;
 258      default:
 259         animator->curve_op = _animator_curve_linear;
 260         break;
 261      }
 262 }
 263
 264 /**
 265  * Set the operation duration.
 266  *
 267  * @param animator Animator object
 268  * @param duration Duration in second
 269  *
 270  * @ingroup Animator
 271  */
 272 EAPI void
 273 elm_animator_duration_set(Elm_Animator * animator, const double duration)
 274 {
 275    if (!animator)
 276       return;
 277    if (animator->on_animating == EINA_TRUE)
 278       return;
 279    animator->duration = duration;
 280 }
 281
 282 /**
 283  * Set the callback function for animator operation.
 284  *
 285  * @param animator Animator object
 286  * @param op Callback function pointer
 287  * @param data Callback function user argument
 288  *
 289  * @ingroup Animator
 290  */
 291 EAPI void
 292 elm_animator_operation_callback_set(Elm_Animator * animator,
 293                                     void (*op) (void *, Elm_Animator *,
 294                                                 const double), void *data)
 295 {
 296    if (!animator)
 297       return;
 298    if (animator->on_animating == EINA_TRUE)
 299       return;
 300    animator->animator_op = op;
 301    animator->animator_arg = data;
 302 }
 303
 304 /**
 305  * Add new animator.
 306  *
 307  * @param parent Parent object
 308  * @return animator object
 309  *
 310  * @ingroup Animator
 311  */
 312 EAPI Elm_Animator *
 313 elm_animator_add(Evas_Object * parent)
 314 {
 315    if (!parent)
 316       return NULL;
 317    Elm_Animator *animator = calloc(1, sizeof(Elm_Animator));
 318
 319    if (!animator)
 320       return NULL;
 321    animator->parent = parent;
 322    elm_animator_auto_reverse_set(animator, EINA_FALSE);
 323    elm_animator_curve_style_set(animator, ELM_ANIMATOR_CURVE_LINEAR);
 324    return animator;
 325 }
 326
 327 /**
 328  * Get the status for the animator operation.
 329  *
 330  * @param animator Animator object
 331  * @return EINA_TRUE is animator is operating.
 332  *
 333  * @ingroup Animator
 334  */
 335 EAPI Eina_Bool
 336 elm_animator_operating_get(Elm_Animator * animator)
 337 {
 338    if (!animator)
 339       return EINA_FALSE;
 340    return animator->on_animating;
 341 }
 342
 343 /**
 344  * Delete animator.
 345  *
 346  * @param animator Animator object
 347  *
 348  * @ingroup Animator
 349  */
 350 EAPI void
 351 elm_animator_del(Elm_Animator * animator)
 352 {
 353    if (!animator)
 354       return;
 355    _delete_animator(animator);
 356    free(animator);
 357 }
 358
 359 /**
 360  * Set the callback function for the animator end.
 361  *
 362  * @param  animator Animator object
 363  * @param  op Callback function pointer
 364  * @param  data Callback function user argument
 365  *
 366  * @ingroup Animator
 367  */
 368 EAPI void
 369 elm_animator_completion_callback_set(Elm_Animator * animator,
 370                                      void (*op) (void *), void *data)
 371 {
 372    if (!animator)
 373       return NULL;
 374    if (animator->on_animating == EINA_TRUE)
 375       return NULL;
 376    animator->completion_op = op;
 377    animator->completion_arg = data;
 378 }
 379
 380 /**
 381  * Stop animator.
 382  *
 383  * @param animator Animator object
 384  *
 385  * @ingroup Animator
 386  */
 387 EAPI void
 388 elm_animator_stop(Elm_Animator * animator)
 389 {
 390    if (!animator)
 391       return NULL;
 392    animator->on_animating = EINA_FALSE;
 393    _delete_animator(animator);
 394 }
 395
 396 /**
 397  * Set the animator repeat count.
 398  *
 399  * @param  animator Animator object
 400  * @param  repeat_cnt Repeat count
 401  *
 402  * @ingroup Animator
 403  */
 404 EAPI void
 405 elm_animator_repeat_set(Elm_Animator * animator, const unsigned int repeat_cnt)
 406 {
 407    if (!animator)
 408       return NULL;
 409    if (animator->auto_reverse == EINA_FALSE)
 410       animator->repeat_cnt = repeat_cnt;
 411    else
 412       animator->repeat_cnt = _animator_compute_reverse_repeat_count(repeat_cnt);
 413 }
 414
 415 /**
 416  * Animate now.
 417  *
 418  * @param animator Animator object
 419  *
 420  * @ingroup Animator
 421  */
 422 EAPI void
 423 elm_animator_animate(Elm_Animator * animator)
 424 {
 425    if (!animator)
 426       return NULL;
 427    if (!animator->animator_op)
 428       return NULL;
 429    animator->begin_time = ecore_loop_time_get();
 430    animator->on_animating = EINA_TRUE;
 431    animator->cur_repeat_cnt = animator->repeat_cnt;
 432    if (!animator->animator)
 433       animator->animator = ecore_animator_add(_animator_animate_cb, animator);
 434    if (!animator->animator)
 435       animator->on_animating = EINA_FALSE;
 436 }