forked from enlightenment/efl
docs: Polish Efl.Canvas.Animation_Group and sons
Summary: These docs were almost empty. Reviewers: bu5hm4n, zmike, cedric, Jaehyun_Cho Reviewed By: cedric Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10564
This commit is contained in:
parent
56d541fbdb
commit
0e71e0e286
|
@ -1,24 +1,29 @@
|
|||
abstract @beta Efl.Canvas.Animation_Group extends Efl.Canvas.Animation
|
||||
{
|
||||
[[Efl group animation abstract class]]
|
||||
[[Base class for combined animations (groups of animations that are played together).
|
||||
|
||||
This class provides methods to add, remove and retrieve individual animations from the group.
|
||||
|
||||
See for example @Efl.Canvas.Animation_Group_Parallel and @Efl.Canvas.Animation_Group_Sequential.
|
||||
]]
|
||||
c_prefix: efl_animation_group;
|
||||
data: Efl_Canvas_Animation_Group_Data;
|
||||
methods {
|
||||
animation_add {
|
||||
[[Add the given animation to the animation group.]]
|
||||
[[Adds the given animation to the animation group.]]
|
||||
params {
|
||||
@in animation: Efl.Canvas.Animation; [[The animation which needs to be added to the animation group]]
|
||||
@in animation: Efl.Canvas.Animation; [[Animation to add to the group.]]
|
||||
}
|
||||
}
|
||||
animation_del {
|
||||
[[Delete the given animation from the animation group.]]
|
||||
[[Removes the given animation from the animation group.]]
|
||||
params {
|
||||
@in animation: Efl.Canvas.Animation; [[The animation which needs to be deleted from the animation group]]
|
||||
@in animation: Efl.Canvas.Animation; [[Animation to remove from the group.]]
|
||||
}
|
||||
}
|
||||
animations_get @const {
|
||||
[[Get the animations of the animation group.]]
|
||||
return: list<Efl.Canvas.Animation>; [[The animations of the animation group]]
|
||||
[[Gets the list of animations currently in the animation group.]]
|
||||
return: list<Efl.Canvas.Animation>; [[List of animations in the group.]]
|
||||
}
|
||||
}
|
||||
implements {
|
||||
|
|
|
@ -1,6 +1,13 @@
|
|||
class @beta Efl.Canvas.Animation_Group_Parallel extends Efl.Canvas.Animation_Group
|
||||
{
|
||||
[[Efl group parallel animation class]]
|
||||
[[Combined animation which plays its individual animations in parallel
|
||||
(all of them simultaneously).
|
||||
|
||||
For instance, this could be used to move an @Efl.Canvas.Object from one position to another
|
||||
while rotating it along the way.
|
||||
|
||||
Use @Efl.Canvas.Animation_Group.animation_add to append individual animations.
|
||||
]]
|
||||
c_prefix: efl_animation_group_parallel;
|
||||
data: null;
|
||||
methods {
|
||||
|
|
|
@ -1,6 +1,14 @@
|
|||
class @beta Efl.Canvas.Animation_Group_Sequential extends Efl.Canvas.Animation_Group
|
||||
{
|
||||
[[Efl group sequential animation class]]
|
||||
[[Combined animation which plays its individual animations in a sequential order
|
||||
(one after the other).
|
||||
|
||||
For instance, this could be used to move an @Efl.Canvas.Object from one position to another
|
||||
and then start rotating it once it reaches its destination.
|
||||
|
||||
Use @Efl.Canvas.Animation_Group.animation_add to append individual animations.
|
||||
Animations are played in the order in which they are added.
|
||||
]]
|
||||
data: null;
|
||||
methods {
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue