3 * @defgroup Transit Transit
6 * Transit is designed to apply various animated transition effects to @c
7 * Evas_Object, such like translation, rotation, etc. For using these
8 * effects, create an @ref Elm_Transit and add the desired transition effects.
10 * Once the effects are added into transit, they will be automatically
11 * managed (their callback will be called until the duration is ended, and
12 * they will be deleted on completion).
16 * Elm_Transit *trans = elm_transit_add();
17 * elm_transit_object_add(trans, obj);
18 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
19 * elm_transit_duration_set(transit, 1);
20 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
21 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22 * elm_transit_repeat_times_set(transit, 3);
25 * Some transition effects are used to change the properties of objects. They
27 * @li @ref elm_transit_effect_translation_add
28 * @li @ref elm_transit_effect_color_add
29 * @li @ref elm_transit_effect_rotation_add
30 * @li @ref elm_transit_effect_wipe_add
31 * @li @ref elm_transit_effect_zoom_add
32 * @li @ref elm_transit_effect_resizing_add
34 * Other transition effects are used to make one object disappear and another
35 * object appear on its old place. These effects are:
37 * @li @ref elm_transit_effect_flip_add
38 * @li @ref elm_transit_effect_resizable_flip_add
39 * @li @ref elm_transit_effect_fade_add
40 * @li @ref elm_transit_effect_blend_add
42 * It's also possible to make a transition chain with @ref
43 * elm_transit_chain_transit_add.
45 * @warning We strongly recommend to use elm_transit just when edje can not do
46 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
47 * animations can be manipulated inside the theme.
50 * @li @ref transit_example_01_explained
51 * @li @ref transit_example_02_explained
52 * @li @ref transit_example_03_c
53 * @li @ref transit_example_04_c
59 * @enum Elm_Transit_Tween_Mode
61 * The type of acceleration used in the transition.
65 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
66 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
67 over time, then decrease again
69 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
71 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
73 } Elm_Transit_Tween_Mode;
76 * @enum Elm_Transit_Effect_Flip_Axis
78 * The axis where flip effect should be applied.
82 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
83 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
84 } Elm_Transit_Effect_Flip_Axis;
87 * @enum Elm_Transit_Effect_Wipe_Dir
89 * The direction where the wipe effect should occur.
93 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
94 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
95 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
96 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
97 } Elm_Transit_Effect_Wipe_Dir;
99 /** @enum Elm_Transit_Effect_Wipe_Type
101 * Whether the wipe effect should show or hide the object.
105 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
107 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
109 } Elm_Transit_Effect_Wipe_Type;
112 * @typedef Elm_Transit
114 * The Transit created with elm_transit_add(). This type has the information
115 * about the objects which the transition will be applied, and the
116 * transition effects that will be used. It also contains info about
117 * duration, number of repetitions, auto-reverse, etc.
119 typedef struct _Elm_Transit Elm_Transit;
120 typedef void Elm_Transit_Effect;
123 * @typedef Elm_Transit_Effect_Transition_Cb
125 * Transition callback called for this effect on each transition iteration.
127 typedef void (*Elm_Transit_Effect_Transition_Cb)(Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
130 * Elm_Transit_Effect_End_Cb
132 * Transition callback called for this effect when the transition is over.
134 typedef void (*Elm_Transit_Effect_End_Cb)(Elm_Transit_Effect *effect, Elm_Transit *transit);
139 * A callback called when the transit is deleted.
141 typedef void (*Elm_Transit_Del_Cb)(void *data, Elm_Transit *transit);
146 * @note Is not necessary to delete the transit object, it will be deleted at
147 * the end of its operation.
148 * @note The transit will start playing when the program enter in the main loop, is not
149 * necessary to give a start to the transit.
151 * @return The transit object.
155 EAPI Elm_Transit *elm_transit_add(void);
158 * Stops the animation and delete the @p transit object.
160 * Call this function if you wants to stop the animation before the duration
161 * time. Make sure the @p transit object is still alive with
162 * elm_transit_del_cb_set() function.
163 * All added effects will be deleted, calling its repective data_free_cb
164 * functions. The function setted by elm_transit_del_cb_set() will be called.
166 * @see elm_transit_del_cb_set()
168 * @param transit The transit object to be deleted.
171 * @warning Just call this function if you are sure the transit is alive.
174 elm_transit_del(Elm_Transit *transit)
178 * Add a new effect to the transit.
180 * @note The cb function and the data are the key to the effect. If you try to
181 * add an already added effect, nothing is done.
182 * @note After the first addition of an effect in @p transit, if its
183 * effect list become empty again, the @p transit will be killed by
184 * elm_transit_del(transit) function.
188 * Elm_Transit *transit = elm_transit_add();
189 * elm_transit_effect_add(transit,
190 * elm_transit_effect_blend_op,
191 * elm_transit_effect_blend_context_new(),
192 * elm_transit_effect_blend_context_free);
195 * @param transit The transit object.
196 * @param transition_cb The operation function. It is called when the
197 * animation begins, it is the function that actually performs the animation.
198 * It is called with the @p data, @p transit and the time progression of the
199 * animation (a double value between 0.0 and 1.0).
200 * @param effect The context data of the effect.
201 * @param end_cb The function to free the context data, it will be called
202 * at the end of the effect, it must finalize the animation and free the
206 * @warning The transit free the context data at the and of the transition with
207 * the data_free_cb function, do not use the context data in another transit.
209 EAPI void elm_transit_effect_add(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect, Elm_Transit_Effect_End_Cb end_cb) EINA_ARG_NONNULL(1, 2);
212 * Delete an added effect.
214 * This function will remove the effect from the @p transit, calling the
215 * data_free_cb to free the @p data.
217 * @see elm_transit_effect_add()
219 * @note If the effect is not found, nothing is done.
220 * @note If the effect list become empty, this function will call
221 * elm_transit_del(transit), that is, it will kill the @p transit.
223 * @param transit The transit object.
224 * @param transition_cb The operation function.
225 * @param effect The context data of the effect.
229 EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect) EINA_ARG_NONNULL(1, 2);
232 * Add new object to apply the effects.
234 * @note After the first addition of an object in @p transit, if its
235 * object list become empty again, the @p transit will be killed by
236 * elm_transit_del(transit) function.
237 * @note If the @p obj belongs to another transit, the @p obj will be
238 * removed from it and it will only belong to the @p transit. If the old
239 * transit stays without objects, it will die.
240 * @note When you add an object into the @p transit, its state from
241 * evas_object_pass_events_get(obj) is saved, and it is applied when the
242 * transit ends, if you change this state whith evas_object_pass_events_set()
243 * after add the object, this state will change again when @p transit stops to
246 * @param transit The transit object.
247 * @param obj Object to be animated.
250 * @warning It is not allowed to add a new object after transit begins to go.
252 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
255 * Removes an added object from the transit.
257 * @note If the @p obj is not in the @p transit, nothing is done.
258 * @note If the list become empty, this function will call
259 * elm_transit_del(transit), that is, it will kill the @p transit.
261 * @param transit The transit object.
262 * @param obj Object to be removed from @p transit.
265 * @warning It is not allowed to remove objects after transit begins to go.
267 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
270 * Get the objects of the transit.
272 * @param transit The transit object.
273 * @return a Eina_List with the objects from the transit.
277 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
280 * Enable/disable keeping up the objects states.
281 * If it is not kept, the objects states will be reset when transition ends.
283 * @note @p transit can not be NULL.
284 * @note One state includes geometry, color, map data.
286 * @param transit The transit object.
287 * @param state_keep Keeping or Non Keeping.
291 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
294 * Get a value whether the objects states will be reset or not.
296 * @note @p transit can not be NULL
298 * @see elm_transit_objects_final_state_keep_set()
300 * @param transit The transit object.
301 * @return EINA_TRUE means the states of the objects will be reset.
302 * If @p transit is NULL, EINA_FALSE is returned
306 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
309 * Set the event enabled when transit is operating.
311 * If @p enabled is EINA_TRUE, the objects of the transit will receives
312 * events from mouse and keyboard during the animation.
313 * @note When you add an object with elm_transit_object_add(), its state from
314 * evas_object_pass_events_get(obj) is saved, and it is applied when the
315 * transit ends, if you change this state with evas_object_pass_events_set()
316 * after adding the object, this state will change again when @p transit stops
319 * @param transit The transit object.
320 * @param enabled Events are received when enabled is @c EINA_TRUE, and
325 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
328 * Get the value of event enabled status.
330 * @see elm_transit_event_enabled_set()
332 * @param transit The Transit object
333 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
334 * EINA_FALSE is returned
338 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
341 * Set the user-callback function when the transit is deleted.
343 * @note Using this function twice will overwrite the first function setted.
344 * @note the @p transit object will be deleted after call @p cb function.
346 * @param transit The transit object.
347 * @param cb Callback function pointer. This function will be called before
348 * the deletion of the transit.
349 * @param data Callback funtion user data. It is the @p op parameter.
353 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
356 * Set reverse effect automatically.
358 * If auto reverse is setted, after running the effects with the progress
359 * parameter from 0 to 1, it will call the effecs again with the progress
360 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
361 * where the duration was setted with the function elm_transit_add and
362 * the repeat with the function elm_transit_repeat_times_set().
364 * @param transit The transit object.
365 * @param reverse EINA_TRUE means the auto_reverse is on.
369 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
372 * Get if the auto reverse is on.
374 * @see elm_transit_auto_reverse_set()
376 * @param transit The transit object.
377 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
378 * EINA_FALSE is returned
382 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
385 * Set the transit repeat count. Effect will be repeated by repeat count.
387 * This function sets the number of repetition the transit will run after
388 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
389 * If the @p repeat is a negative number, it will repeat infinite times.
391 * @note If this function is called during the transit execution, the transit
392 * will run @p repeat times, ignoring the times it already performed.
394 * @param transit The transit object
395 * @param repeat Repeat count
399 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
402 * Get the transit repeat count.
404 * @see elm_transit_repeat_times_set()
406 * @param transit The Transit object.
407 * @return The repeat count. If @p transit is NULL
412 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
415 * Set the transit animation acceleration type.
417 * This function sets the tween mode of the transit that can be:
418 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
419 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
420 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
421 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
423 * @param transit The transit object.
424 * @param tween_mode The tween type.
428 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
431 * Get the transit animation acceleration type.
433 * @note @p transit can not be NULL
435 * @param transit The transit object.
436 * @return The tween type. If @p transit is NULL
437 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
441 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
444 * Set the transit animation time
446 * @note @p transit can not be NULL
448 * @param transit The transit object.
449 * @param duration The animation time.
453 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
456 * Get the transit animation time
458 * @note @p transit can not be NULL
460 * @param transit The transit object.
462 * @return The transit animation time.
466 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
469 * Starts the transition.
470 * Once this API is called, the transit begins to measure the time.
472 * @note @p transit can not be NULL
474 * @param transit The transit object.
478 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
481 * Pause/Resume the transition.
483 * If you call elm_transit_go again, the transit will be started from the
484 * beginning, and will be unpaused.
486 * @note @p transit can not be NULL
488 * @param transit The transit object.
489 * @param paused Whether the transition should be paused or not.
493 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
496 * Get the value of paused status.
498 * @see elm_transit_paused_set()
500 * @note @p transit can not be NULL
502 * @param transit The transit object.
503 * @return EINA_TRUE means transition is paused. If @p transit is NULL
504 * EINA_FALSE is returned
508 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
511 * Get the time progression of the animation (a double value between 0.0 and 1.0).
513 * The value returned is a fraction (current time / total time). It
514 * represents the progression position relative to the total.
516 * @note @p transit can not be NULL
518 * @param transit The transit object.
520 * @return The time progression value. If @p transit is NULL
525 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
528 * Makes the chain relationship between two transits.
530 * @note @p transit can not be NULL. Transit would have multiple chain transits.
531 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
533 * @param transit The transit object.
534 * @param chain_transit The chain transit object. This transit will be operated
535 * after transit is done.
537 * This function adds @p chain_transit transition to a chain after the @p
538 * transit, and will be started as soon as @p transit ends. See @ref
539 * transit_example_02_explained for a full example.
543 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
546 * Cut off the chain relationship between two transits.
548 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
549 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
551 * @param transit The transit object.
552 * @param chain_transit The chain transit object.
554 * This function remove the @p chain_transit transition from the @p transit.
558 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
561 * Get the current chain transit list.
563 * @note @p transit can not be NULL.
565 * @param transit The transit object.
566 * @return chain transit list.
570 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
573 * Add the Resizing Effect to Elm_Transit.
575 * @note This API is one of the facades. It creates resizing effect context
576 * and add it's required APIs to elm_transit_effect_add.
578 * @see elm_transit_effect_add()
580 * @param transit Transit object.
581 * @param from_w Object width size when effect begins.
582 * @param from_h Object height size when effect begins.
583 * @param to_w Object width size when effect ends.
584 * @param to_h Object height size when effect ends.
585 * @return Resizing effect context data.
589 EAPI Elm_Transit_Effect *elm_transit_effect_resizing_add(Elm_Transit *transit, Evas_Coord from_w, Evas_Coord from_h, Evas_Coord to_w, Evas_Coord to_h);
592 * Add the Translation Effect to Elm_Transit.
594 * @note This API is one of the facades. It creates translation effect context
595 * and add it's required APIs to elm_transit_effect_add.
597 * @see elm_transit_effect_add()
599 * @param transit Transit object.
600 * @param from_dx X Position variation when effect begins.
601 * @param from_dy Y Position variation when effect begins.
602 * @param to_dx X Position variation when effect ends.
603 * @param to_dy Y Position variation when effect ends.
604 * @return Translation effect context data.
607 * @warning It is highly recommended just create a transit with this effect when
608 * the window that the objects of the transit belongs has already been created.
609 * This is because this effect needs the geometry information about the objects,
610 * and if the window was not created yet, it can get a wrong information.
612 EAPI Elm_Transit_Effect *elm_transit_effect_translation_add(Elm_Transit *transit, Evas_Coord from_dx, Evas_Coord from_dy, Evas_Coord to_dx, Evas_Coord to_dy);
615 * Add the Zoom Effect to Elm_Transit.
617 * @note This API is one of the facades. It creates zoom effect context
618 * and add it's required APIs to elm_transit_effect_add.
620 * @see elm_transit_effect_add()
622 * @param transit Transit object.
623 * @param from_rate Scale rate when effect begins (1 is current rate).
624 * @param to_rate Scale rate when effect ends.
625 * @return Zoom effect context data.
628 * @warning It is highly recommended just create a transit with this effect when
629 * the window that the objects of the transit belongs has already been created.
630 * This is because this effect needs the geometry information about the objects,
631 * and if the window was not created yet, it can get a wrong information.
633 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
636 * Add the Flip Effect to Elm_Transit.
638 * @note This API is one of the facades. It creates flip effect context
639 * and add it's required APIs to elm_transit_effect_add.
640 * @note This effect is applied to each pair of objects in the order they are listed
641 * in the transit list of objects. The first object in the pair will be the
642 * "front" object and the second will be the "back" object.
644 * @see elm_transit_effect_add()
646 * @param transit Transit object.
647 * @param axis Flipping Axis(X or Y).
648 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
649 * @return Flip effect context data.
652 * @warning It is highly recommended just create a transit with this effect when
653 * the window that the objects of the transit belongs has already been created.
654 * This is because this effect needs the geometry information about the objects,
655 * and if the window was not created yet, it can get a wrong information.
657 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
660 * Add the Resizable Flip Effect to Elm_Transit.
662 * @note This API is one of the facades. It creates resizable flip effect context
663 * and add it's required APIs to elm_transit_effect_add.
664 * @note This effect is applied to each pair of objects in the order they are listed
665 * in the transit list of objects. The first object in the pair will be the
666 * "front" object and the second will be the "back" object.
668 * @see elm_transit_effect_add()
670 * @param transit Transit object.
671 * @param axis Flipping Axis(X or Y).
672 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
673 * @return Resizable flip effect context data.
676 * @warning It is highly recommended just create a transit with this effect when
677 * the window that the objects of the transit belongs has already been created.
678 * This is because this effect needs the geometry information about the objects,
679 * and if the window was not created yet, it can get a wrong information.
681 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
684 * Add the Wipe Effect to Elm_Transit.
686 * @note This API is one of the facades. It creates wipe effect context
687 * and add it's required APIs to elm_transit_effect_add.
689 * @see elm_transit_effect_add()
691 * @param transit Transit object.
692 * @param type Wipe type. Hide or show.
693 * @param dir Wipe Direction.
694 * @return Wipe effect context data.
697 * @warning It is highly recommended just create a transit with this effect when
698 * the window that the objects of the transit belongs has already been created.
699 * This is because this effect needs the geometry information about the objects,
700 * and if the window was not created yet, it can get a wrong information.
702 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
705 * Add the Color Effect to Elm_Transit.
707 * @note This API is one of the facades. It creates color effect context
708 * and add it's required APIs to elm_transit_effect_add.
710 * @see elm_transit_effect_add()
712 * @param transit Transit object.
713 * @param from_r RGB R when effect begins.
714 * @param from_g RGB G when effect begins.
715 * @param from_b RGB B when effect begins.
716 * @param from_a RGB A when effect begins.
717 * @param to_r RGB R when effect ends.
718 * @param to_g RGB G when effect ends.
719 * @param to_b RGB B when effect ends.
720 * @param to_a RGB A when effect ends.
721 * @return Color effect context data.
725 EAPI Elm_Transit_Effect *elm_transit_effect_color_add(Elm_Transit *transit, unsigned int from_r, unsigned int from_g, unsigned int from_b, unsigned int from_a, unsigned int to_r, unsigned int to_g, unsigned int to_b, unsigned int to_a);
728 * Add the Fade Effect to Elm_Transit.
730 * @note This API is one of the facades. It creates fade effect context
731 * and add it's required APIs to elm_transit_effect_add.
732 * @note This effect is applied to each pair of objects in the order they are listed
733 * in the transit list of objects. The first object in the pair will be the
734 * "before" object and the second will be the "after" object.
736 * @see elm_transit_effect_add()
738 * @param transit Transit object.
739 * @return Fade effect context data.
742 * @warning It is highly recommended just create a transit with this effect when
743 * the window that the objects of the transit belongs has already been created.
744 * This is because this effect needs the color information about the objects,
745 * and if the window was not created yet, it can get a wrong information.
747 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
750 * Add the Blend Effect to Elm_Transit.
752 * @note This API is one of the facades. It creates blend effect context
753 * and add it's required APIs to elm_transit_effect_add.
754 * @note This effect is applied to each pair of objects in the order they are listed
755 * in the transit list of objects. The first object in the pair will be the
756 * "before" object and the second will be the "after" object.
758 * @see elm_transit_effect_add()
760 * @param transit Transit object.
761 * @return Blend effect context data.
764 * @warning It is highly recommended just create a transit with this effect when
765 * the window that the objects of the transit belongs has already been created.
766 * This is because this effect needs the color information about the objects,
767 * and if the window was not created yet, it can get a wrong information.
769 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
772 * Add the Rotation Effect to Elm_Transit.
774 * @note This API is one of the facades. It creates rotation effect context
775 * and add it's required APIs to elm_transit_effect_add.
777 * @see elm_transit_effect_add()
779 * @param transit Transit object.
780 * @param from_degree Degree when effect begins.
781 * @param to_degree Degree when effect is ends.
782 * @return Rotation effect context data.
785 * @warning It is highly recommended just create a transit with this effect when
786 * the window that the objects of the transit belongs has already been created.
787 * This is because this effect needs the geometry information about the objects,
788 * and if the window was not created yet, it can get a wrong information.
790 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
793 * Add the ImageAnimation Effect to Elm_Transit.
795 * @note This API is one of the facades. It creates image animation effect context
796 * and add it's required APIs to elm_transit_effect_add.
797 * The @p images parameter is a list images paths. This list and
798 * its contents will be deleted at the end of the effect by
799 * elm_transit_effect_image_animation_context_free() function.
803 * char buf[PATH_MAX];
804 * Eina_List *images = NULL;
805 * Elm_Transit *transi = elm_transit_add();
807 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
808 * images = eina_list_append(images, eina_stringshare_add(buf));
810 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
811 * images = eina_list_append(images, eina_stringshare_add(buf));
812 * elm_transit_effect_image_animation_add(transi, images);
816 * @see elm_transit_effect_add()
818 * @param transit Transit object.
819 * @param images Eina_List of images file paths. This list and
820 * its contents will be deleted at the end of the effect by
821 * elm_transit_effect_image_animation_context_free() function.
822 * @return Image Animation effect context data.
826 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);