destruction of previous slot api. if it returns, it'll
[blender.git] / source / blender / blenkernel / BKE_ipo.h
1 /**
2  * blenlib/BKE_ipo.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): 2008, Joshua Leung (Animation Cleanup)
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef BKE_IPO_H
32 #define BKE_IPO_H
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38         
39 /* -------- IPO-Curve (Bezier) Calculations ---------- */
40
41 // xxx perhaps this should be in curve api not in anim api
42 void correct_bezpart(float *v1, float *v2, float *v3, float *v4);
43         
44
45 // XXX this file will soon be depreceated...
46 #if 0 // XXX old animation system
47
48 typedef struct CfraElem {
49         struct CfraElem *next, *prev;
50         float cfra;
51         int sel;
52 } CfraElem;
53
54 struct Ipo;
55 struct IpoCurve;
56 struct MTex;
57 struct Material;
58 struct Scene;
59 struct Object;
60 struct Sequence;
61 struct ListBase;
62 struct BezTriple;
63 struct ID;
64 struct bPoseChannel;
65 struct bActionChannel;
66 struct rctf;
67
68 /* ------------ Time Management ------------ */
69
70 float frame_to_float(struct Scene *scene, int cfra);
71
72 /* ------------ IPO Management ---------- */
73
74 void free_ipo_curve(struct IpoCurve *icu);
75 void free_ipo(struct Ipo *ipo);
76
77 void ipo_default_v2d_cur(struct Scene *scene, int blocktype, struct rctf *cur);
78
79 struct Ipo *add_ipo(struct Scene *scene, char *name, int idcode);
80 struct Ipo *copy_ipo(struct Ipo *ipo);
81
82 void ipo_idnew(struct Ipo *ipo);
83
84 struct IpoCurve *find_ipocurve(struct Ipo *ipo, int adrcode);
85 short has_ipo_code(struct Ipo *ipo, int code);
86
87 /* -------------- Make Local -------------- */
88
89 void make_local_obipo(struct Ipo *ipo);
90 void make_local_matipo(struct Ipo *ipo);
91 void make_local_keyipo(struct Ipo *ipo);
92 void make_local_ipo(struct Ipo *ipo);
93
94 /* ------------ IPO-Curve Sanity ---------------- */
95
96 void calchandles_ipocurve(struct IpoCurve *icu);
97 void testhandles_ipocurve(struct IpoCurve *icu);
98 void sort_time_ipocurve(struct IpoCurve *icu);
99 int test_time_ipocurve(struct IpoCurve *icu);
100
101 void set_interpolation_ipocurve(struct IpoCurve *icu, short ipo);
102
103 /* -------- IPO-Curve (Bezier) Calculations ---------- */
104
105 void correct_bezpart(float *v1, float *v2, float *v3, float *v4);
106 int findzero(float x, float q0, float q1, float q2, float q3, float *o);
107 void berekeny(float f1, float f2, float f3, float f4, float *o, int b);
108 void berekenx(float *f, float *o, int b);
109
110 /* -------- IPO Curve Calculation and Evaluation --------- */
111
112 float eval_icu(struct IpoCurve *icu, float ipotime);
113 void calc_icu(struct IpoCurve *icu, float ctime);
114 float calc_ipo_time(struct Ipo *ipo, float ctime);
115 void calc_ipo(struct Ipo *ipo, float ctime);
116
117 void calc_ipo_range(struct Ipo *ipo, float *start, float *end);
118
119 /* ------------ Keyframe Column Tools -------------- */
120
121 void add_to_cfra_elem(struct ListBase *lb, struct BezTriple *bezt);
122 void make_cfra_list(struct Ipo *ipo, struct ListBase *elems);
123
124 /* ---------------- IPO DataAPI ----------------- */
125
126 void write_ipo_poin(void *poin, int type, float val);
127 float read_ipo_poin(void *poin, int type);
128
129 void *give_mtex_poin(struct MTex *mtex, int adrcode );
130 void *get_pchan_ipo_poin(struct bPoseChannel *pchan, int adrcode);
131 void *get_ipo_poin(struct ID *id, struct IpoCurve *icu, int *type);
132
133 void set_icu_vars(struct IpoCurve *icu);
134
135 /* ---------------- IPO Execution --------------- */
136
137 void execute_ipo(struct ID *id, struct Ipo *ipo);
138 void execute_action_ipo(struct bActionChannel *achan, struct bPoseChannel *pchan);
139
140 void do_ipo_nocalc(struct Scene *scene, struct Ipo *ipo);
141 void do_ipo(struct Scene *scene, struct Ipo *ipo);
142 void do_mat_ipo(struct Scene *scene, struct Material *ma);
143 void do_ob_ipo(struct Scene *scene, struct Object *ob);
144 void do_seq_ipo(struct Scene *scene, struct Sequence *seq, int cfra);
145 void do_ob_ipodrivers(struct Object *ob, struct Ipo *ipo, float ctime);
146
147 void do_all_data_ipos(struct Scene *scene);
148 short calc_ipo_spec(struct Ipo *ipo, int adrcode, float *ctime);
149 void clear_delta_obipo(struct Ipo *ipo);
150
151 /* ----------- IPO <-> GameEngine API ---------------- */
152
153 /* the short is an IPO_Channel... */
154
155 short IPO_GetChannels(struct Ipo *ipo, short *channels);
156 float IPO_GetFloatValue(struct Ipo *ipo, short c, float ctime);
157
158 #endif // XXX old animation system
159
160 #ifdef __cplusplus
161 };
162 #endif
163
164 #endif
165