From: Hermet Park <hermetpark@gmail.com>
Date: Mon, 25 Feb 2019 04:52:40 +0000 (+0900)
Subject: efl_ui_animation_view: replace naming, keyframe to progress.
X-Git-Tag: accepted/tizen/unified/20190225.232721~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=69875e2e51ade7ac7cf54e03fb25a78cc6bcc5f6;p=platform%2Fupstream%2Fefl.git

efl_ui_animation_view: replace naming, keyframe to progress.

To make consistency with Xamarin-Lottie interfaces,
here replace the api. Progress is more clear to understand.

Change-Id: If5afb780353bfbce5151c83ef4aa980f32f7dd09
---

diff --git a/src/lib/elementary/efl_ui_animation_view.c b/src/lib/elementary/efl_ui_animation_view.c
index 174117f..4d6c939 100644
--- a/src/lib/elementary/efl_ui_animation_view.c
+++ b/src/lib/elementary/efl_ui_animation_view.c
@@ -132,8 +132,8 @@ _transit_del_cb(Elm_Transit_Effect *effect, Elm_Transit *transit)
 {
    Efl_Ui_Animation_View_Data *pd = (Efl_Ui_Animation_View_Data *) effect;
 
-   if ((pd->state == EFL_UI_ANIMATION_VIEW_STATE_PLAY && pd->keyframe == 1) ||
-       (pd->state == EFL_UI_ANIMATION_VIEW_STATE_PLAY_BACK && pd->keyframe == 0))
+   if ((pd->state == EFL_UI_ANIMATION_VIEW_STATE_PLAY && pd->progress == 1) ||
+       (pd->state == EFL_UI_ANIMATION_VIEW_STATE_PLAY_BACK && pd->progress == 0))
      evas_object_smart_callback_call(pd->obj, SIG_PLAY_DONE, NULL);
 
    if (pd->transit != transit) return;
@@ -146,7 +146,7 @@ _transit_del_cb(Elm_Transit_Effect *effect, Elm_Transit *transit)
    if (prev_state != EFL_UI_ANIMATION_VIEW_STATE_STOP)
      {
         evas_object_smart_callback_call(pd->obj, SIG_PLAY_STOP, NULL);
-        pd->keyframe = 0;
+        pd->progress = 0;
      }
 }
 
@@ -169,7 +169,7 @@ _transit_cb(Elm_Transit_Effect *effect, Elm_Transit *transit, double progress)
      }
    else pd->state = EFL_UI_ANIMATION_VIEW_STATE_PLAY;
 
-   pd->keyframe = progress;
+   pd->progress = progress;
    int minframe = (pd->frame_cnt - 1) * pd->min_progress;
    int maxframe = (pd->frame_cnt - 1) * pd->max_progress;
    evas_object_vg_animated_frame_set(pd->vg, (int)((maxframe - minframe) * progress) + minframe);
@@ -267,7 +267,7 @@ _ready_play(Efl_Ui_Animation_View_Data *pd)
         elm_transit_object_add(transit, pd->vg);
         if (pd->auto_repeat) elm_transit_repeat_times_set(transit, -1);
         elm_transit_effect_add(transit, _transit_cb, pd, _transit_del_cb);
-        elm_transit_progress_value_set(transit, pd->keyframe);
+        elm_transit_progress_value_set(transit, pd->progress);
         elm_transit_objects_final_state_keep_set(transit, EINA_TRUE);
         pd->transit = transit;
         if (pd->min_progress != 0.0 || pd->max_progress != 1.0)
@@ -287,7 +287,7 @@ _efl_ui_animation_view_efl_file_file_set(Eo *obj EINA_UNUSED, Efl_Ui_Animation_V
 
    if (pd->file) eina_stringshare_del(pd->file);
    pd->file = eina_stringshare_add(file);
-   pd->keyframe = 0;
+   pd->progress = 0;
 
    _sizing_eval(pd);
 
@@ -407,7 +407,7 @@ _efl_ui_animation_view_play(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd)
    if (pd->state == EFL_UI_ANIMATION_VIEW_STATE_STOP)
      _transit_go_facade(pd);
    else if (rewind)
-     elm_transit_progress_value_set(pd->transit, pd->keyframe);
+     elm_transit_progress_value_set(pd->transit, pd->progress);
 
    return EINA_TRUE;
 }
@@ -422,7 +422,7 @@ _efl_ui_animation_view_stop(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd)
      return EINA_FALSE;
 
    evas_object_vg_animated_frame_set(pd->vg, 0);
-   pd->keyframe = 0;
+   pd->progress = 0;
    pd->state = EFL_UI_ANIMATION_VIEW_STATE_STOP;
    evas_object_smart_callback_call(pd->obj, SIG_PLAY_STOP, NULL);
    elm_transit_del(pd->transit);
@@ -487,7 +487,7 @@ _efl_ui_animation_view_play_back(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data
    if (pd->state == EFL_UI_ANIMATION_VIEW_STATE_STOP)
      _transit_go_facade(pd);
    else if (rewind)
-     elm_transit_progress_value_set(pd->transit, 1 - pd->keyframe);
+     elm_transit_progress_value_set(pd->transit, 1 - pd->progress);
 
    return EINA_TRUE;
 }
@@ -505,42 +505,42 @@ _efl_ui_animation_view_speed_set(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data
 }
 
 EOLIAN static void
