2.5
[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 typedef struct CfraElem {
39         struct CfraElem *next, *prev;
40         float cfra;
41         int sel;
42 } CfraElem;
43
44 struct Ipo;
45 struct IpoCurve;
46 struct MTex;
47 struct Material;
48 struct Scene;
49 struct Object;
50 struct Sequence;
51 struct ListBase;
52 struct BezTriple;
53 struct ID;
54 struct bPoseChannel;
55 struct bActionChannel;
56 struct rctf;
57
58 /* ------------ Time Management ------------ */
59
60 float frame_to_float(struct Scene *scene, int cfra);
61
62 /* ------------ IPO Management ---------- */
63
64 void free_ipo_curve(struct IpoCurve *icu);
65 void free_ipo(struct Ipo *ipo);
66
67 void ipo_default_v2d_cur(struct Scene *scene, int blocktype, struct rctf *cur);
68
69 struct Ipo *add_ipo(struct Scene *scene, char *name, int idcode);
70 struct Ipo *copy_ipo(struct Ipo *ipo);
71
72 void ipo_idnew(struct Ipo *ipo);
73
74 struct IpoCurve *find_ipocurve(struct Ipo *ipo, int adrcode);
75 short has_ipo_code(struct Ipo *ipo, int code);
76
77 /* -------------- Make Local -------------- */
78
79 void make_local_obipo(struct Ipo *ipo);
80 void make_local_matipo(struct Ipo *ipo);
81 void make_local_keyipo(struct Ipo *ipo);
82 void make_local_ipo(struct Ipo *ipo);
83
84 /* ------------ IPO-Curve Sanity ---------------- */
85
86 void calchandles_ipocurve(struct IpoCurve *icu);
87 void testhandles_ipocurve(struct IpoCurve *icu);
88 void sort_time_ipocurve(struct IpoCurve *icu);
89 int test_time_ipocurve(struct IpoCurve *icu);
90
91 void set_interpolation_ipocurve(struct IpoCurve *icu, short ipo);
92
93 /* -------- IPO-Curve (Bezier) Calculations ---------- */
94
95 void correct_bezpart(float *v1, float *v2, float *v3, float *v4);
96 int findzero(float x, float q0, float q1, float q2, float q3, float *o);
97 void berekeny(float f1, float f2, float f3, float f4, float *o, int b);
98 void berekenx(float *f, float *o, int b);
99
100 /* -------- IPO Curve Calculation and Evaluation --------- */
101
102 float eval_icu(struct IpoCurve *icu, float ipotime);
103 void calc_icu(struct IpoCurve *icu, float ctime);
104 float calc_ipo_time(struct Ipo *ipo, float ctime);
105 void calc_ipo(struct Ipo *ipo, float ctime);
106
107 void calc_ipo_range(struct Ipo *ipo, float *start, float *end);
108
109 /* ------------ Keyframe Column Tools -------------- */
110
111 void add_to_cfra_elem(struct ListBase *lb, struct BezTriple *bezt);
112 void make_cfra_list(struct Ipo *ipo, struct ListBase *elems);
113
114 /* ---------------- IPO DataAPI ----------------- */
115
116 void write_ipo_poin(void *poin, int type, float val);
117 float read_ipo_poin(void *poin, int type);
118
119 void *give_mtex_poin(struct MTex *mtex, int adrcode );
120 void *get_pchan_ipo_poin(struct bPoseChannel *pchan, int adrcode);
121 void *get_ipo_poin(struct ID *id, struct IpoCurve *icu, int *type);
122
123 void set_icu_vars(struct IpoCurve *icu);
124
125 /* ---------------- IPO Execution --------------- */
126
127 void execute_ipo(struct ID *id, struct Ipo *ipo);
128 void execute_action_ipo(struct bActionChannel *achan, struct bPoseChannel *pchan);
129
130 void do_ipo_nocalc(struct Scene *scene, struct Ipo *ipo);
131 void do_ipo(struct Scene *scene, struct Ipo *ipo);
132 void do_mat_ipo(struct Scene *scene, struct Material *ma);
133 void do_ob_ipo(struct Scene *scene, struct Object *ob);
134 void do_seq_ipo(struct Scene *scene, struct Sequence *seq, int cfra);
135 void do_ob_ipodrivers(struct Object *ob, struct Ipo *ipo, float ctime);
136
137 void do_all_data_ipos(struct Scene *scene);
138 short calc_ipo_spec(struct Ipo *ipo, int adrcode, float *ctime);
139 void clear_delta_obipo(struct Ipo *ipo);
140
141 /* ----------- IPO <-> GameEngine API ---------------- */
142
143 /* the short is an IPO_Channel... */
144
145 short IPO_GetChannels(struct Ipo *ipo, short *channels);
146 float IPO_GetFloatValue(struct Ipo *ipo, short c, float ctime);
147
148 #ifdef __cplusplus
149 };
150 #endif
151
152 #endif
153