Mercurial > molko
annotate libmlk-core/core/animation.h @ 243:71b3b7036de7
misc: lot of cleanups,
- prefix libraries with libmlk,
- move assets from source directories closes #2520,
- prefix header guards closes #2519
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 28 Nov 2020 22:37:30 +0100 |
parents | libcore/core/animation.h@604fad63bd9c |
children | c4da052c0def |
rev | line source |
---|---|
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * animation.h -- basic animations |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
183
diff
changeset
|
19 #ifndef MOLKO_CORE_ANIMATION_H |
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
183
diff
changeset
|
20 #define MOLKO_CORE_ANIMATION_H |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file animation.h |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Basic animations. |
72
6203e1ac9b18
doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
25 * \ingroup drawing |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 */ |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 #include <stdbool.h> |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
136
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
30 struct drawable; |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 struct sprite; |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 /** |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * \brief Animation object |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 */ |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 struct animation { |
147
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
136
diff
changeset
|
37 struct sprite *sprite; /*!< (+&) Sprite to use. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
136
diff
changeset
|
38 unsigned int row; /*!< (-) Current row. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
136
diff
changeset
|
39 unsigned int column; /*!< (-) Current column. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
136
diff
changeset
|
40 unsigned int delay; /*!< (-) Delay between frames. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
136
diff
changeset
|
41 unsigned int elapsed; /*!< (-) Elapsed time since last frame. */ |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 }; |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 /** |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 * Initialize the animation. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 * The animation does not take sprite ownership, it must be valid until |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 * animation is no longer used. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 * \pre an != NULL |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 * \pre sprite != NULL |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 * \param an the animation |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 * \param sprite the sprite to use |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 * \param delay the delay between frames in milliseconds |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 */ |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 void |
46
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
22
diff
changeset
|
57 animation_init(struct animation *an, struct sprite *sprite, unsigned int delay); |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 /** |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 * Start an animation. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 * \pre an != NULL |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 * \param an the animation |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 */ |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 void |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 animation_start(struct animation *an); |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 /** |
183
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
69 * Tells if the animation has completed. |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
70 * |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
71 * \pre an != NULL |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
72 * \param an the animation |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
73 * \return True if the animation shown all images. |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
74 */ |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
75 bool |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
76 animation_completed(const struct animation *an); |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
77 |
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
78 /** |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 * Update the animation. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 * You must call this function at each loop iteration to update the animation |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 * frame depending on its delay. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 * |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 * \pre an != NULL |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 * \param an the animation |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 * \param ticks the elapsed ticks since the last call |
169
eb0a7ab71023
misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents:
147
diff
changeset
|
87 * \return True if the animation is complete. |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 */ |
127
6691c9f69028
core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
89 bool |
46
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
22
diff
changeset
|
90 animation_update(struct animation *an, unsigned int ticks); |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 /** |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 * Draw the animation. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 * |
183
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
95 * \pre an != NULL && !animation_completed(an) |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 * \param an the animation |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 * \param x the X coordinate |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 * \param y the Y coordinate |
169
eb0a7ab71023
misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents:
147
diff
changeset
|
99 * \return False in case of rendering error. |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 */ |
169
eb0a7ab71023
misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents:
147
diff
changeset
|
101 bool |
183
604fad63bd9c
core: fix animation delay
David Demelier <markand@malikania.fr>
parents:
169
diff
changeset
|
102 animation_draw(const struct animation *an, int x, int y); |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 |
136
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
104 /** |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
105 * Create a drawable from an animation. |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
106 * |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
107 * The animation must be kept alive until the drawable is used. |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
108 * |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
109 * The dw->data member will be set to the animation pointer and can be |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
110 * safely used by the user for custom drawable operation if needed. |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
111 * |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
112 * The dw->finish member isn't used and can be re-used by the user. |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
113 * |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
114 * \pre an != NULL |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
115 * \pre dw != NULL |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
116 * \param an the animation |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
117 * \param dw the drawable |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
118 * \param x x position on screen |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
119 * \param y y position on screen |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
120 * \post dw->data contains an |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
121 * \post dw->update contains an update function |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
122 * \post dw->draw contains a drawing function |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
123 * \post dw->finish is NULL |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
124 */ |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
125 void |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
126 animation_drawable(struct animation *an, struct drawable *dw, int x, int y); |
30b68089ae70
core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents:
127
diff
changeset
|
127 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
183
diff
changeset
|
128 #endif /* !MOLKO_CORE_ANIMATION_H */ |