Mercurial > MadButterfly
annotate include/mb_animate.h @ 191:18f8c3126cdb
Refine installation instructions and document event dispatching by wycc.
author | Thinker K.F. Li <thinker@branda.to> |
---|---|
date | Tue, 18 Nov 2008 13:55:09 +0800 |
parents | 530bb7728546 |
children | 54fdc2a65242 |
rev | line source |
---|---|
41 | 1 #ifndef __ANIMATE_H_ |
2 #define __ANIMATE_H_ | |
3 | |
42 | 4 #include "mb_types.h" |
5 #include "mb_timer.h" | |
186
530bb7728546
Move header files to $(top_srcdir)/include/ and prefixed with 'mb_'.
Thinker K.F. Li <thinker@branda.to>
parents:
185
diff
changeset
|
6 #include "mb_paint.h" |
42 | 7 |
117 | 8 /*! \page def_action How to Define An Action? |
116
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
9 * |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
10 * A action must implement following 4 functions. |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
11 * \li start, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
12 * \li step, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
13 * \li stop, |
130
3a4d6179e6a9
change mb_c_source.m4 and mb_c_header.m4 to specify parent for SVG object
Thinker K.F. Li <thinker@branda.to>
parents:
123
diff
changeset
|
14 * \li free, |
3a4d6179e6a9
change mb_c_source.m4 and mb_c_header.m4 to specify parent for SVG object
Thinker K.F. Li <thinker@branda.to>
parents:
123
diff
changeset
|
15 * \li *_new(), and |
3a4d6179e6a9
change mb_c_source.m4 and mb_c_header.m4 to specify parent for SVG object
Thinker K.F. Li <thinker@branda.to>
parents:
123
diff
changeset
|
16 * \li add *_new() to \ref animate.h . |
116
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
17 * |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
18 * *_new() must invokes mb_word_add_action() to add new object |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
19 * as one of actions in the word specified as an argument of it. |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
20 * It also means *_new() must have an argument with type of |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
21 * (mb_word_t *). |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
22 */ |
117 | 23 |
24 /*! \defgroup anim Animation | |
25 * \brief Animation is a set of functions to make graph moving. | |
26 * @{ | |
27 */ | |
28 typedef struct _mb_progm mb_progm_t; | |
29 typedef struct _mb_word mb_word_t; | |
30 typedef struct _mb_action mb_action_t; | |
31 | |
123
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
32 struct _mb_progm_complete { |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
33 event_t event; |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
34 mb_progm_t *progm; |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
35 }; |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
36 typedef struct _mb_progm_complete mb_progm_complete_t; |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
37 |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
38 extern mb_progm_t *mb_progm_new(int max_words, redraw_man_t *rdman); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
39 extern void mb_progm_free(mb_progm_t *progm); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
40 extern mb_word_t *mb_progm_next_word(mb_progm_t *progm, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
41 const mb_timeval_t *start, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
42 const mb_timeval_t *playing); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
43 extern void mb_progm_start(mb_progm_t *progm, mb_tman_t *tman, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
44 mb_timeval_t *now); |
153
9870b049b7f6
Make mb_progm_abort() work.
Thinker K.F. Li <thinker@branda.to>
parents:
130
diff
changeset
|
45 extern void mb_progm_abort(mb_progm_t *progm); |
123
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
46 extern subject_t *mb_progm_get_complete(mb_progm_t *progm); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
47 |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
48 /*! \defgroup ani_actions Animation Actions |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
49 * @{ |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
50 */ |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
51 extern mb_action_t *mb_shift_new(co_aix x, co_aix y, coord_t *coord, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
52 mb_word_t *word); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
53 extern mb_action_t *mb_chgcolor_new(co_comp_t r, co_comp_t g, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
54 co_comp_t b, co_comp_t a, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
55 paint_t *paint, mb_word_t *word); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
56 extern mb_action_t *mb_rotate_new(float angle1, float angle2, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
57 coord_t *coord, mb_word_t *word); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
58 |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
59 enum { VIS_VISIBLE, VIS_HIDDEN }; |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
60 extern mb_action_t *mb_visibility_new(int visib, coord_t *coord, |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
61 mb_word_t *word); |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
62 /* @} */ |
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
63 |
117 | 64 /*! \defgroup act_support Action Supports. |
65 * @{ | |
66 */ | |
123
9e2316dc6ecb
Program completion events
Thinker K.F. Li <thinker@branda.to>
parents:
117
diff
changeset
|
67 /*! \brief Basic class of animation actions. |
117 | 68 * |
69 * \sa \ref def_action | |
70 */ | |
116
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
71 struct _mb_action { |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
72 void (*start)(mb_action_t *act, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
73 const mb_timeval_t *now, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
74 const mb_timeval_t *playing_time, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
75 redraw_man_t *rdman); |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
76 void (*step)(mb_action_t *act, const mb_timeval_t *now, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
77 redraw_man_t *rdman); |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
78 void (*stop)(mb_action_t *act, const mb_timeval_t *now, |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
79 redraw_man_t *rdman); |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
80 void (*free)(mb_action_t *act); |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
81 mb_action_t *next; |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
82 }; |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
83 |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
84 extern void mb_word_add_action(mb_word_t *word, mb_action_t *act); |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
85 /* @} */ |
1d74eb3861b7
move animation actions from animate.c to files.
Thinker K.F. Li <thinker@branda.to>
parents:
104
diff
changeset
|
86 |
101 | 87 /* @} */ |
41 | 88 |
89 #endif /* __ANIMATE_H_ */ |