libanim
view src/anim.h @ 77:b1c6448d56bc
visual studio 2015 fix
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Wed, 05 Aug 2015 07:17:54 +0300 |
| parents | 60a46a122b0f |
| children |
line source
1 /*
2 libanim - hierarchical keyframe animation library
3 Copyright (C) 2012-2014 John Tsiombikas <nuclear@member.fsf.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published
7 by the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18 #ifndef LIBANIM_H_
19 #define LIBANIM_H_
21 #include "config.h"
23 #if _MSC_VER >= 1900
24 #define _TIMESPEC_DEFINED
25 #endif
26 #include <pthread.h>
28 #include <vmath/vector.h>
29 #include <vmath/quat.h>
30 #include <vmath/matrix.h>
31 #include "track.h"
33 enum {
34 ANM_TRACK_POS_X,
35 ANM_TRACK_POS_Y,
36 ANM_TRACK_POS_Z,
38 ANM_TRACK_ROT_X,
39 ANM_TRACK_ROT_Y,
40 ANM_TRACK_ROT_Z,
41 ANM_TRACK_ROT_W,
43 ANM_TRACK_SCL_X,
44 ANM_TRACK_SCL_Y,
45 ANM_TRACK_SCL_Z,
47 ANM_NUM_TRACKS
48 };
50 struct anm_animation {
51 char *name;
52 struct anm_track tracks[ANM_NUM_TRACKS];
53 };
55 struct anm_node {
56 char *name;
58 int cur_anim[2];
59 anm_time_t cur_anim_offset[2];
60 float cur_mix;
62 /* high-level animation blending transition duration */
63 anm_time_t blend_dur;
65 struct anm_animation *animations;
66 vec3_t pivot;
68 /* matrix cache */
69 struct mat_cache {
70 mat4_t matrix, inv_matrix;
71 anm_time_t time, inv_time;
72 struct mat_cache *next;
73 } *cache_list;
74 pthread_key_t cache_key;
75 pthread_mutex_t cache_list_lock;
77 /* matrix calculated by anm_eval functions (no locking, meant as a pre-pass) */
78 mat4_t matrix;
80 struct anm_node *parent;
81 struct anm_node *child;
82 struct anm_node *next;
83 };
85 #ifdef __cplusplus
86 extern "C" {
87 #endif
89 int anm_init_animation(struct anm_animation *anim);
90 void anm_destroy_animation(struct anm_animation *anim);
92 void anm_set_animation_name(struct anm_animation *anim, const char *name);
95 /* ---- node/hierarchy management ---- */
97 /* node constructor and destructor */
98 int anm_init_node(struct anm_node *node);
99 void anm_destroy_node(struct anm_node *node);
101 /* recursively destroy an animation node tree */
102 void anm_destroy_node_tree(struct anm_node *tree);
104 /* helper functions to allocate/construct and destroy/free with
105 * a single call. They call anm_init_node and anm_destroy_node
106 * internally.
107 */
108 struct anm_node *anm_create_node(void);
109 void anm_free_node(struct anm_node *node);
111 /* recursively destroy and free the nodes of a node tree */
112 void anm_free_node_tree(struct anm_node *tree);
114 int anm_set_node_name(struct anm_node *node, const char *name);
115 const char *anm_get_node_name(struct anm_node *node);
117 /* link and unlink nodes with parent/child relations */
118 void anm_link_node(struct anm_node *parent, struct anm_node *child);
119 int anm_unlink_node(struct anm_node *parent, struct anm_node *child);
121 void anm_set_pivot(struct anm_node *node, vec3_t pivot);
122 vec3_t anm_get_pivot(struct anm_node *node);
124 /* ---- multiple animations and animation blending ---- */
126 /* set active animation(s) */
127 int anm_use_node_animation(struct anm_node *node, int aidx);
128 int anm_use_node_animations(struct anm_node *node, int aidx, int bidx, float t);
129 /* recursive variants */
130 int anm_use_animation(struct anm_node *node, int aidx);
131 int anm_use_animations(struct anm_node *node, int aidx, int bidx, float t);
133 /* set/get current animation offset(s) */
134 void anm_set_node_animation_offset(struct anm_node *node, anm_time_t offs, int which);
135 anm_time_t anm_get_animation_offset(const struct anm_node *node, int which);
136 /* recursive variant */
137 void anm_set_animation_offset(struct anm_node *node, anm_time_t offs, int which);
139 /* returns the requested current animation index, which can be 0 or 1 */
140 int anm_get_active_animation_index(const struct anm_node *node, int which);
141 /* returns the requested current animation, which can be 0 or 1 */
142 struct anm_animation *anm_get_active_animation(const struct anm_node *node, int which);
143 float anm_get_active_animation_mix(const struct anm_node *node);
145 int anm_get_animation_count(const struct anm_node *node);
147 /* add/remove an animation to the specified node */
148 int anm_add_node_animation(struct anm_node *node);
149 int anm_remove_node_animation(struct anm_node *node, int idx);
151 /* add/remove an animation to the specified node and all it's descendants */
152 int anm_add_animation(struct anm_node *node);
153 int anm_remove_animation(struct anm_node *node, int idx);
155 struct anm_animation *anm_get_animation(struct anm_node *node, int idx);
156 struct anm_animation *anm_get_animation_by_name(struct anm_node *node, const char *name);
158 int anm_find_animation(struct anm_node *node, const char *name);
160 /* set the interpolator for the (first) currently active animation */
161 void anm_set_interpolator(struct anm_node *node, enum anm_interpolator in);
162 /* set the extrapolator for the (first) currently active animation */
163 void anm_set_extrapolator(struct anm_node *node, enum anm_extrapolator ex);
165 /* set the name of the currently active animation of this node only */
166 void anm_set_node_active_animation_name(struct anm_node *node, const char *name);
167 /* recursively set the name of the currently active animation for this node
168 * and all it's descendants */
169 void anm_set_active_animation_name(struct anm_node *node, const char *name);
170 /* get the name of the currently active animation of this node */
171 const char *anm_get_active_animation_name(struct anm_node *node);
174 /* ---- high level animation blending interface ---- */
175 /* XXX this convenience interface assumes monotonically increasing time values
176 * in all subsequent calls to anm_get_* and anm_eval_* functions.
177 *
178 * anmidx: index of the animation to transition to
179 * start: when to start the transition
180 * dur: transition duration
181 *
182 * sets up a transition from the current animation (cur_anim[0]) to another animation.
183 * at time start + dur, the transition will be completed, cur_anim[0] will be the new
184 * animation and cur_anim_offset[0] will be equal to start.
185 */
186 void anm_transition(struct anm_node *node, int anmidx, anm_time_t start, anm_time_t dur);
187 /* non-recursive variant, acts on a single node (you probably DON'T want to use this) */
188 void anm_node_transition(struct anm_node *node, int anmidx, anm_time_t start, anm_time_t dur);
191 /* ---- keyframes / PRS interpolation ---- */
193 void anm_set_position(struct anm_node *node, vec3_t pos, anm_time_t tm);
194 vec3_t anm_get_node_position(struct anm_node *node, anm_time_t tm);
196 void anm_set_rotation(struct anm_node *node, quat_t rot, anm_time_t tm);
197 quat_t anm_get_node_rotation(struct anm_node *node, anm_time_t tm);
199 void anm_set_scaling(struct anm_node *node, vec3_t scl, anm_time_t tm);
200 vec3_t anm_get_node_scaling(struct anm_node *node, anm_time_t tm);
202 /* these three return the full p/r/s taking hierarchy into account */
203 vec3_t anm_get_position(struct anm_node *node, anm_time_t tm);
204 quat_t anm_get_rotation(struct anm_node *node, anm_time_t tm);
205 vec3_t anm_get_scaling(struct anm_node *node, anm_time_t tm);
207 /* those return the start and end times of the whole tree */
208 anm_time_t anm_get_start_time(struct anm_node *node);
209 anm_time_t anm_get_end_time(struct anm_node *node);
212 /* ---- transformation matrices ---- */
214 /* these calculate the matrix and inverse matrix of this node alone */
215 void anm_get_node_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
216 void anm_get_node_inv_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
218 /* ---- top-down matrix calculation interface ---- */
220 /* calculate and set the matrix of this node */
221 void anm_eval_node(struct anm_node *node, anm_time_t tm);
222 /* calculate and set the matrix of this node and all its children recursively */
223 void anm_eval(struct anm_node *node, anm_time_t tm);
226 /* ---- bottom-up lazy matrix calculation interface ---- */
228 /* These calculate the matrix and inverse matrix of this node taking hierarchy
229 * into account. The results are cached in thread-specific storage and returned
230 * if there's no change in time or tracks from the last query...
231 */
232 void anm_get_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
233 void anm_get_inv_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
235 #ifdef __cplusplus
236 }
237 #endif
239 #endif /* LIBANIM_H_ */