- add in asserts for unlikely cases of invalid ID types being assigned to key->from.
[blender.git] / source / blender / blenkernel / BKE_key.h
1 /**
2  * blenlib/BKE_key.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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_KEY_H
32 #define BKE_KEY_H
33
34 struct Key;
35 struct KeyBlock;
36 struct ID;
37 struct ListBase;
38 struct Curve;
39 struct Object;
40 struct Scene;
41 struct Lattice;
42 struct Mesh;
43
44 /* Kernel prototypes */
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 void free_key(struct Key *sc); 
50 struct Key *add_key(struct ID *id);
51 struct Key *copy_key(struct Key *key);
52 void make_local_key(struct Key *key);
53 void sort_keys(struct Key *key);
54
55 void key_curve_position_weights(float t, float *data, int type);
56 void key_curve_tangent_weights(float t, float *data, int type);
57 void key_curve_normal_weights(float t, float *data, int type);
58
59 float *do_ob_key(struct Scene *scene, struct Object *ob);
60
61 struct Key *ob_get_key(struct Object *ob);
62 struct KeyBlock *add_keyblock(struct Key *key, const char *name);
63 struct KeyBlock *ob_get_keyblock(struct Object *ob);
64 struct KeyBlock *ob_get_reference_keyblock(struct Object *ob);
65 struct KeyBlock *key_get_keyblock(struct Key *key, int index);
66 struct KeyBlock *key_get_named_keyblock(struct Key *key, const char name[]);
67 char *key_get_curValue_rnaPath(struct Key *key, struct KeyBlock *kb);
68 // needed for the GE
69 void do_rel_key(int start, int end, const int tot, char *basispoin, struct Key *key, struct KeyBlock *actkb, const int mode);
70
71 /* conversion functions */
72 void key_to_mesh(struct KeyBlock *kb, struct Mesh *me);
73 void mesh_to_key(struct Mesh *me, struct KeyBlock *kb);
74 void key_to_latt(struct KeyBlock *kb, struct Lattice *lt);
75 void latt_to_key(struct Lattice *lt, struct KeyBlock *kb);
76 void key_to_curve(struct KeyBlock *kb, struct Curve  *cu, struct ListBase *nurb);
77 void curve_to_key(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
78 float (*key_to_vertcos(struct Object *ob, struct KeyBlock *kb))[3];
79 void vertcos_to_key(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
80 void offset_to_key(struct Object *ob, struct KeyBlock *kb, float (*ofs)[3]);
81
82 #ifdef __cplusplus
83 };
84 #endif
85
86 #endif
87