Merging r38694 through r38739 from trunk into vgroup_modifiers
[blender.git] / source / blender / blenkernel / BKE_key.h
1 /*
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BKE_KEY_H
30 #define BKE_KEY_H
31
32 /** \file BKE_key.h
33  *  \ingroup bke
34  *  \since March 2001
35  *  \author nzc
36  */
37 struct Key;
38 struct KeyBlock;
39 struct ID;
40 struct ListBase;
41 struct Curve;
42 struct Object;
43 struct Scene;
44 struct Lattice;
45 struct Mesh;
46
47 /* Kernel prototypes */
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 void free_key(struct Key *sc); 
53 struct Key *add_key(struct ID *id);
54 struct Key *copy_key(struct Key *key);
55 void make_local_key(struct Key *key);
56 void sort_keys(struct Key *key);
57
58 void key_curve_position_weights(float t, float *data, int type);
59 void key_curve_tangent_weights(float t, float *data, int type);
60 void key_curve_normal_weights(float t, float *data, int type);
61
62 float *do_ob_key(struct Scene *scene, struct Object *ob);
63
64 struct Key *ob_get_key(struct Object *ob);
65 struct KeyBlock *add_keyblock(struct Key *key, const char *name);
66 struct KeyBlock *ob_get_keyblock(struct Object *ob);
67 struct KeyBlock *ob_get_reference_keyblock(struct Object *ob);
68 struct KeyBlock *key_get_keyblock(struct Key *key, int index);
69 struct KeyBlock *key_get_named_keyblock(struct Key *key, const char name[]);
70 char *key_get_curValue_rnaPath(struct Key *key, struct KeyBlock *kb);
71 // needed for the GE
72 void do_rel_key(const int start, int end, const int tot, char *basispoin, struct Key *key, struct KeyBlock *actkb, const int mode);
73
74 /* conversion functions */
75 void key_to_mesh(struct KeyBlock *kb, struct Mesh *me);
76 void mesh_to_key(struct Mesh *me, struct KeyBlock *kb);
77 void key_to_latt(struct KeyBlock *kb, struct Lattice *lt);
78 void latt_to_key(struct Lattice *lt, struct KeyBlock *kb);
79 void key_to_curve(struct KeyBlock *kb, struct Curve  *cu, struct ListBase *nurb);
80 void curve_to_key(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
81 float (*key_to_vertcos(struct Object *ob, struct KeyBlock *kb))[3];
82 void vertcos_to_key(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
83 void offset_to_key(struct Object *ob, struct KeyBlock *kb, float (*ofs)[3]);
84
85 /* key.c */
86 extern int slurph_opt;
87
88 #ifdef __cplusplus
89 };
90 #endif
91
92 #endif // BKE_KEY_H