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