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