2 * @defgroup Transit Transit
5 * Transit is designed to apply various animated transition effects to @c
6 * Evas_Object, such like translation, rotation, etc. For using these
7 * effects, create an @ref Elm_Transit and add the desired transition effects.
9 * Once the effects are added into transit, they will be automatically
10 * managed (their callback will be called for the set duration and
11 * they will be deleted upon completion).
15 * Elm_Transit *trans = elm_transit_add();
16 * elm_transit_object_add(trans, obj);
17 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
18 * elm_transit_duration_set(transit, 1);
19 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
20 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
21 * elm_transit_repeat_times_set(transit, 3);
24 * Some transition effects are used to change the properties of objects. They
26 * @li @ref elm_transit_effect_translation_add
27 * @li @ref elm_transit_effect_color_add
28 * @li @ref elm_transit_effect_rotation_add
29 * @li @ref elm_transit_effect_wipe_add
30 * @li @ref elm_transit_effect_zoom_add
31 * @li @ref elm_transit_effect_resizing_add
33 * Other transition effects are used to make one object disappear and another
34 * object appear on its place. These effects are:
36 * @li @ref elm_transit_effect_flip_add
37 * @li @ref elm_transit_effect_resizable_flip_add
38 * @li @ref elm_transit_effect_fade_add
39 * @li @ref elm_transit_effect_blend_add
41 * It's also possible to make a transition chain with @ref
42 * elm_transit_chain_transit_add.
44 * @warning We strongly recommend to use elm_transit just when edje can not do
45 * the trick. Edje is better at handling transitions than Elm_Transit.
46 * Edje has more flexibility and animations can be manipulated inside the theme.
49 * @li @ref transit_example_01_explained
50 * @li @ref transit_example_02_explained
51 * @li @ref transit_example_03_c
52 * @li @ref transit_example_04_c
58 * @enum Elm_Transit_Tween_Mode
60 * The type of acceleration used in the transition.
64 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
65 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
66 over time, then decrease again
67 and stop slowly, v1 being a power factor */
68 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
69 speed over time, v1 being a power factor */
70 ELM_TRANSIT_TWEEN_MODE_ACCELERATE, /**< Starts slow and increase speed
71 over time, v1 being a power factor */
72 ELM_TRANSIT_TWEEN_MODE_DIVISOR_INTERP, /**< Start at gradient v1,
73 interpolated via power of v2 curve */
74 ELM_TRANSIT_TWEEN_MODE_BOUNCE, /**< Start at 0.0 then "drop" like a ball
75 bouncing to the ground at 1.0, and
76 bounce v2 times, with decay factor of v1 */
77 ELM_TRANSIT_TWEEN_MODE_SPRING /**< Start at 0.0 then "wobble" like a spring
78 rest position 1.0, and wobble v2 times,
79 with decay factor of v1 */
80 } Elm_Transit_Tween_Mode;
83 * @enum Elm_Transit_Effect_Flip_Axis
85 * The axis along which flip effect should be applied.
89 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
90 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
91 } Elm_Transit_Effect_Flip_Axis;
94 * @enum Elm_Transit_Effect_Wipe_Dir
96 * The direction in which the wipe effect should occur.
100 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
101 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
102 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
103 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
104 } Elm_Transit_Effect_Wipe_Dir;
106 /** @enum Elm_Transit_Effect_Wipe_Type
108 * Whether the wipe effect should show or hide the object.
112 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
114 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
116 } Elm_Transit_Effect_Wipe_Type;
119 * @typedef Elm_Transit
121 * The Transit created with elm_transit_add(). This type has the information
122 * about the objects which the transition will be applied, and the
123 * transition effects that will be used. It also contains info about
124 * duration, number of repetitions, auto-reverse, etc.
126 typedef struct _Elm_Transit Elm_Transit;
127 typedef void Elm_Transit_Effect;
130 * @typedef Elm_Transit_Effect_Transition_Cb
132 * Transition callback called for this effect on each transition iteration.
134 typedef void (*Elm_Transit_Effect_Transition_Cb)(Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
137 * Elm_Transit_Effect_End_Cb
139 * Transition callback called for this effect when the transition is over.
141 typedef void (*Elm_Transit_Effect_End_Cb)(Elm_Transit_Effect *effect, Elm_Transit *transit);
146 * A callback called when the transit is deleted.
148 typedef void (*Elm_Transit_Del_Cb)(void *data, Elm_Transit *transit);
151 * Create new transit.
153 * @note It is not necessary to delete the transit object, it will be deleted at
154 * the end of its operation.
155 * @note The transit will start playing when the program enters the main loop.
157 * @return The transit object.
161 EAPI Elm_Transit *elm_transit_add(void);
164 * Stops the animation and delete the @p transit object.
166 * Call this function if you want to stop the animation before the
167 * transit time. Make sure the @p transit object is still alive with
168 * elm_transit_del_cb_set() function.
169 * All added effects will be deleted, calling its respective data_free_cb
170 * functions. The function set by elm_transit_del_cb_set() will be called.
172 * @see elm_transit_del_cb_set()
174 * @param transit The transit object to be deleted.
178 EAPI void elm_transit_del(Elm_Transit *transit);
181 * Add a new effect to the transit.
183 * @note The cb function and the data are the key to the effect.
184 * If you try to add an existing effect, nothing is done.
185 * @note After the first addition of an effect to @p transit, if its
186 * effect list become empty again, the @p transit will be killed by
187 * elm_transit_del(transit) function.
191 * Elm_Transit *transit = elm_transit_add();
192 * elm_transit_effect_add(transit,
193 * elm_transit_effect_blend_op,
194 * elm_transit_effect_blend_context_new(),
195 * elm_transit_effect_blend_context_free);
198 * @param transit The transit object.
199 * @param transition_cb The operation function. It is called when the
200 * animation begins, it is the function that actually performs the animation.
201 * It is called with the @p data, @p transit and the time progression of the
202 * animation (a double value between 0.0 and 1.0).
203 * @param effect The context data of the effect.
204 * @param end_cb The function to free the context data, it will be called
205 * at the end of the effect, it must finalize the animation and free the
209 * @warning The transit will free the context data at the and of the
210 * transition with the data_free_cb function.
211 * Do not share the context data in between different transit objects.
213 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);
216 * Delete an added effect.
218 * This function will remove the effect from the @p transit, calling the
219 * data_free_cb to free the @p data.
221 * @see elm_transit_effect_add()
223 * @note If the effect is not found, nothing is done.
224 * @note If the effect list become empty, this function will call
225 * elm_transit_del(transit), i.e., it will kill the @p transit.
227 * @param transit The transit object.
228 * @param transition_cb The operation function.
229 * @param effect The context data of the effect.
233 EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect);
236 * Add new object to apply the effects.
238 * @note After the first addition of an object to @p transit, if its
239 * object list become empty again, the @p transit will be killed by
240 * elm_transit_del(transit) function.
241 * @note If the @p obj belongs to another transit, the @p obj will be
242 * removed from it and it will only belong to the other @p transit.
243 * If the old transit stays without objects, it will die.
244 * @note When you add an object into the @p transit, its state from
245 * evas_object_pass_events_get(obj) is saved, and it is applied when the
246 * transit ends, if you change this state with evas_object_pass_events_set()
247 * after add the object, this state will change again when @p transit stops.
249 * @param transit The transit object.
250 * @param obj Object to be animated.
253 * @warning It is not allowed to add a new object after transit begins.
255 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj);
258 * Removes an added object from the transit.
260 * @note If the @p obj is not in the @p transit, nothing is done.
261 * @note If the list become empty, this function will call
262 * elm_transit_del(transit), i.e., it will kill the @p transit.
264 * @param transit The transit object.
265 * @param obj Object to be removed from @p transit.
268 * @warning It is not allowed to remove objects after transit begins.
270 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj);
273 * Get the objects of the transit.
275 * @param transit The transit object.
276 * @return a Eina_List with the objects from the transit.
280 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit);
283 * Enable/disable keeping up the objects states.
284 * If it is not kept, the objects states will be reset when transition ends.
286 * @note @p transit can not be NULL.
287 * @note One state includes geometry, color, map data.
289 * @param transit The transit object.
290 * @param state_keep retain the state or not.
294 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep);
297 * Get a value whether the objects states will be reset or not.
299 * @note @p transit can not be NULL
301 * @see elm_transit_objects_final_state_keep_set()
303 * @param transit The transit object.
304 * @return EINA_TRUE means the states of the objects will be reset.
305 * If @p transit is NULL, EINA_FALSE is returned
309 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit);
312 * Set the event enabled when transit is operating.
314 * If @p enabled is EINA_TRUE, the objects of the transit will receive
315 * events from mouse and keyboard during the animation.
316 * @note When you add an object with elm_transit_object_add(), its state from
317 * evas_object_freeze_events_get(obj) is saved, and it is applied when the
318 * transit ends. If you change this state with evas_object_freeze_events_set()
319 * after adding the object, this state will change again when @p transit stops
322 * @param transit The transit object.
323 * @param enabled Events are received when enabled is @c EINA_TRUE, and
328 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled);
331 * Get the value of event enabled status.
333 * @see elm_transit_event_enabled_set()
335 * @param transit The Transit object
336 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
337 * EINA_FALSE is returned
341 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit);
344 * Set the user-callback function when the transit is deleted.
346 * @note Using this function twice will overwrite the first function set.
347 * @note the @p transit object will be deleted after call @p cb function.
349 * @param transit The transit object.
350 * @param cb Callback function pointer. This function will be called before
351 * the deletion of the transit.
352 * @param data Callback function user data. It is the @p op parameter.
356 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data);
359 * Set reverse effect automatically.
361 * If auto reverse is set, after running the effects with the progress
362 * parameter from 0 to 1, it will call the effects again with the progress
363 * from 1 to 0. The transit will last for a time equal to (2 * duration * repeat),
364 * where the duration was set with the function elm_transit_add and
365 * the repeat with the function elm_transit_repeat_times_set().
367 * @param transit The transit object.
368 * @param reverse EINA_TRUE means the auto_reverse is on.
372 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse);
375 * Get if the auto reverse is on.
377 * @see elm_transit_auto_reverse_set()
379 * @param transit The transit object.
380 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
381 * EINA_FALSE is returned
385 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit);
388 * Set the transit repeat count. Effect will be repeated by repeat count.
390 * This function sets the number of repetition the transit will run after
391 * the first one, i.e., if @p repeat is 1, the transit will run 2 times.
392 * If the @p repeat is a negative number, it will repeat infinite times.
394 * @note If this function is called during the transit execution, the transit
395 * will run @p repeat times, ignoring the times it already performed.
397 * @param transit The transit object
398 * @param repeat Repeat count
402 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat);
405 * Get the transit repeat count.
407 * @see elm_transit_repeat_times_set()
409 * @param transit The Transit object.
410 * @return The repeat count. If @p transit is NULL
415 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit);
418 * Set the transit animation acceleration type.
420 * This function sets the tween mode of the transit that can be:
421 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
422 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends
423 * decelerating with factor.
424 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time
426 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time
428 * ELM_TRANSIT_TWEEN_MODE_DIVISOR_INTERP - Start at gradient v1, interpolated
429 * via power of v2 curve.
430 * ELM_TRANSIT_TWEEN_MODE_BOUNCE - Start at 0.0 then "drop" like a ball bouncing
431 * to the ground at 1.0, and bounce v2 times, with decay factor of v1.
432 * ELM_TRANSIT_TWEEN_MODE_SPRING - Start at 0.0 then "wobble" like a spring rest
433 * position 1.0, and wobble v2 times, with decay factor of v1.
435 * @param transit The transit object.
436 * @param tween_mode The tween type.
440 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode);
443 * Get the transit animation acceleration type.
445 * @note @p transit can not be NULL
447 * @param transit The transit object.
448 * @return The tween type. If @p transit is NULL
449 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
453 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit);
456 * Set the transit animation acceleration factor.
458 * This function sets the tween mode factor of the transit that can be:
459 * If you use the below tween modes, you have to set the factor using this API.
460 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Start slow, speed up then slow down
461 * at end, v1 being a power factor, 0.0 being linear, 1.0 being
462 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL default, 2.0 being much more pronounced
463 * sinusoidal(squared), 3.0 being cubed, etc.
464 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - Start fast then slow down, v1 being a
465 * power factor, 0.0 being linear, 1.0 being ELM_TRANSIT_TWEEN_MODE_DECELERATE
466 * default, 2.0 being much more pronounced decelerate (squared), 3.0 being
468 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - Start slow then speed up, v1 being a
469 * power factor, 0.0 being linear, 1.0 being ELM_TRANSIT_TWEEN_MODE_ACCELERATE
470 * default, 2.0 being much more pronounced accelerate (squared), 3.0 being
472 * ELM_TRANSIT_TWEEN_MODE_DIVISOR_INTERP - Start at gradient * v1, interpolated
473 * via power of v2 curve
474 * ELM_TRANSIT_TWEEN_MODE_BOUNCE - Start at 0.0 then "drop" like a ball bouncing
475 * to the ground at 1.0, and bounce v2 times, with decay factor of v1
476 * ELM_TRANSIT_TWEEN_MODE_SPRING - Start at 0.0 then "wobble" like a spring rest
477 * position 1.0, and wobble v2 times, with decay factor of v1
479 * @param transit The transit object.
480 * @param v1 A parameter use by the mapping (default is 1.0)
481 * @param v2 A parameter use by the mapping (default is 0.0)
483 * @see elm_transit_tween_mode_factor_get()
487 EAPI void elm_transit_tween_mode_factor_set(Elm_Transit *transit, double v1, double v2);
490 * Get the transit animation acceleration factor.
492 * @note @p transit can not be NULL
494 * @param transit The transit object.
495 * @param v1 Pointer to an double in which to store the factor value.
496 * @param v2 Pointer to an double in which to store the factor value2.
498 * @see elm_transit_tween_mode_factor_set()
502 EAPI void elm_transit_tween_mode_factor_get(const Elm_Transit *transit, double *v1, double *v2);
505 * Set the transit animation time
507 * @note @p transit can not be NULL
509 * @param transit The transit object.
510 * @param duration The animation time.
514 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration);
517 * Get the transit animation time
519 * @note @p transit can not be NULL
521 * @param transit The transit object.
523 * @return The transit animation time.
527 EAPI double elm_transit_duration_get(const Elm_Transit *transit);
530 * Starts the transition.
531 * Once this API is called, the transit begins to measure the time.
533 * @note @p transit can not be NULL
535 * @param transit The transit object.
539 EAPI void elm_transit_go(Elm_Transit *transit);
542 * Pause/Resume the transition.
544 * If you call elm_transit_go again, the transit will be started from the
545 * beginning, and will be played.
547 * @note @p transit can not be NULL
549 * @param transit The transit object.
550 * @param paused Whether the transition should be paused or not.
554 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused);
557 * Get the value of paused status.
559 * @see elm_transit_paused_set()
561 * @note @p transit can not be NULL
563 * @param transit The transit object.
564 * @return EINA_TRUE means transition is paused. If @p transit is NULL
565 * EINA_FALSE is returned
569 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit);
572 * Get the time progression of the animation (a double value between 0.0 and 1.0).
574 * The value returned is a fraction (current time / total time). It
575 * represents the progression position relative to the total.
577 * @note @p transit can not be NULL
579 * @param transit The transit object.
581 * @return The time progression value. If @p transit is NULL
586 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit);
589 * Makes the chain relationship between two transits.
591 * @note @p transit can not be NULL. Transit would have multiple chain transits.
592 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
594 * @param transit The transit object.
595 * @param chain_transit The chain transit object. This transit will be operated
596 * after transit is done.
598 * This function adds @p chain_transit transition to a chain after the @p
599 * transit, and will be started as soon as @p transit ends. See @ref
600 * transit_example_02_explained for a full example.
604 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit);
607 * Cut off the chain relationship between two transits.
609 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
610 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
612 * @param transit The transit object.
613 * @param chain_transit The chain transit object.
615 * This function remove the @p chain_transit transition from the @p transit.
619 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit);
622 * Get the current chain transit list.
624 * @note @p transit can not be NULL.
626 * @param transit The transit object.
627 * @return chain transit list.
631 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
634 * Add the Resizing Effect to Elm_Transit.
636 * @note This API is one of the facades. It creates resizing effect context
637 * and add it's required APIs to elm_transit_effect_add.
639 * @see elm_transit_effect_add()
641 * @param transit Transit object.
642 * @param from_w Object width size when effect begins.
643 * @param from_h Object height size when effect begins.
644 * @param to_w Object width size when effect ends.
645 * @param to_h Object height size when effect ends.
646 * @return Resizing effect context data.
650 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);
653 * Add the Translation Effect to Elm_Transit.
655 * @note This API is one of the facades. It creates translation effect context
656 * and add it's required APIs to elm_transit_effect_add.
658 * @see elm_transit_effect_add()
660 * @param transit Transit object.
661 * @param from_dx X Position variation when effect begins.
662 * @param from_dy Y Position variation when effect begins.
663 * @param to_dx X Position variation when effect ends.
664 * @param to_dy Y Position variation when effect ends.
665 * @return Translation effect context data.
668 * @warning It is highly recommended just create a transit with this effect when
669 * the window that the objects of the transit belongs has already been created.
670 * This is because this effect needs the geometry information about the objects,
671 * and if the window was not created yet, it can get a wrong information.
673 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);
676 * Add the Zoom Effect to Elm_Transit.
678 * @note This API is one of the facades. It creates zoom effect context
679 * and add it's required APIs to elm_transit_effect_add.
681 * @see elm_transit_effect_add()
683 * @param transit Transit object.
684 * @param from_rate Scale rate when effect begins (1 is current rate).
685 * @param to_rate Scale rate when effect ends.
686 * @return Zoom effect context data.
689 * @warning It is highly recommended just create a transit with this effect when
690 * the window that the objects of the transit belongs has already been created.
691 * This is because this effect needs the geometry information about the objects,
692 * and if the window was not created yet, it can get a wrong information.
694 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
697 * Add the Flip Effect to Elm_Transit.
699 * @note This API is one of the facades. It creates flip effect context
700 * and add it's required APIs to elm_transit_effect_add.
701 * @note This effect is applied to each pair of objects in the order they are listed
702 * in the transit list of objects. The first object in the pair will be the
703 * "front" object and the second will be the "back" object.
705 * @see elm_transit_effect_add()
707 * @param transit Transit object.
708 * @param axis Flipping Axis(X or Y).
709 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
710 * @return Flip effect context data.
713 * @warning It is highly recommended just create a transit with this effect when
714 * the window that the objects of the transit belongs has already been created.
715 * This is because this effect needs the geometry information about the objects,
716 * and if the window was not created yet, it can get a wrong information.
718 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
721 * Add the Resizeable Flip Effect to Elm_Transit.
723 * @note This API is one of the facades. It creates resizable flip effect context
724 * and add it's required APIs to elm_transit_effect_add.
725 * @note This effect is applied to each pair of objects in the order they are listed
726 * in the transit list of objects. The first object in the pair will be the
727 * "front" object and the second will be the "back" object.
729 * @see elm_transit_effect_add()
731 * @param transit Transit object.
732 * @param axis Flipping Axis(X or Y).
733 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
734 * @return Resizeable flip effect context data.
737 * @warning It is highly recommended just create a transit with this effect when
738 * the window that the objects of the transit belongs has already been created.
739 * This is because this effect needs the geometry information about the objects,
740 * and if the window was not created yet, it can get a wrong information.
742 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
745 * Add the Wipe Effect to Elm_Transit.
747 * @note This API is one of the facades. It creates wipe effect context
748 * and add it's required APIs to elm_transit_effect_add.
750 * @see elm_transit_effect_add()
752 * @param transit Transit object.
753 * @param type Wipe type. Hide or show.
754 * @param dir Wipe Direction.
755 * @return Wipe effect context data.
758 * @warning It is highly recommended just create a transit with this effect when
759 * the window that the objects of the transit belongs has already been created.
760 * This is because this effect needs the geometry information about the objects,
761 * and if the window was not created yet, it can get a wrong information.
763 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
766 * Add the Color Effect to Elm_Transit.
768 * @note This API is one of the facades. It creates color effect context
769 * and add it's required APIs to elm_transit_effect_add.
771 * @see elm_transit_effect_add()
773 * @param transit Transit object.
774 * @param from_r RGB R when effect begins.
775 * @param from_g RGB G when effect begins.
776 * @param from_b RGB B when effect begins.
777 * @param from_a RGB A when effect begins.
778 * @param to_r RGB R when effect ends.
779 * @param to_g RGB G when effect ends.
780 * @param to_b RGB B when effect ends.
781 * @param to_a RGB A when effect ends.
782 * @return Color effect context data.
786 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);
789 * Add the Fade Effect to Elm_Transit.
791 * @note This API is one of the facades. It creates fade effect context
792 * and add it's required APIs to elm_transit_effect_add.
793 * @note This effect is applied to each pair of objects in the order they are listed
794 * in the transit list of objects. The first object in the pair will be the
795 * "before" object and the second will be the "after" object.
797 * @see elm_transit_effect_add()
799 * @param transit Transit object.
800 * @return Fade effect context data.
803 * @warning It is highly recommended just create a transit with this effect when
804 * the window that the objects of the transit belongs has already been created.
805 * This is because this effect needs the color information about the objects,
806 * and if the window was not created yet, it can get a wrong information.
808 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
811 * Add the Blend Effect to Elm_Transit.
813 * @note This API is one of the facades. It creates blend effect context
814 * and add it's required APIs to elm_transit_effect_add.
815 * @note This effect is applied to each pair of objects in the order they are listed
816 * in the transit list of objects. The first object in the pair will be the
817 * "before" object and the second will be the "after" object.
819 * @see elm_transit_effect_add()
821 * @param transit Transit object.
822 * @return Blend effect context data.
825 * @warning It is highly recommended just create a transit with this effect when
826 * the window that the objects of the transit belongs has already been created.
827 * This is because this effect needs the color information about the objects,
828 * and if the window was not created yet, it can get a wrong information.
830 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
833 * Add the Rotation Effect to Elm_Transit.
835 * @note This API is one of the facades. It creates rotation effect context
836 * and add it's required APIs to elm_transit_effect_add.
838 * @see elm_transit_effect_add()
840 * @param transit Transit object.
841 * @param from_degree Degree when effect begins.
842 * @param to_degree Degree when effect is ends.
843 * @return Rotation effect context data.
846 * @warning It is highly recommended just create a transit with this effect when
847 * the window that the objects of the transit belongs has already been created.
848 * This is because this effect needs the geometry information about the objects,
849 * and if the window was not created yet, it can get a wrong information.
851 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
854 * Add the ImageAnimation Effect to Elm_Transit.
856 * @note This API is one of the facades. It creates image animation effect context
857 * and add it's required APIs to elm_transit_effect_add.
858 * The @p images parameter is a list images paths. This list and
859 * its contents will be deleted at the end of the effect by
860 * elm_transit_effect_image_animation_context_free() function.
864 * char buf[PATH_MAX];
865 * Eina_List *images = NULL;
866 * Elm_Transit *transi = elm_transit_add();
868 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
869 * images = eina_list_append(images, eina_stringshare_add(buf));
871 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
872 * images = eina_list_append(images, eina_stringshare_add(buf));
873 * elm_transit_effect_image_animation_add(transi, images);
877 * @see elm_transit_effect_add()
879 * @param transit Transit object.
880 * @param images Eina_List of images file paths. This list and
881 * its contents will be deleted at the end of the effect by
882 * elm_transit_effect_image_animation_context_free() function.
883 * @return Image Animation effect context data.
887 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);