-_efl_ui_animation_view_keyframe_set(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd, double keyframe)
+_efl_ui_animation_view_progress_set(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd, double progress)
 {
-   if (keyframe < 0) keyframe = 0;
-   else if (keyframe > 1) keyframe = 1;
-   if (pd->keyframe == keyframe) return;
+   if (progress < 0) progress = 0;
+   else if (progress > 1) progress = 1;
+   if (pd->progress == progress) return;
 
-   pd->keyframe = keyframe;
+   pd->progress = progress;
 
    if (pd->frame_cnt > 0)
-     evas_object_vg_animated_frame_set(pd->vg, (int) ((pd->frame_cnt - 1) * keyframe));
+     evas_object_vg_animated_frame_set(pd->vg, (int) ((pd->frame_cnt - 1) * progress));
 
    if (pd->transit)
      {
         if (pd->play_back)
-          elm_transit_progress_value_set(pd->transit, 1 - keyframe);
+          elm_transit_progress_value_set(pd->transit, 1 - progress);
         else
-          elm_transit_progress_value_set(pd->transit, keyframe);
+          elm_transit_progress_value_set(pd->transit, progress);
      }
 }
 
 EOLIAN static double
-_efl_ui_animation_view_keyframe_get(const Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd)
+_efl_ui_animation_view_progress_get(const Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd)
 {
-   return pd->keyframe;
+   return pd->progress;
 }
 
 EOLIAN static void
 _efl_ui_animation_view_frame_set(Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd, int frame_num)
 {
-   efl_ui_animation_view_keyframe_set(obj, (double) frame_num / (double) (evas_object_vg_animated_frame_count_get(pd->vg) - 1));
+   efl_ui_animation_view_progress_set(obj, (double) frame_num / (double) (evas_object_vg_animated_frame_count_get(pd->vg) - 1));
 }
 
 EOLIAN static int
 _efl_ui_animation_view_frame_get(const Eo *obj EINA_UNUSED, Efl_Ui_Animation_View_Data *pd)
 {
-   return (int) ((double) (evas_object_vg_animated_frame_count_get(pd->vg) - 1) * pd->keyframe);
+   return (int) ((double) (evas_object_vg_animated_frame_count_get(pd->vg) - 1) * pd->progress);
 }
 
 EOLIAN static double
@@ -671,6 +671,19 @@ elm_animation_view_state_get(Elm_Animation_View *obj)
    return efl_ui_animation_view_state_get(obj);
 }
 
+EINA_DEPRECATED void
+elm_animation_view_keyframe_set(Eo *obj, double keyframe)
+{
+   efl_ui_animation_view_progress_set(obj, keyframe);
+}
+
+EINA_DEPRECATED double
+elm_animation_view_keyframe_get(const Eo *obj)
+{
+   return efl_ui_animation_view_progress_get(obj);
+}
+
+
 /* Internal EO APIs and hidden overrides */
 
 #define EFL_UI_ANIMATION_VIEW_EXTRA_OPS \
diff --git a/src/lib/elementary/efl_ui_animation_view.eo b/src/lib/elementary/efl_ui_animation_view.eo
index 1ecc3f5..f2d57f2 100644
--- a/src/lib/elementary/efl_ui_animation_view.eo
+++ b/src/lib/elementary/efl_ui_animation_view.eo
@@ -88,13 +88,13 @@ class Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View, Efl.F
             frame_duration: double; [[duration time in the seconds]]
          }
       }
-      @property keyframe {
-         [[Set current keyframe position of animation view.
+      @property progress {
+         [[Set current progress position of animation view.
 
            When you required to jump on a certain frame instantly,
-           you can change current keyframe by using this API.
+           you can change current position by using this API.
 
-           Warning: The range of keyframe is 0 ~ 1.
+           Warning: The range of progress is 0 ~ 1.
 
            \@since_tizen 5.5
          ]]
@@ -103,7 +103,7 @@ class Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View, Efl.F
          get {
          }
          values {
-            keyframe: double; [[Keyframe position. Value must be 0 ~ 1.]]
+            progress: double; [[Progress position. Value must be 0 ~ 1.]]
          }
       }
       @property frame {
diff --git a/src/lib/elementary/efl_ui_animation_view_legacy.h b/src/lib/elementary/efl_ui_animation_view_legacy.h
index 29df2d0..6412848 100644
--- a/src/lib/elementary/efl_ui_animation_view_legacy.h
+++ b/src/lib/elementary/efl_ui_animation_view_legacy.h
@@ -73,4 +73,8 @@ EAPI Eina_Bool        elm_animation_view_file_set(Elm_Animation_View *obj, const
  */
 EAPI Elm_Animation_View_State elm_animation_view_state_get(Elm_Animation_View *obj);
 
+//Will be removed soon. See: elm_animation_view_progress_set(), elm_animation_view_progress_get()
+EINA_DEPRECATED EAPI void elm_animation_view_keyframe_set(Elm_Animation_View *obj, double keyframe);
+EINA_DEPRECATED EAPI double elm_animation_view_keyframe_get(const Elm_Animation_View *obj);
+
 #include "efl_ui_animation_view.eo.legacy.h"
diff --git a/src/lib/elementary/efl_ui_animation_view_private.h b/src/lib/elementary/efl_ui_animation_view_private.h
index 183d076..2dec04d 100644
--- a/src/lib/elementary/efl_ui_animation_view_private.h
+++ b/src/lib/elementary/efl_ui_animation_view_private.h
@@ -14,7 +14,7 @@ struct _Efl_Ui_Animation_View_Data
    Elm_Transit *transit;
    Eina_Stringshare *file;
    double speed;
-   double keyframe;
+   double progress;
    double frame_cnt;
    int repeat_times;
    double frame_duration;