libanim

view src/anim.h @ 20:3c2428cb38f7

find changesets by author, revision, files, or words in the commit message
added the option of lightweight pre-pass top-down recursive calculation of matrices instead of going through the existing lazy thread-specific caching algorithm.
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 09 Dec 2013 04:06:30 +0200
parents 2cf7284d2bbb
children 5993f405a1cb
line source
1 #ifndef LIBANIM_H_
2 #define LIBANIM_H_
3
4 #include "config.h"
5
6 #include <pthread.h>
7
8 #include <vmath/vector.h>
9 #include <vmath/quat.h>
10 #include <vmath/matrix.h>
11 #include "track.h"
12
13 enum {
14 ANM_TRACK_POS_X,
15 ANM_TRACK_POS_Y,
16 ANM_TRACK_POS_Z,
17
18 ANM_TRACK_ROT_X,
19 ANM_TRACK_ROT_Y,
20 ANM_TRACK_ROT_Z,
21 ANM_TRACK_ROT_W,
22
23 ANM_TRACK_SCL_X,
24 ANM_TRACK_SCL_Y,
25 ANM_TRACK_SCL_Z,
26
27 ANM_NUM_TRACKS
28 };
29
30 struct anm_node {
31 char *name;
32
33 struct anm_track tracks[ANM_NUM_TRACKS];
34 vec3_t pivot;
35
36 /* matrix cache */
37 struct mat_cache {
38 mat4_t matrix, inv_matrix;
39 anm_time_t time, inv_time;
40 struct mat_cache *next;
41 } *cache_list;
42 pthread_key_t cache_key;
43 pthread_mutex_t cache_list_lock;
44
45 /* matrix calculated by anm_eval functions (no locking, meant as a pre-pass) */
46 mat4_t matrix;
47
48 struct anm_node *parent;
49 struct anm_node *child;
50 struct anm_node *next;
51 };
52
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 /* node constructor and destructor */
58 int anm_init_node(struct anm_node *node);
59 void anm_destroy_node(struct anm_node *node);
60
61 /* recursively destroy an animation node tree */
62 void anm_destroy_node_tree(struct anm_node *tree);
63
64 /* helper functions to allocate/construct and destroy/free with
65 * a single call. They call anm_init_node and anm_destroy_node
66 * internally.
67 */
68 struct anm_node *anm_create_node(void);
69 void anm_free_node(struct anm_node *node);
70
71 /* recursively destroy and free the nodes of a node tree */
72 void anm_free_node_tree(struct anm_node *tree);
73
74 int anm_set_node_name(struct anm_node *node, const char *name);
75 const char *anm_get_node_name(struct anm_node *node);
76
77 void anm_set_interpolator(struct anm_node *node, enum anm_interpolator in);
78 void anm_set_extrapolator(struct anm_node *node, enum anm_extrapolator ex);
79
80 /* link and unlink nodes with parent/child relations */
81 void anm_link_node(struct anm_node *parent, struct anm_node *child);
82 int anm_unlink_node(struct anm_node *parent, struct anm_node *child);
83
84 void anm_set_position(struct anm_node *node, vec3_t pos, anm_time_t tm);
85 vec3_t anm_get_node_position(struct anm_node *node, anm_time_t tm);
86
87 void anm_set_rotation(struct anm_node *node, quat_t rot, anm_time_t tm);
88 quat_t anm_get_node_rotation(struct anm_node *node, anm_time_t tm);
89
90 void anm_set_scaling(struct anm_node *node, vec3_t scl, anm_time_t tm);
91 vec3_t anm_get_node_scaling(struct anm_node *node, anm_time_t tm);
92
93 /* these three return the full p/r/s taking hierarchy into account */
94 vec3_t anm_get_position(struct anm_node *node, anm_time_t tm);
95 quat_t anm_get_rotation(struct anm_node *node, anm_time_t tm);
96 vec3_t anm_get_scaling(struct anm_node *node, anm_time_t tm);
97
98 void anm_set_pivot(struct anm_node *node, vec3_t pivot);
99 vec3_t anm_get_pivot(struct anm_node *node);
100
101 /* those return the start and end times of the whole tree */
102 anm_time_t anm_get_start_time(struct anm_node *node);
103 anm_time_t anm_get_end_time(struct anm_node *node);
104
105 /* these calculate the matrix and inverse matrix of this node alone */
106 void anm_get_node_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
107 void anm_get_node_inv_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
108
109 /* ---- top-down matrix calculation interface ---- */
110
111 /* calculate and set the matrix of this node */
112 void anm_eval_node(struct anm_node *node, anm_time_t tm);
113 /* calculate and set the matrix of this node and all its children recursively */
114 void anm_eval(struct anm_node *node, anm_time_t tm);
115
116
117 /* ---- bottom-up lazy matrix calculation interface ---- */
118
119 /* These calculate the matrix and inverse matrix of this node taking hierarchy
120 * into account. The results are cached in thread-specific storage and returned
121 * if there's no change in time or tracks from the last query...
122 */
123 void anm_get_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
124 void anm_get_inv_matrix(struct anm_node *node, mat4_t mat, anm_time_t tm);
125
126 #ifdef __cplusplus
127 }
128 #endif
129
130 #endif /* LIBANIM_H_ */